Debug Utilities

Detailed Description

group a3d_error_debug_utilities

Functions to aid debugging.

Function Documentation

const A3DUTF8Char *A3DMiscGetErrorMsg(A3DStatus)

Returns the text description of an error code.

This text is stored in a global array used also by A3DMiscGetEntityTypeMsg. This function returns a pointer to the global array and therefore it must not be desallocated. Each time the function is called, the global array is updated. For version 2.1, this method declaration was changed to use the same convention applied to all other HOOPS Exchange declarations. More specifically, the declaration was changed to A3D_API (A3DUTF8Char*, A3DMiscGetErrorMsg,(A3DInt32));. You will not be able to see this change because this reference simplifies all declarations to the more readable format shown in the declaration frame.

Remark

Because this function does not return A3DStatus the internal thread safety policy is to wait for the availability of the API.

Version

2.0

const A3DUTF8Char *A3DMiscGetEntityTypeMsg(A3DEEntityType eType)

Returns the name of the entity type.

This text is stored in a global array used also by A3DMiscGetErrorMsg. This function returns a pointer to the global array and therefore it must not be desallocated. Each time the function is called, the global array is updated. For version 2.1, this method declaration was changed to use the same convention applied to all other HOOPS Exchange declarations. For more information, see the description for A3DMiscGetErrorMsg.

Remark

Because this function does not return A3DStatus the internal thread safety policy is to wait for the availability of the API.

Version

2.0