RasAdminGetErrorString function

Article
03/22/2021

[This function is provided only for backward compatibility with Windows NT Server 4.0. It returns ERROR_CALL_NOT_IMPLEMENTED on Windows Server 2003. Applications should use the MprAdminGetErrorString function.]

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.

Syntax

DWORD RasAdminGetErrorString(
  _In_  UINT  ResourceId,
  _Out_ WCHAR *lpszString,
  _In_  DWORD InBufSize
);

Parameters

ResourceId [in]: 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. These are defined in Raserror.h.
lpszString [out]: Pointer to a buffer that receives the error message that corresponds to the specified error code.
InBufSize [in]: 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 value

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.

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.

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

Requirement	Value
End of client support	Windows 2000 Professional
End of server support	Windows 2000 Server
Header	Rassapi.h
Library	Rassapi.lib
DLL	Rassapi.dll