MprAdminGetErrorString

[This is preliminary documentation and subject to change.]

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

The error code for a Windows NT router error.

lplpwsErrorString

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

Return Values

NO_ERROR

Success

ERROR_ACCESS_DENIED

The caller does not have sufficient privilege.

ERROR_INVALID_PARAMETER

The error code in dwError is unknown.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in mprapi.h.
  Import Library: Link with mprapi.lib.

See Also

LocalFree