Functions

Q3Error_Get

( TQ3Error ) Q3Error_Get (
    TQ3Error *firstError
);

Discussion

Retrieve latest error codes from Quesa.

Retrieve the most recent error code, and optionally also the oldest unreported error code. After this call, the next Quesa call that is not part of the Error Manager will clear the error codes.

Parameter Descriptions

firstError
Pointer to variable to receive the oldest error code that has not yet been reported. May be NULL if you don't need that information.

function result: Most recent error code.

Q3Error_IsFatalError

( TQ3Boolean ) Q3Error_IsFatalError (
    TQ3Error error
);

Discussion

Determine whether a Quesa error code is fatal.

You can call this function from an error callback or after getting an error code with Q3Error_Get. If the error is fatal, your application should quit without calling any other Quesa routines.

Parameter Descriptions

error
A Quesa error code.

function result: True if the error is fatal.

Q3Error_PlatformGet

( TQ3Uns32 ) Q3Error_PlatformGet (
    TQ3Uns32 *firstErr
);

Discussion

Gets platform-specific error codes. This is a generalization of Q3MacintoshError_Get, and may be used in place of Q3MacintoshError_Get on the Macintosh platform.

If an error callback or Q3Error_Get returns one of the special error codes kQ3ErrorMacintoshError, kQ3ErrorWin32Error, kQ3ErrorUnixError, kQ3ErrorPlatformError, you can call this function to retrieve platform-specific error codes. After this call, the next Quesa call that is not part of the Error Manager will clear the platform-specific error codes.

This function is not available in QD3D.

Parameter Descriptions

firstErr
Pointer to variable to receive the oldest unreported platform-specific error code. May be NULL if you don't need that information.

function result: Most recent platform-specific error code.

Q3Error_PlatformPost

( void ) Q3Error_PlatformPost (
    TQ3Uns32 theErr
);

Discussion

Posts a platform-specific error code.

Normally this would be used only by Quesa plug-ins, not by application code.

This function is not available in QD3D.

Parameter Descriptions

theErr
A platform-specific error code.

Q3Error_Register

( TQ3Status ) Q3Error_Register (
    TQ3ErrorMethod errorPost,
    TQ3Int32 reference
);

Discussion

Install a callback to handle errors.

Use this function to register an error-handling function that will be called when Quesa detects an error condition that it can't handle. Your callback should not call Quesa except for Error Manager routines.

Parameter Descriptions

errorPost
Callback to receive error notifications.

reference
Constant passed to error callback.

function result: kQ3Success when the callback is installed.

Q3Error_ToString

( const char * ) Q3Error_ToString (
    TQ3Language theLanguage,
    TQ3Error theError
);

Discussion

Retrieve a string version of the error code.

This function is not available in QD3D.

Parameter Descriptions

theLanguage
Preferred language for the error string. Currently only English is supported.

theError
Quesa error code.

function result: Text version of the error code, as a NULL-terminated string.

Q3MacintoshError_Get

( OSErr ) Q3MacintoshError_Get (
    OSErr *firstMacErr
);

Discussion

Retrieve the most recent Macintosh error code, and optionally also the oldest unreported Mac error code. After this call, the next Quesa call that is not part of the Error Manager will clear the error codes.

Q3Error_PlatformGet may be used in place of this function.

Parameter Descriptions

firstMacErr
Pointer to variable to receive the oldest Mac error code that has not yet been reported. May be NULL if you don't need that information.

function result: Most recent Mac error code.

Q3Notice_Get

( TQ3Notice ) Q3Notice_Get (
    TQ3Notice *firstNotice
);

Discussion

Retrieve latest notice codes from Quesa.

Retrieve the most recent notice code, and optionally also the oldest unreported notice code. After this call, the next Quesa call that is not part of the Error Manager will clear the notice codes.

Parameter Descriptions

firstNotice
Pointer to variable to receive the oldest notice code that has not yet been reported. May be NULL if you don't need that information.

function result: Most recent notice code.

Q3Notice_Register

( TQ3Status ) Q3Notice_Register (
    TQ3NoticeMethod noticePost,
    TQ3Int32 reference
);

Discussion

Install a callback to handle notifications.

Use this function to register an warning-handling function that will be called when a Quesa routine generates a notice. This will only happen in debugging versions of Quesa. Your callback should not call Quesa except for Error Manager routines.

Parameter Descriptions

noticePost
Routine to be called to handle notices.

reference
Constant passed to notice callback.

function result: kQ3Success when the callback is installed.

Q3Notice_ToString

( const char * ) Q3Notice_ToString (
    TQ3Language theLanguage,
    TQ3Notice theError
);

Discussion

Retrieve a string version of the notice code.

This function is not available in QD3D.

Parameter Descriptions

theLanguage
Preferred language for the notice string. Currently only English is supported.

theWarning
Quesa notice code.

function result: Text version of the notice code, as a NULL-terminated string.

Q3Warning_Get

( TQ3Warning ) Q3Warning_Get (
    TQ3Warning *firstWarning
);

Discussion

Retrieve latest warning codes from Quesa.

Retrieve the most recent warning code, and optionally also the oldest unreported warning code. After this call, the next Quesa call that is not part of the Error Manager will clear the warning codes.

Parameter Descriptions

firstWarning
Pointer to variable to receive the oldest warning code that has not yet been reported. May be NULL if you don't need that information.

function result: Most recent warning code.

Q3Warning_Register

( TQ3Status ) Q3Warning_Register (
    TQ3WarningMethod warningPost,
    TQ3Int32 reference
);

Discussion

Install a callback to handle warnings.

Use this function to register an warning-handling function that will be called when a Quesa routine generates a warning that it can't handle. Your callback should not call Quesa except for Error Manager routines.

Parameter Descriptions

warningPost
Callback to receive warning notifications.

reference
Constant passed to warning callback.

function result: kQ3Success when the callback is installed.

Q3Warning_ToString

( const char * ) Q3Warning_ToString (
    TQ3Language theLanguage,
    TQ3Warning theWarning
);

Discussion

Retrieve a string version of the warning code.

This function is not available in QD3D.

Parameter Descriptions

theLanguage
Preferred language for the warning string. Currently only English is supported.

theWarning
Quesa warning code.

function result: Text version of the warning code, as a NULL-terminated string.