RasAdminGetErrorString

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, GlobalAlloc, or LoadString functions; or it can be one of the following error codes.

There is no extended error information for this function; do not call GetLastError.

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.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Header: Declared in Rassapi.h.
  Library: Use Rassapi.lib.

See Also

Remote Access Service (RAS) Overview, RAS Server Administration Functions, LoadLibrary, GlobalAlloc, LoadString