nn::nex::NetZ::GetFatalError Member Function

Syntax

virtual qResult GetFatalError() const;

Parameters

None.

Return Values

A fatal error that occurred internally.

Description

Gets fatal errors that occur within a NetZ instance.

After the creation of a NetZ instance, run at a frequency of one time per frame to check whether a fatal error occurred. It is not necessary to perform error checking with this function during the NetZ::Terminate function.

If some kind of fatal error occurred, the function returns a qResult that represents failure.

Use the following procedures to handle the values returned by this function:
・To determine whether a fatal error occurred, use QFAILED to check the value returned by this function, or compare with FALSE.
・If the qResult returned by the function represents failure, that means that some kind of fatal error occurred. Save the error, immediately destroy NetZ, and display on the screen the error code obtained by the ErrorCodeConverter::ConvertToNetworkErrorCode function.
・If the qResult returned by the function represents success, the application requires no special handling.

The following qResult values can be obtained with this function.
- QSUCCESS(Core, Success) (When no error occurred, this value is returned to represent success.)
- QERROR(DOCore, InvalidState)
- QERROR(DOCore, FaultRecoveryFatal)
- QERROR(DOCore, FaultRecoveryJobProcessFailed)
- QERROR(Transport, ReliableSendBufferFullFatal)
- QERROR(Transport, NoBuffer)
- QERROR(DOCore, StationInconsistency)

See Also

ErrorCodeConverter::ConvertToNetworkErrorCode
QFAILED
DOCoreErrorCode::ErrorCode

Revision History

2014/04/16
Changed the notation of the QRESULT_SUCCESS and QRESULT_ERROR return values to QSUCCESS and QERROR.
2012/05/29
The value that is returned when no error occurred was incorrectly stated as QRESULT_SUCCESS(DOCore, Success). That was corrected to QRESULT_SUCCESS(Core, Success). Noted that the value should be checked by using either QFAILED, or by comparing with a bool value. Noted that nothing special is required of the application when the value returned for qResult represents success.
2012/04/10
Initial version.

CONFIDENTIAL