Kofax DM API - Manual (Page 103)

DM API O BJECTS 83
PCDPropertyList
PCDPropertyList
PCDPropertyList is a Messenger object that allows you to store and
manipulate a collection of property name/value pairs.
PCDPropertyList uses a zero-based index. Loading different name/
value pairs into this object provides a mechanism for your custom
applications to send descriptive information from the client interface to
the server interface.
One example of the use of these properties occurs within the
PCDNetworkInfo object. Many of the methods in PCDNetworkInfo
set properties in the PCDPropertyList data member and then call a
protected Execute method, which calls back to the server. The property
list is broken out in the call to the server, into an integer value giving the
size of the array, an array of string variables (
BSTRs ) representing the
property names, and an array of Variants containing the values of these
properties. PCDPropertyList methods contain elements that specify
which methods the server should call, as well as the parameters for
those methods.
Since the PCDPropertyList object is primarily used as a utility by the
other objects that comprise the DM API, this object should not be
implemented directly. Instead, it should be used as a tool that allows
you to modify other objects that are supported within the DM API.
Syntax
PCDPropertyList. methodOrProperty
Usage
Since the PCDPropertyList object is used to pass information between
the client and server, direct calls to these methods provide you the
ability to share unique information required by your custom
application. However, any unique properties you create as part of your
application will only work properly if they are correctly received and
interpreted in both the client interface and the server interface. If you
add or modify a client-side property, you must make appropriate
modifications in your server-side application, or changes that you
make will have no effect.