| INT WINAPI LlmGetErrorString( |
| |
DWORD dwErrorCode, |
|
| |
LPTSTR lpszDescription, |
|
| |
INT nMaxLength |
|
| ); |
The LlmGetErrorString function returns the
description of a specific error code.
Parameters
- dwErrorCode
- The error code for which a description is returned.
- lpszDescription
- The buffer that will contain a description of the specified
error code. This buffer should be at least 128 characters in
length.
- nMaxLength
- The maximum number of characters that may be copied into the
description buffer.
Return Value
If the function succeeds, the return value is the length of the
description string. If the function fails, the return value is zero,
meaning that no description exists for the specified error code.
Typically this indicates that the error code passed to the function
is invalid.
Remarks
This function is used in conjunction with the LlmGetLastError
function for use with warning dialogs or as diagnostic messages.
Applications should not rely on the returned description text for program
logic. Use the numeric error code for comparisons and handling specific
conditions.
The error descriptions returned by this function are provided in English
only. Applications that require localized error messages should provide
their own translations based on the returned error code.
Requirements
Minimum Desktop Platform: Windows 7 Service Pack 1
Minimum Server Platform: Windows Server 2008 R2 Service Pack 1
Header File: cstools12.h
Import Library: csllmv12.lib
Unicode: Implemented as Unicode and ANSI versions
See Also
LlmGetLastError,
LlmSetLastError
|