MprAdminDeviceEnum function (mprapi.h)

The MprAdminDeviceEnum function is called to enumerate RAS capable devices installed on the computer that can return their name and type.

Syntax

DWORD MprAdminDeviceEnum(
  [in]  MPR_SERVER_HANDLE hMprServer,
  [in]  DWORD             dwLevel,
  [out] LPBYTE            *lplpbBuffer,
  [out] LPDWORD           lpdwTotalEntries
);

Parameters

[in] hMprServer

Handle to the router on which to execute this call. Obtain this handle by calling MprAdminServerConnect.

[in] dwLevel

A DWORD value that describes the format in which the information is returned in the lplpbBuffer parameter. Must be zero.

[out] lplpbBuffer

On successful completion, an array of MPR_DEVICE_0 structures that contains the RAS capable device information. Free this memory by calling MprAdminBufferFree.

[out] lpdwTotalEntries

The number of entries of type MPR_DEVICE_0 in lplpbBuffer.

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_NOT_SUPPORTED	The dwlevel parameter does not equal zero.
ERROR_INVALID_PARAMETER	The lplpbBuffer or lpdwTotalEntries parameter is NULL.

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

MprAdminServerConnect

Router Administration Functions

Router Management Reference