[ROOT] --> C Client

Structure Index

Name	Scope	Type	Brief Description
PCREParameterField	local	struct
PEConsole	local	struct
PEExportOptions	local	struct	Contains information used when exporting report files.
PEGraphDataInfo	local	struct	This structure is used by several functions which operate on Graphs.
PEGraphOptions	local	struct	This structure is used by several functions which operate on Graphs.
PEGraphTextInfo	local	struct	This structure is used by several functions which operate on Graphs.
PEGroupOptions	local	struct	Contains information about Groups in the report.
PEJobInfo	local	struct	This structure is used by calls to PCREJob::GetStatus
PELogOnInfo	local	struct	This structure holds database logon information.
PEParameterFieldInfo	local	struct	This structure contains information about parameters.
PEPrintOptions	local	struct	Retrieves the print options specified for the report.
PEReportSummaryInfo	local	struct	Provides report summary information.
PESectionOptions	local	struct	Contains information about sections in a report.
PESessionInfo	local	struct	Contains information about the current Microsoft Access session.
PESubreportInfo	local	struct	Retrieves information about the specified subreport.
PETableLocation	local	struct	Contains database location information.
PETableType	local	struct	This structure holds informations about tables.

Function Index

Name	Scope	Type	Brief Description
ExportToHTML	global	function
ExportToPDF	global	function
PEBurstReport	global	function	Call BurstReport custom function.
PEClearPrinterNames	global	function	Remove all entries from the printer name list.
PECloseFTP	global	function	Close the FTP session. This must be done when you have finished working with the FTP server.
PEConnect	global	function	Connect the C application client to its regsitered services.
PEConnected	global	function	Check if the client is connected to the named service.
PECreateRemoteDirectory	global	function	Create a directory on the remote system.
PEDeleteLocalFile	global	function	Delete a file on the local system.
PEDeleteRemoteFile	global	function	Delete a file on the remote system.
PEDisableExceptions	global	function	Disable exception-throwing: client retrieves error code and text
PEDisconnect	global	function	Disconnect the C application client from its services.
PEEnableExceptions	global	function	Enable exception-throwing: client handles the exception
PEExportToPDF	global	function	Export a report to PDF
PEGatewayConnect	global	function	Connect the client to the gateway.
PEGatewayDisconnect	global	function	Disconnect the client from the gateway.
PEGatewayGetHost	global	function	Get the Gateway's host.
PEGatewayGetName	global	function	Get the Gateway's name.
PEGatewayGetWait	global	function	Return the Gateway's wait property
PEGatewayRequestServer	global	function	Request a server using the Gateway
PEGatewaySetHost	global	function	Set the Gateway's host.
PEGatewaySetName	global	function	Set the Gateway's name.
PEGatewaySetWait	global	function	Set the Gateway's wait property
PEGetAreaFormatFormulaStrPtr	global	function	Get the formula of the area format.
PEGetClientHost	global	function	Get the name of the host for this connection. This is set in the initialisation code.
PEGetClientName	global	function	Get the name of the C application client
PEGetCustomServer	global	function	Return a handle to the PCRE Custom Server installed in the client.
PEGetFile	global	function	Retrieve a file from the remote server.
PEGetFileRename	global	function	Retrieve a file from the remote server, specifying its local name,
PEGetFormulaStrPtr	global	function	Get the formula string.
PEGetFTPDirectory	global	function	Get the current directory on the FTP server.
PEGetGateway	global	function	Return the client's Gateway handle.
PEGetGroupConditionStrPtr	global	function	Get a specified group's condition information.
PEGetGroupSelectionFormulaStrPtr	global	function	Get a specified group's selection formula.
PEGetMultipleFiles	global	function	Retrieve multiple files from the remote server.
PEGetNPrinterNames	global	function	Get the number of printer names in the list.
PEGetNthFormulaStrPtr	global	function	Get a specific formula string.
PEGetNthGroupSortFieldStrPtr	global	function	Get a group's sort field string.
PEGetNthParameterField	global	function
PEGetNthParamStrPtr	global	function	Get a parameter string.
PEGetNthPrinterName	global	function	Get the Nth printer name from the list.
PEGetNthSortFieldStrPtr	global	function	Get a sort field string.
PEGetNthSubreportInfo	global	function	Return info on the the Nth subreport in the given section.
PEGetPrinterInfoWin	global	function	Get a printer's port, driver, and DEVMODE.
PEGetPrinterNames	global	function	Retrieves a list of the server's available printers.
PEGetReportTitleStrPtr	global	function	Get the title of given report.
PEGetSectionFormatFormulaStrPtr	global	function	Get the format formula of a given section.
PEGetSelectedPrinterByName	global	function	Get the name and PCREPrinterMode of the selected printer for the given print job.
PEGetSelectedPrinterStrPtr	global	function	Get the string of selected printer.
PEGetSelectionFormulaStrPtr	global	function	Get the formula.
PEGetServer	global	function	Get the handle to the client's server.
PEGetService	global	function	Retrieve a handle for a named service
PEGetSQLQueryStrPtr	global	function	Get SQL query string.
PEInitAPI	global	function	Module intialization: optionally specify host
PEInitialize	global	function	Initialize and connect services for C clients.
PEInitRemote	global	function	Deprecated initialization routine
PENavigate	global	function	Force a browser to open, and display a URL using the given browser if you wish to use anothere browser then you may use the function PENavigateWithBrowser.
PENavigateWithBrowser	global	function	Force a browser to open, and display a URL using the given browser
PENewClient	global	function	Create an application client with given console for C clients
PENewFileServer	global	function	Return a handle to a new file server installed in the client. This handle must be closed when you have finished working with the FTP server
PEPutFile	global	function	Store a file on the remote server.
PEPutFileRename	global	function	Store a file on the remote server, giving it a different name.
PEPutMultipleFiles	global	function	Store multiple files, identified via wildcards on the remote machine.
PERemoveRemoteDirectory	global	function	Remove a directory on the remote system.
PERemoveService	global	function	Remove the service from the client.
PERenameRemoteFile	global	function	Rename a file on the remote system.
PERunDistiller	global	function	Call RunDistiller custom function.
PERunScript	global	function	Call RunSCript custom function.
PEServerAddArgument	global	function	Set additional Servers arguments.
PEServerConnect	global	function	Connect the client to the PCRE Server.
PEServerDisconnect	global	function	Disconnect the client from the PCRE Server
PEServerEndService	global	function	End the named API service on the server.
PEServerGetArguments	global	function	Get the Servers arguments.
PEServerGetFolder	global	function	Get the Server's folder.
PEServerGetHost	global	function	Get the Server's hostname.
PEServerGetName	global	function	Get the Server's name.
PEServerGetVersion	global	function	Get the Server's version information.
PEServerSetArguments	global	function	Set the Servers arguments.
PEServerSetExecutable	global	function	Set the Servers executable.
PEServerSetFolder	global	function	Set the Servers current working directory.
PEServerSetHost	global	function	Set the Servers hostname.
PEServerSetName	global	function	Set the Servers name.
PEServerSetOption	global	function	Set the server control option to the given value.
PEServerStartService	global	function	Start the named API service on the server.
PESetClientError	global	function	Set the error that will be returned to the user by the next call to GetErrorCode, and GetErrorText
PESetClientName	global	function	Set the name of the C application client
PESetFTPDirectory	global	function	Change the current directory on the FTP server.
PESetNthParameterField	global	function
PEUnInitAPI	global	function	Module finalization: reset module variables to their initial state
PEUninitialize	global	function	Uninitialize and disconnect C clients
PEUseService	global	function	Register the service with the C application client. See PEGetService.