PCREAPIError

[ROOT] --> C++Client

class PCREAPIError
extends PCREError as public

A PCREAPIError is thrown to a client in response to an error making an API call.

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

Version:: 2.4.0

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

PCREAPIError: Construct a PCREAPIError with the specified error code and text.
PCREAPIError: Construct a PCREAPIError with the specified code.

Narrow: Provides a type-safe cast from a PCREError pointer to a PCREAPIError pointer.
Report: Report the error condition with which this PCREAPIError is associated by calling the PCREAPIErrorMsg method of the client's console.
Report: Generate a PCREAPIError with the specified error text, and report it by calling the PCREAPIErrorMsg method of the client's console.
Report: Generate a PCREAPIError with the specified error code and text, and report it by calling the PCREAPIErrorMsg method of the client's console.
Report: Report a CORBA exception to the client by calling the PCREAPIErrorMsg method of the client's console.
Throw: Throw this exception to the client.
Throw: Generate and throw an API error to the client with the specified error text.
Throw: Generate and throw an API error to the client with the specified error code and text.
Throw: Throw a CORBA exception to the client.

PCREAPIError

PCREAPIError ( int code ,
                      const char * text ) ;

Construct a PCREAPIError with the given code and text.

Parameters:

code	The error code.
text	The error text.

PCREAPIError

PCREAPIError ( const char * text ) ;

Construct a PCREAPIError with the given text.

Parameters:

text

The error text.

Narrow

static PCREAPIError * Narrow ( PCREError * error ) ;

Provides a type-safe cast from a PCREError pointer to a PCREAPIError pointer.

Parameters:

error

A pointer to a PCREError object.

Return:

If the object to which error points is a PCREAPIError object, then a PCREAPIError pointer to it is returned. Otherwise a NULL pointer is returned.

Report

void Report ( ) ;

Report the error condition with which this PCREAPIError is associated by calling the PCREAPIErrorMsg method of the client's console.

Report

static void Report ( const char * text ,
                            . . . ) ;

Generate a PCREAPIError with the specified error text, and report it by calling the PCREAPIErrorMsg method of the client's console.

Parameters:

text

The text to use for the error report. This string my contain printf-style format specifiers, in which case the arguments to be used in the formatted string must follow text.

Report

static void Report ( int code ,
                            const char * text ,
                            . . . ) ;

Generate a PCREAPIError with the specified error code and text, and report it by calling the PCREAPIErrorMsg method of the client's console.

Parameters:

code	The error code to use for the error report.
text	The text to use for the error report. This string my contain printf-style format specifiers, in which case the arguments to be used in the formatted string must follow text.

Report

static void Report ( CORBA :: Exception & ex ) ;

Report a CORBA exception to the client by calling the PCREAPIErrorMsg method of the client's console.

Parameters:

ex	The CORBA exception to report.

Throw

void Throw ( ) ;

Throw this exception to the client.

Throw

static void Throw ( const char * text ,
                           . . . ) ;

Generate and throw an API error to the client with the specified error text.

Parameters:

text

The error description that is to be thrown with the exception. This string may contain printf-style format specifiers, in which case the arguments to be formatted in the string must follow text.

Throw

static void Throw ( int code ,
                           const char * text ,
                           . . . ) ;

Generate and throw an API error to the client with the specified error code and text.

Parameters:

code	The error code that is to be thrown with the exception.
text	The error description that is to be thrown with the exception. This string may contain printf-style format specifiers, in which case the arguments to be formatted in the string must follow text.

Throw

static void Throw ( CORBA :: Exception & ex ) ;

Throw a CORBA exception to the client.

Parameters:

ex	The exception to throw.