Name

cgD3D9TranslateHRESULT - convert an HRESULT into a string

Synopsis

#include <Cg/cgD3D9.h>

const char * cgD3D9TranslateHRESULT( HRESULT hr );

Parameters

hr

The HRESULT to translate. Can be a generic HRESULT or a D3D runtime error.

Return Values

Returns a pointer to a string describing the error.

Description

cgD3D9TranslateHRESULT converts an HRESULT into a string. This routine should be called instead of DXGetErrorDescription9 because it will also translate errors that the Cg D3D runtime generates.

This routine will typically be called in debugging situations such as inside an error callback set using cgSetErrorCallback.

Examples

char buf[512];
HRESULT hres = cgD3D9GetLastError();
if (FAILED(hres))
{
    sprintf(buf, "A D3D error occurred. Error description: '%s'\n",
            cgD3D9TranslateHRESULT(hres));
    OutputDebugString(buf);
}

Errors

None.

History

cgD3D9TranslateHRESULT was introduced in Cg 1.1.

See Also

cgD3D9TranslateCGerror, cgGetErrorString, cgSetErrorCallback