FtVspcGetErrorMessage Function

Retrieves the error code description.

size_t FtVspcGetErrorMessage(
	FtVspc_ErrorCode error,
	LPTSTR lpBuffer,
	size_t cchBuffer 
	);

Parameters

error

[in] Error code. Refer to FtVspc_ErrorCode.

lpBuffer

[in] A pointer to the buffer that receives the null-terminated string containing the error code description.

cchBuffer

[in] Maximum size of the buffer specified by the lpBuffer parameter, in TCHARs.

Return Value

If the function succeeds, the return value is the length of the string copied to the buffer, in TCHARs, not including the terminating null character. If the length is greater than the size of the buffer, the return value is the size of the buffer required to hold the message (including the terminating null character). If the function fails, the return value is zero.

Remarks

ANSI version is available for Win32 only.

See Also

FtVspc_ErrorCode