beautypg.com

Ft_format, Ft_format 375 – Kofax DM API User Manual

Page 395

background image

DM API T

OKENS

375

%FT_FORMAT

%FT_FORMAT

This token is used when a full text search is performed. This token
specifies the document format. It is required by DM Viewer so search
documents can be rendered properly.

Syntax

PCDSearch.AddReturnProperty(“%FT_FORMAT”)

Parameters

Example

'Create a search object.

Set pClient = CreateObject("PCDClient.PCDSearch.1")


'Document format identifier used by DM Viewer.

pClient.AddReturnProperty("%FT_FORMAT")


'Execute the search.

pClient.Execute()


'Create a variable to hold the retrieved search value.

Dim vValue As Variant


'Retrieve the data.

vValue = pClient.GetPropertyValue(“%FT_FORMAT”)


'Process the data.

Related Items

See the

PCDSearch

object.

See the

AddReturnProperty

method.

See the following tokens:

%FT_CONFIDENCE

%FT_MARKER_LIST

%FT_FORMAT

A token that specifies the document
format so that the DM Viewer can render
it properly.