L_GetFriendlyErrorMessage

Summary

Gets a friendly error message string for the specified LEADTOOLS return code.

Syntax

#include "l_bitmap.h"

L_LTKRN_API L_INT L_GetFriendlyErrorMessage(nError, pszErrorMessage, count, bDeveloperMode);

Parameters

L_INT nError

The LEADTOOLS return code. See Return Codes.

L_TCHAR* pszErrorMessage

Pointer to your string that will be updated with the friendly message.

L_UINT count

The size of your string that will hold the friendly message. Up to count characters will be copied to pszErrorMessage.

L_BOOL bDeveloperMode

Reserved for future use. Pass FALSE.

Returns

Value Meaning
< 0 An error occurred. Refer to Return Codes.

Comments

Platforms

Win32, x64, Linux.

See Also

Topics

Example

Gets a friendly error message string for the specified LEADTOOLS return code. 

L_INT GetFriendlyErrorMessageExample() 
static L_INT GetFriendlyErrorMessageExample() 
{ 
   /* create an error */ 
   L_INT nRet = L_SetLicenseFile(L_TEXT("some file that does not exist"), L_TEXT("some invalid developer key")); 
   L_TCHAR ErrorBuf[1024] = { 0 }; 
   L_GetFriendlyErrorMessage(nRet, ErrorBuf, _countof(ErrorBuf), L_FALSE); 
   MessageBox(NULL, ErrorBuf, L_TEXT("Friendly Error Message"), MB_OK | MB_ICONERROR); 
   return SUCCESS; 
}

Help Version 22.0.2023.7.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help
Introduction
Version History
Getting Started
Files To Be Included With Your Application
Document Writers – Files To Be Included With Your Application
LEADTOOLS Raster Imaging Features
Quick Reference
Tutorials
Function References
Callback Functions
Summary of Features
Appendix
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.