PlanetPress Capture Library
|
This object is the root of the PP-Capture API. More...
Public Member Functions | |
IMetaFile | ProcessPGC (const WideString PatternSequence, const WideString PgcFileName, const WideString PgcOriginalFileName) |
Takes a PGC file and adds it to the database. | |
Connect (const WideString LicenseServer, TDatabaseType DatabaseType, const WideString OdbcName, const WideString UserName, const WideString Password) | |
Connects to the PP-Capture database. | |
TVersion | GetVersion () |
Returns the version of the database, in x.y format where x is the major version number and y is the minor version number. | |
Public Attributes | |
IPdfStore | PdfStore |
Returns a new instance of the PDF Store. | |
IPenStore | PenStore |
Returns a new instance of the Pen Store. | |
IDocumentStore | DocumentStore |
Returns a new instance of the Document Store. |
This object is the root of the PP-Capture API.
It publishes the various data stores that allows the workflow of pattern-enabled documents. Instances of this object can be created using the CaptureLib.Capture
ProgID.
TCapture::Connect | ( | const WideString | LicenseServer, |
TDatabaseType | DatabaseType, | ||
const WideString | OdbcName, | ||
const WideString | UserName, | ||
const WideString | Password | ||
) |
Connects to the PP-Capture database.
LicenseServer | IP address or host name of the License Server. If LicenseServer is an empty or NULL string, the method uses the same parameters as PlanetPress Workflow and the other arguments are ignored. |
DatabaseType | Which database engine is used. Supported values are:
|
OdbcName | The name of the connection in the ODBC connection repository. |
UserName | Name of the user to connect to the database with. |
Password | Password to use to connect to the database. |
TVersion TCapture::GetVersion | ( | ) |
Returns the version of the database, in x.y
format where x
is the major version number and y
is the minor version number.
The current version is 1.1
. A change in the major number indicates an incompatible change in the database layout while a change in the minor number indicates an updated but backward-compatible database layout.
IMetaFile TCapture::ProcessPGC | ( | const WideString | PatternSequence, |
const WideString | PgcFileName, | ||
const WideString | PgcOriginalFileName | ||
) |
Takes a PGC file and adds it to the database.
A PGC can contain inks from several patterns (and therefore several documents) but from one and only one pen. The PGC is first separated in pieces where each piece contains all the pages for a single pattern. For each piece, the corresponding page entry is found in the database using the specified pattern sequence as well as the unique address of the pattern. The PGC piece is then added to the database and linked to that page.
PatternSequence | Optional name of the pattern sequence in which the PGC is a part. A PGC may only belong to one sequence. |
PgcFileName | Complete path and file name of the PGC file to process. |
PgcOriginalFileName | Optional name of the PGC file. This is the original name that the file had before it was captured by PP-Workflow. This value allows to search documents based on the PGC file name. |
EOleException | An error occurrend while processing the PGC. Any change to the database is discarded and the return value is nil. |
IDocumentStore TCapture::DocumentStore |
Returns a new instance of the Document Store.
IPdfStore TCapture::PdfStore |
Returns a new instance of the PDF Store.
IPenStore TCapture::PenStore |
Returns a new instance of the Pen Store.