Addtrustee, T.addtrustee – Kofax DM API User Manual

Page 167

Advertising
background image

DM API M

ETHODS

AND

P

ROPERTIES

147

AddTrustee

AddTrustee

Use this method to add a trustee to the trustee list. If there is already a
trustee in the list that matches the trustee name and flags, the rights for
the existing entry will be updated rather than a new entry added.

Syntax

PCDTrusteeList.AddTrustee( 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 section titled

Getting and Updating Trustee Information

in

Chapter 1 illustrates the use of the AddTrustee method.

Related Items

See the

PCDTrusteeList

object.

See the following methods:

strTrusteeName

The (

BSTR) input string with the name of the

trustee.

intTrusteeFlags

Input integer with the trustee flags. Supported
values are as follows:

PCD_TRUSTEE_UNKNOWN_TYPE = 0

PCD_TRUSTEE_GROUP_TYPE = 1

PCD_TRUSTEE_PERSON_TYPE = 2

intTrusteeRights

Input integer with the trustee rights. These
values are taken from the

ACCESSRIGHTS

column in the

SECURITY table of the SQL

database.

Advertising