Settrustee, Settrustee 28, Oc.settrustee – Kofax DM API User Manual

Page 308

Advertising
background image

288 C

HAPTER

4

SetTrustee

SetTrustee

Use this method to set a trustee value in a trustee list. If the trustee
name and flags match an existing entry in the list, its rights will be
updated. If it does not match an existing entry, the entry will be added.

Syntax

PCDDocObject.SetTrustee( strTrusteeName, _

intTrusteeFlags, _

intTrusteeRights )

Parameters

Returns

Returns an

HRESULT

to receive the result of the call.

S_OK

indicates

success. Languages such as JavaScript, Visual Basic, and VBScript
return this as a function value.

Example

The

Example

in the discussion of

FetchTrustees

shows how you can use

the SetTrustee method.

Related Items

See the

PCDDocObject

object.

See the following methods:

GetTrustee
GetTrustees

strTrusteeName

A string (

BSTR) variable that identifies the

name of the trustee.

intTrusteeFlags

An integer variable that sets the trustee flags.
Supported values are as follows:

PCD_TRUSTEE_UNKNOWN_TYPE = 0

PCD_TRUSTEE_GROUP_TYPE = 1

PCD_TRUSTEE_PERSON_TYPE = 2

intTrusteeRights

An integer variable that identifies the rights
that are to be assigned to the trustee.

Advertising