Execute, Bs.execute, Method – Kofax DM API User Manual

Page 187: Ec.execute, T.execute, Oc.execute, Method is c

Advertising
background image

DM API M

ETHODS

AND

P

ROPERTIES

167

Execute

Execute

The Execute method is supported for use in many API objects. After
you set any necessary criteria or other values (for example, logon
information or a search form), use this method to execute the request
on the DM Server.

Syntax

PCDASPFileUpload.Execute()

PCDGetDoc.Execute()

PCDGetLoginLibs.Execute()

PCDLogin.Execute()

PCDLookup.Execute()

PCDPropertyLists.Execute()

PCDPutDoc.Execute()

PCDRecentDoc.Execute()

PCDSearch.Execute()

PCDSQL.Execute( strSQLStatement )

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.

strSQLStatement

A valid SQL statement that is correctly
formatted to run against the current DM library.
The syntax used must conform to the
requirements of your SQL software.

This parameter is only supported within the

PCDSQL

object. The

Execute method takes

no parameters when used with the other DM
API objects that support it.

Advertising