LBase::GetErrorString

#include "ltwrappr.h"

static L_TCHAR *LBase::GetErrorString (nErrorCode)

L_INT nErrorCode;

/* a LEADTOOLS error code */

Retrieves a pointer to the internal LEADTOOLS error string for the specified error code.

Parameter	Description
nErrorCode	One of the LEADTOOLS error codes. If you specify an invalid error code, the string returned will be "Not a LEADTOOLS error code".

Returns

A pointer to the LEADTOOLS error code string.

Comments

Call this function to retrieve a pointer to the internal LEADTOOLS error string for the specified error code. This function will return NULL if an invalid error code is passed. You should not attempt to free the buffer returned by this function.

Required DLLs and Libraries

LTKRN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:

LBase::EnableAutoErrorDisplay, LBase::SetErrorString, LBase::DisplayErrorFromList, LBase::DisplayError, LBase::IsAutoErrorDisplayEnabled, LBase::GetErrorFromList, LBase::SetErrorListDepth, LBase::RecordError, LBase::GetErrorListDepth, LBase::ClearErrorList, LBase::GetErrorsNumber, LBase::DisplayErrorList, Class Members

Example

L_INT LBase__GetErrorStringExample()
{
	LBitmap LeadBitmap;
	L_TCHAR *pcErr;
	
	pcErr =LeadBitmap.GetErrorString(WRPERR_BITMAP_NOT_ALLOCATED);
	
	return SUCCESS;
}