Pcdgetdoc, Pcdgetdoc 51 – Kofax DM API User Manual
Page 71
DM API O
BJECTS
51
PCDGetDoc
PCDGetDoc
This object is used to manage the retrieval of a set of physical files that
comprise the components of one version of a document. You use this
object just as you would the
PCDGetDoc.
to specify the criteria that identify
which document and version you want. Normally, this would mean
specifying criteria like
"%DOCUMENT_NUMBER" "79",
"%VERSION_ID" "3"
. The provided criteria must resolve to exactly
one version of one document.
Syntax
PCDGetDoc.
methodOrProperty
Returns
PCDGetDoc returns data stored in the
COMPONENTS
table, including
the document number, version ID, size of the file, and the name of the
file.
Usage
The following steps show the general usage sequence for the
PCDGetDoc object:
1 Specify the library where the document is stored.
2 Provide a DST.
3 Set search criteria that will precisely identify the item you wish to
retrieve.
4 Call PCDGetDoc.
method to retrieve the document.
5 Iterate through them using PCDGetDoc.
PCDGetDoc.
to get to a specific item.
6 Call PCDGetDoc.
to retrieve the file content by
referencing the
"%CONTENT"
token. This will return a pointer to a
Dispatch interface (a
object) that you can then
use to read the physical file.