Your browser does not allow scripts
Please click here to view a static table of contents without scripts
SPI_GetErrorCodeString
Return to Introduction  Previous page  Next page
Provides an explanation of an error code.

FTC_STATUS
SPI_GetErrorCodeString
(LPSTR lpLanguage, FTC_STATUS StatusCode, LPSTR lpErrorMessageBuffer, DWORD dwBufferSize)




Parameters
lpLanguage
Pointer to a NULL terminated string that contains the language code. Default for this first version the default language will be English (EN).
StatusCode
Status code returned from a previous FTC_SPI DLL function call.
lpErrorMessageBuffer
Pointer to the buffer that receives the error code explanation string.
dwBufferSize
Length of the buffer created for the error code explanation string. Set buffer length to a minimum of 100 characters.




Return Value
FTC_SUCCESS if successful, otherwise the return value is one of the following FTC error codes:

   FTC_NULL_LANGUAGE_CODE_BUFFER_POINTER
   FTC_INVALID_LANGUAGE_CODE
   FTC_INVALID_STATUS_CODE
   FTC_NULL_ERROR_MESSAGE_BUFFER_POINTER
   FTC_ERROR_MESSAGE_BUFFER_TOO_SMALL



Example

FTC_STATUS Status = FTC_SUCCESS;
char szErrorMessage[100];

Status = SPI_GetErrorCodeString("EN", Status, szErrorMessage, 100);