ID_GetError function

Function that is called to retrieve a text string describing a custom plug-in error code.

Syntax

PLUGIN_API int __stdcall ID_GetError
(
   int      nError, 
   wchar_t* pszErrBuf,
   int      cbErrBuf
);

Parameters

nError

Type: int

[in] Plug-in-defined error code.

pszErrBuf

Type: wchar_t*

[out] Buffer to put error message text info.

cbErrBuf

Type: int

[in] Size of error buffer.

Return Value

For a description of return values, see Return Values.

Remarks

Load pszErrBuf with a null-terminated string describing the given plug-in-specific error code. This function implements plug-in-defined error code lookup. The plug-in does not own the memory pointed to by pszErrBuf and must not free it.

Requirements

Header: ID_PlugIn.h

See also:

• Return Values