beautypg.com

Gettrusteeindex – Kofax DM API User Manual

Page 247

background image

DM API M

ETHODS

AND

P

ROPERTIES

227

GetTrusteeIndex

GetTrusteeIndex

Use this method to locate the index location of a trustee in a list of
trustees.

Syntax

PCDTrusteeList.GetTrusteeIndex( strTrusteeName,
_

intTrusteeFlags
)

Parameters

Returns

Returns an unsigned long integer that contains the offset in the list of
trustees. JavaScript, Visual Basic, and VBScript return this as a function
value. If the entry cannot be found, it returns a

PCD_ERR_NAME_NOT_FOUND

error condition.

Related Items

See the

PCDTrusteeList

object.

See the following methods:

GetSize
GetTrusteeRights
SetTrusteeRights

See the following properties:

strTrusteeName

String (

BSTR) that identifies the name of the

trustee.

intTrusteeFlags

A long integer that identifies the flag setting for
the trustee. Supported values are as follows:

PCD_TRUSTEE_UNKNOWN_TYPE = 0

PCD_TRUSTEE_GROUP_TYPE = 1

PCD_TRUSTEE_PERSON_TYPE = 2