Setdst, Using the, Ec.setdst – Kofax DM API User Manual

Page 283: T.setdst, Setdst ds, Oc.setdst ds, C.setdst bs, Setdst b, C.setdst ds, C.setdst

Advertising
background image

DM API M

ETHODS

AND

P

ROPERTIES

263

SetDST

SetDST

Use this method to set the document security token (DST) that will be
used in processing the search request or manipulating document
objects.

Syntax

PCDDocObject.SetDST( strDST )

PCDGetDoc.SetDST( strDST )

PCDGetForm.SetDST( strDST )

PCDLogin.SetDST( strDST )

PCDLookup.SetDST( strDST )

PCDNetworkInfo.SetDST( strDST )

PCDPropertyLists.SetDST( strDST )

PCDPutDoc.SetDST( strDST )

PCDRecentDoc.SetDST( strDST )

PCDSearch.SetDST( strDST )

PCDSQL.SetDST( strDST )

Parameter

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.

Usage

The

GetDST

method that is called by the

PCDLogin

object provides the

DST that you use during your entire user session. By using the SetDST
method as part of each document or database retrieval, you allow the
DM library to authenticate who you are and what access privileges have

strDST

A string that contains the security token.

Advertising