MprAdminGetErrorString

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

DWORD MprAdminGetErrorString(
  DWORD dwError,               // router error code
  LPWSTR *lplpwsErrorString    // descriptive text for error
);

Parameters

dwError
[in] Specifies the error code for a Windows 2000 router error.
lplpwsErrorString
[out] 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 Values

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_INVALID_PARAMETER The error code in dwError is unknown.

Requirements

  Windows NT/2000: Requires Windows 2000. Available as a redistributable for Windows NT 4.0.
  Header: Declared in Mprapi.h.
  Library: Use Mprapi.lib.

See Also

Router Management Reference, Router Administration Functions, LocalFree