Edit

Share via

MprAdminGetErrorString function (mprapi.h)

  • Article

The MprAdminGetErrorString function returns the string associated with a router error from Mprerror.h.

Syntax

DWORD MprAdminGetErrorString(
  [in]  DWORD  dwError,
  [out] LPWSTR *lplpwsErrorString
);

Parameters

[in] dwError

Specifies the error code for a router error.

[out] lplpwsErrorString

Pointer to an LPWSTR variable that points to the text associated with the dwError code on successful return. Free this memory by calling LocalFree.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Value Meaning
ERROR_ACCESS_DENIED
 The calling application does not have sufficient privileges.
ERROR_MR_MID_NOT_FOUND
 The error code in dwError is unknown.
 
 

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header mprapi.h
Library Mprapi.lib
DLL Mprapi.dll

See also

LocalFree

Router Administration Functions

Router Management Reference