Kofax DM API - Manual (Page 374)

354 C HAPTER 5
%ENCAPSULATION_TYPE
%ENCAPSULATION_TYPE
When users indicate that they want to view documents, those
documents must be transferred from the server as data streams. There
are 3 stream types:
• HTML streams, where documents are converted HTML streams,
• Native streams, where the MIME type of the transferred
documents is used to control their display, and
• RIFF streams, where the DM viewer is used to display documents.
The %ENCAPSULATION_TYPE token is used to convert documents into
RIFF streams.
Syntax
PCDGetDoc.AddSearchCriteria( _
“%ENCAPSULATION_TYPE”, “RIFF”)
Parameters
Usage
At the present time, “RIFF” is the only value that
%ENCAPSULATION_TYPE supports.
Example
'Create the PCDGetDoc object.
pGetDoc = CreateObject("PCDClient.PCDGetDoc.1")
'Check for errors.
checkError(pGetDoc, "ERROR_CREATESEARCH")
'Set the DM security token.
pGetDoc.SetDST(strDST)
%ENCAPSULATION_TYPE The token identifier that indicates that
the encapsulation type is being set.
RIFF The keyword that indicates that the
encapsulation type is being set to
“RIFF”.