[ROOT] --> C++Client

class PCREServer
    inherited from public PCREService

Author:
Copyright (c) 2000 Dynalivery Corp., All Rights Reserved.

Version:
2.4.0

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

Friends:
 friend class PCREEngine ;
 friend class PCRECustomServer ;
 friend class PCREClient ;
 friend class PCREAppClient ;
 friend class PCREGateway ;

Methods Index

addArgument
Modify the arguments that will be passed to the server.
Connect
Connect this server to the host that was specified, using the supplied arguments, if any.
Disconnect
Terminate the connection to this server.
EndService
Stop the named service.
getAPI
Retrieve the API
getArguments
Retrieve arguments passed to the server
getCommandArgStr
Retrieve arguments passed to the server
getExecutable
Retrieve the filename of the server.
getExecutableStr
Retrieve the filename of the server.
GetFolder
Retrieve the server's current working folder (directory)
getHost
Retrieve the hostname on which the server is running.
getName
Retrieve the name of the server, this defaults to a psuedo-random number, unless it has been explicitly set.
getService
Retrieve the name of this service
GetVersion
Retrieve the current server version.
OpenEngine
Return the PCRE print-engine instance for the client. If open is TRUE, open the engine.
setArguments
Set the arguments that will be passed to the server.
setExecutable
Set an alternate server filename.
SetFolder
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.
setHost
Set the hostname on which the server is to run.
setName
Set the name of the server, this defaults to a psuedo-random number, unless it has been explicitly set.
SetOption
Set the server control option to the given value.
StartService


Methods

getName

 const char * getName ( ) ;

Retrieve the name of the server, this defaults to a psuedo-random number, unless it has been explicitly set.

Return:
The name of the server.

setName

 void setName ( const char * name ) ;

Set the name of the server, this defaults to a psuedo-random number, unless it has been explicitly set.

Parameters:
name The name of the server.

getHost

 const char * getHost ( ) ;

Retrieve the hostname on which the server is running.

Return:
The hostname of the server.

setHost

 void setHost ( const char * address ) ;

Set the hostname on which the server is to run.

Parameters:
address The host the server is to be used on.

getService

 const char * getService ( ) ;

Retrieve the name of this service

Return:
The name of this service.

getArguments

 const char * getArguments ( ) ;

Retrieve arguments passed to the server

Return:
The arguments passed to the server when it was started.

setArguments

 void setArguments ( const char * argstr ) ;

Set the arguments that will be passed to the server.

Parameters:
argstr The arguments that will be used when the server is started.

addArgument

 void addArgument ( const char * argstr ) ;

Modify the arguments that will be passed to the server.

Parameters:
argstr An extra argument that should be added to any existing arguments.

getExecutable

 const char * getExecutable ( ) ;

Retrieve the filename of the server.

Return:
The full filename, including path, of the PCREServer.exe

setExecutable

 void setExecutable ( const char * exestr ) ;

Set an alternate server filename.

Parameters:
exestr The full filename, including path, of the server to use

GetFolder

 const char * GetFolder ( ) ;

Retrieve the server's current working folder (directory)

Return:
The server's current working directory, this has a value even if it hasn't been explicitly set.

SetFolder

 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.

Parameters:
folder The directory to use for the server's current working directory.

getExecutableStr

 const PCREString getExecutableStr ( ) ;

Retrieve the filename of the server.

Return:
The full filename, including path, of the PCREServer.exe

getCommandArgStr

 const PCREString getCommandArgStr ( ) ;

Retrieve arguments passed to the server

Return:
The arguments passed to the server when it was started.

getAPI

 const PCREAPIServer_ptr getAPI ( ) ;

Retrieve the API

Return:
The server API object that is being used by this server.

Connect

 void Connect ( ) ;

Connect this server to the host that was specified, using the supplied arguments, if any.

Disconnect

 void Disconnect ( ) ;

Terminate the connection to this server.

StartService

 CORBA :: Object_ptr StartService ( const char * apiName ) ;

Start the named API service on the server.

Parameters:
apiName The name of the service.

Return:
The object pointer of the API service.

EndService

 void EndService ( const char * apiName ) ;

Stop the named service.

Parameters:
apiName The name of the service.

SetOption

 void SetOption ( const char * option ,
                        const char * value ) ;

Set the server control option to the given value.

Parameters:
option The name of the option
value The value to set

GetVersion

 const char * GetVersion ( ) ;

Retrieve the current server version.

Return:
A string holding the server version information.

OpenEngine

 PCREEngine * OpenEngine ( PCREClient * client ,
                                 const BOOL open = TRUE ) ;

Return the PCRE print-engine instance for the client. If open is TRUE, open the engine.

Parameters:
client The client instance.
open If TRUE, open the engine.

Return:
The print-engine instance for the client.

Copyright (c) 2000 Dynalivery Corp.