Main Page   Modules   Alphabetical List   Data Structures   Data Fields  

RwError
[Error & Debug Handling]


Data Structures

struct   RwError

Functions

RwError RwErrorSet (RwError *code)
RwError RwErrorGet (RwError *code)

Detailed Description

Error code handling

RwError Overview

Requirements

Overview

This object provides a generic error reporting mechanism.

If a function fails for any reason, it uses RwErrorSet to set the error code to a predetermined value (usually a constant defined in a header file), so that the calling function can determine what the problem is using RwErrorGet.


Function Documentation

RwError* RwErrorGet RwError   code
 

RwErrorGet is used to retrieve the error code for the last reported error. The error code identifies both the numerical value of the error and the plugin that issued it. The error code is reset to E_RW_NOERROR once it has been read.

This function is available in both debug and release versions of the RenderWare library. In a debug library an error message is also written to the debug stream when an error is raised.

Parameters:
code  A pointer to an RwError value that will receive the error code.
Returns:
Returns a pointer to an RwError code if successful.
See also:
RwDebugSetHandler , RwDebugSendMessage , RwDebugSetTraceState
RwError* RwErrorSet RwError   code
 

RwErrorSet is used to set the error code. The error code identifies both the numerical value of the error and the plugin that issued it. The error code is reset to E_RW_NOERROR once it has been read.

This function is available in both debug and release versions of the RenderWare library. In a debug library an error message is also written to the debug stream when an error is raised.

Parameters:
code  A pointer to an RwError value that will be used to set the error code.
Returns:
A pointer to the error if successful.
See also:
RwErrorGet , RwDebugSetHandler , RwDebugSendMessage , RwDebugSetTraceState

Criterion Software © 1993-2003 Criterion Software Limited. All rights reserved. Built Tue Apr 22 12:46:14 2003. Send Feedback
Converted from CHM to HTML with chm2web Pro 2.85 (unicode)