[ROOT] --> C++Client
friend class PCREEngine ; | |
friend class PCRECustomServer ; | |
friend class PCREClient ; | |
friend class PCREAppClient ; | |
friend class PCREGateway ; |
addArgument
Connect
Disconnect
EndService
getAPI
getArguments
getCommandArgStr
getExecutable
getExecutableStr
GetFolder
getHost
getName
getService
GetVersion
OpenEngine
setArguments
setExecutable
SetFolder
setHost
setName
SetOption
StartService
const char * getName ( ) ;
Retrieve the name of the server, this defaults to a psuedo-random number, unless it has been explicitly set.
void setName ( const char * name ) ;
Set the name of the server, this defaults to a psuedo-random number, unless it has been explicitly set.
| name | The name of the server. |
const char * getHost ( ) ;
Retrieve the hostname on which the server is running.
void setHost ( const char * address ) ;
Set the hostname on which the server is to run.
| address | The host the server is to be used on. |
const char * getService ( ) ;
Retrieve the name of this service
const char * getArguments ( ) ;
Retrieve arguments passed to the server
void setArguments ( const char * argstr ) ;
Set the arguments that will be passed to the server.
| argstr | The arguments that will be used when the server is started. |
void addArgument ( const char * argstr ) ;
Modify the arguments that will be passed to the server.
| argstr | An extra argument that should be added to any existing arguments. |
const char * getExecutable ( ) ;
Retrieve the filename of the server.
void setExecutable ( const char * exestr ) ;
Set an alternate server filename.
| exestr | The full filename, including path, of the server to use |
const char * GetFolder ( ) ;
Retrieve the server's current working folder (directory)
void SetFolder ( const char * folder ) ;
Set the server's current working folder (directory), this can be used to simply opening reports. If a report is opened with just the filename Name.rpt it will be loaded from the current working directory of the server.
| folder | The directory to use for the server's current working directory. |
const PCREString getExecutableStr ( ) ;
Retrieve the filename of the server.
const PCREString getCommandArgStr ( ) ;
Retrieve arguments passed to the server
const PCREAPIServer_ptr getAPI ( ) ;
Retrieve the API
void Connect ( ) ;
Connect this server to the host that was specified, using the supplied arguments, if any.
void Disconnect ( ) ;
Terminate the connection to this server.
CORBA :: Object_ptr StartService ( const char * apiName ) ;
Start the named API service on the server.
| apiName | The name of the service. |
void EndService ( const char * apiName ) ;
Stop the named service.
| apiName | The name of the service. |
void SetOption ( const char * option ,
const char * value ) ;
Set the server control option to the given value.
| option | The name of the option |
| value | The value to set |
const char * GetVersion ( ) ;
Retrieve the current server version.
PCREEngine * OpenEngine ( PCREClient * client ,
const BOOL open = TRUE ) ;
Return the PCRE print-engine instance for the client. If open is TRUE, open the engine.
| client | The client instance. |
| open | If TRUE, open the engine. |