MprAdminInterfaceEnum

[This is preliminary documentation and subject to change.]

The MprAdminInterfaceEnum function enumerates all the interfaces on a specified server.

DWORD  MprAdminInterfaceEnum (
  MPR_SERVER_HANDLE hMprServer,    // handle to the router
  DWORD dwLevel,                   // level of information provided
  LPBYTE * lplpbBuffer,            // array of MPR_INTERFACE_0 structures
  DWORD dwPrefMaxLen,              // maximum length of data to return
  HANDLE lpdwEntriesRead,          // number of entries enumerated
  HANDLE lpdwTotalEntries,         // number of entries that could 
                                   // have been enumerated
  LPDWORD lpdwResumeHandle         // handle for continuing 
                                   // the enumeration
);

Parameters

hMprServer

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

dwLevel

Level of the information passed in lpBuffer. Must be zero.

lplpbBuffer

The address of a pointer variable that will point to an array of MPR_INTERFACE_0 structures on successful return. This memory should be freed by the MprAdminBufferFree call.

dwPrefMaxLen

Specifies the preferred maximum length of returned data (in 8-bit bytes). If this parameter is -1, the buffer returned will be large enough to hold all available information.

lpdwEntriesRead

Pointer to a DWORD variable. On successful return, this variable contains the total number of entries that were enumerated from the current resume position.

lpdwTotalEntries

Pointer to a DWORD variable. On successful return, this variable contains the total number of entries that could have been enumerated from the current resume position.

lpdwResumeHandle

Pointer to a DWORD variable. On successful return, this variable contains a resume handle that can be used to continue the enumeration. The handle should be zero on the first call, and left unchanged on subsequent calls. If the return code is ERROR_MORE_DATA then the call may be re-issued with the handle to retrieve more data. If on return, the handle is NULL, the enumeration cannot be continued. For other types of error returns, this handle is invalid.

This parameter is optional. If the caller specifies NULL for this parameter, the function will not return a resume handle.

Return Values

NO_ERROR

All interfaces were enumerated successfully.

ERROR_ACCESS_DENIED

The caller does not have sufficient privilege.

ERROR_MORE_DATA

More information is available; the enumeration can be continued.

ERROR_NOT_ENOUGH_MEMORY

Insufficient resources to complete the operation.

ERROR_NOT_SUPPORTED

The value of dwLevel is non-zero.

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

MprAdminBufferFree, MprAdminServerConnect