Form_default_primary, Form_default_primary 361, Syntax – Kofax DM API User Manual

Page 381: Parameters usage, Example

Advertising
background image

DM API T

OKENS

361

%FORM_DEFAULT_PRIMARY

%FORM_DEFAULT_PRIMARY

Use this token to identify the default profile form.

Syntax

PCDPropertyList.GetPropertyValue( _

“%FORM_DEFAULT_PRIMARY”)

Parameters

Usage

Returns “Y” if the form in the current return properties data set is the
default profile form. Otherwise, “N” is returned.

Example

'Create a doc object and a property list object.

Dim pDocObject As PCDClient.PCDDocObject

Dim pFormProperties As PCDClient.PCDPropertyList


'Set the DM security token.

pDocObject.SetDST(strDST)


'Check for errors.

checkError(pDocObject,"ERROR_CREATESEARCH")


'Set the object type.

pDocObject.SetObjectType("DocsFormsList")


'Set the destination library.

pDocObject.SetProperty("%TARGET_LIBRARY", library)


'Set the search type.

pDocObject.SetProperty("%FORM_LIST_TYPE", "%HITLIST")


'Get the results.

pDocObject.Fetch()


'Check for errors.

checkError(pDocObject, "ERROR_SEARCH")

%FORM_DEFAULT_PRIMARY The token identifier that indicates the

default profile form is to be returned.

Advertising