PCREEngine

[ROOT] --> C++Client

class PCREEngine
extends virtual PCRESynchronized as public

The PCREEngineclass encapsulates the interaction with the crystal engine.

Author:: Copyright (C) 1997 MAS, All Rights Reserved.

Version:: 2.4.0

Source:: MobileApps\PCRE\CppClient\Include\pcreengine.h

Friends:

friend class PCREServer ;
friend class PCREJob ;

CanClose: Query the print engine to see if it is closeable.
Close: Close the print engine.
getClient: Return the print-engine client.
GetErrorCode: Issue a PEGetErrorCode call.
GetErrorText: Issue a PEGetErrorStr call.
GetHandleString: Issue a PEGetHandleString call.
getStatus: Check on the status of the engine.
GetVersion: Get the version of this report engine.
LogoffServer: Log off a database server.
LogonServer: Log on to a database server.
Open: Open a new print engine.
OpenJob: Open a report using this engine.
OpenSubreport: Open a subreport within a job's current report.
ParallelPrintReport: Parallel Print a given report
PrintReport: Print a given report.

EngineStatus

 enum EngineStatus { engineClosed = 0 ,
                           engineOpened = 1 ,
                           serverDisconnected = 2 } ;

getClient

 PCREClient * getClient ( ) ;

Return the print-engine client.

Return:: The client.

getStatus

 EngineStatus getStatus ( ) ;

Check on the status of the engine.

Return:: The current status code.

Open

 BOOL Open ( ) ;

Open a new print engine.

Return:: A boolean indicating whether the engine was opened successfully.

Close

 void Close ( ) ;

Close the print engine.

CanClose

 BOOL CanClose ( ) ;

Query the print engine to see if it is closeable.

Return:: A boolean indicating whether the engine can be closed.

GetVersion

 short GetVersion ( int versionRequested ) ;

Get the version of this report engine.

Return:: The report engine version number.

OpenJob

 PCREJob * OpenJob ( const char * reportFileName ) ;

Open a report using this engine.

Parameters:

reportFileName

The path and filename of the report file to open.

Return:: The new job, which is associated with the given report.

OpenSubreport

 PCREJob * OpenSubreport ( PCREJob * parentJob ,
                                 const char * subreportName ) ;

Open a subreport within a job's current report.

Parameters:

parentJob	The job associated with the report containing the subreport.
subreportName	The name of the subreport within parentJob's report.

Return:: The new job, associated with the given subreport.

PrintReport

 void PrintReport ( const char * reportFileName ) ;

Print a given report.

Parameters:

reportFile

The path and filename of the report file which is to be printed.

LogonServer

 BOOL LogonServer ( const char * dllName ,
                          PELogOnInfo * info ) ;

Log on to a database server.

Parameters:

dllName	The DLL to use for the data source which you wish to log on to.
info	The login information to use.

LogoffServer

 BOOL LogoffServer ( const char * dllName ,
                           PELogOnInfo * info ) ;

Log off a database server.

Parameters:

dllName	The DLL to use for the data source which you wish to log off.
info	The login information to use for logging off the database.

Return:: A boolean indicating whether the logoff succeeded.

ParallelPrintReport

 void ParallelPrintReport ( const char * reportFileName ,
                                  unsigned printers ,
                                  unsigned mode ,
                                  const char * password ,
                                  const char * outFileName ) ;

Parallel Print a given report

Parameters:

reportFilePath	The path and filename of the report file which is to be printed.
printers	the number of parallel print processes; if given as zero the number of processors on the server is used.
mode	Set to 1 for parallel Pass2.
password	The database logon password; the rest of the logon information will be in the report; if given as null, no logon will be done.
outFilePath	The output file name; if given as null, the output file is .ps where reportFilePath is .rpt.

GetErrorCode

 short GetErrorCode ( ) ;

Issue a PEGetErrorCode call.

Return:: The error code, or 0 on error.

GetErrorText

 const char * GetErrorText ( ) ;

Issue a PEGetErrorStr call.

Return:: The error string, or an empty string on error ( not null ).

GetHandleString

 BOOL GetHandleString ( HANDLE textHandle ,
                              short textLength ,
                              char * & textBuffer ) ;

Issue a PEGetHandleString call.