RasAdminGetErrorString
[New
- Windows NT]
The RasAdminGetErrorString
function retrieves a message string that corresponds to a RAS error code returned
by one of the RAS server administration (RasAdmin) functions. These message
strings are retrieved from the RASMSG.DLL that is installed as part of RAS.
DWORD RasAdminGetErrorString (
|
UINT ResourceId, |
// error code to
get message for |
|
WCHAR *lpszString, |
// pointer to a
buffer that receives the error string |
|
DWORD InBufSize |
// size, in
characters, of the buffer |
|
); |
|
Parameters
ResourceId
Specifies an
error code returned by one of the RasAdmin functions. This value must be in the
range of error codes from RASBASE to RASBASEEND that are defined in RASERROR.H.
lpszString
Pointer to a
buffer that receives the error message corresponding to the specified error
code.
InBufSize
Specifies the
size, in characters, of the lpszString buffer. Error messages are
typically 80 characters or less; a buffer size of 512 characters is always
adequate.
Return Values
If the
function succeeds, the return value is ERROR_SUCCESS.
If the
function fails, the return value is an error code. This value can be a last
error value set by the LoadLibrary, GlobalAllocF12W9., or LoadString functions; or it can be one
of the following error codes.
|
Value |
Meaning |
|
ERROR_INVALID_PARAMETER |
The ResourceId
or lpszString parameters are invalid. |
|
ERROR_INSUFFICIENT_BUFFER |
The size
specified by the InBufSize parameter is too small. |
Do not call GetLastError
to get error information for this function.
Remarks
The RasAdmin
functions can return error codes that are not in the range supported by the RasAdminGetErrorString
function. For example, the RasAdmin functions can return error codes that are
defined in LMERR.H and WINERROR.H. Before calling RasAdminGetErrorString,
verify that the error code is in the range RASBASE to RASBASEEND, as defined in
RASERROR.H.
See Also