Order_by, Syntax, Parameters example – Kofax DM API User Manual

Page 433: Related items

Advertising
background image

DM API T

OKENS

413

%ORDER_BY

%ORDER_BY

This token is used to specify the field on the form that controls the sort
order.

Syntax

PCDPropertyLists.SetProperty(“%ORDER_BY”, _

strDisplayName)

Parameters

Example

'Create a property lists object.

PropLists = CreateObject("PCDClient.PCDPropertyLists")


'Set the DM security token.

PropLists.SetDST(strDST)


'Set the object type.

PropLists.SetObjectType("RootObjectsCollection")


'Set the target library.

PropLists.SetProperty("%TARGET_LIBRARY", library)


'Set the order.

PropLists.SetProperty("%ORDER_BY","DISPLAYNAME")


'Retrieve the property list.

PropLists.Execute()

Related Items

See the PCDPropertyLists object.

See the SetProperty method.

%ORDER_BY

The token identifier that this command
statement idenfifies the field on the form
that controls the sort order.

strDisplayName

The name of the field as shown on the
form, either as a string variable or
enclosed within double quote marks.

Advertising