TCapture Class Reference

This object is the root of the PP-Capture API. More...

List of all members.

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.

---

Detailed Description

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.

---

Member Function Documentation

TCapture::Connect	(	const WideString	LicenseServer,
		TDatabaseType	DatabaseType,
		const WideString	OdbcName,
		const WideString	UserName,
		const WideString	Password
	)

Connects to the PP-Capture database.

Parameters:

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: dtAccess (0) - Microsoft Access MDB format dtMSSQLServer (1) - Microsoft SQL Server 2005 and higher, including SQL Server Express. dtMySQL (2) - MySQL 4.1 or higher with an InnoDB database.
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.

Note:

Backward compatibility means that a 1.1-aware application will be able to use data provided by a 1.0-aware application, but not the other way around. For example, PlanetPress Workflow 7.3 will see the inks of a PGC processed by PlanetPress Workflow 7.2, but using PlanetPress Workflow 7.2 to output the inks from a PGC processed by PlanetPress Workflow 7.3 will yield an empty page.

Returns:

Version of the Capture database.

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.

Parameters:

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.

Returns:

A MetaFile object containing the list of documents that were updated by the PGC. The metadata contains the new status of each document.

Exceptions:

EOleException

An error occurrend while processing the PGC. Any change to the database is discarded and the return value is nil.

---

Member Data Documentation

IDocumentStore TCapture::DocumentStore

Returns a new instance of the Document Store.

See also:

TDocumentStore

IPdfStore TCapture::PdfStore

Returns a new instance of the PDF Store.

See also:

TPdfStore

IPenStore TCapture::PenStore

Returns a new instance of the Pen Store.

See also:

TPenStore