MprAdminInterfaceGetInfo

[This is preliminary documentation and subject to change.]

The MprAdminInterfaceGetInfo function retrieves information for a specified interface on a specified server.

DWORD  MprAdminInterfaceGetInfo(
  MPR_SERVER_HANDLE hMprServer,    // handle to router 
  HANDLE hInterface,               // handle to interface
  DWORD dwLevel,                   // level of information
  LPBYTE * lplpbBuffer             // buffer for information
);

Parameters

hMprServer

A handle to the Windows NT router to query. This handle is obtained from a previous call to MprAdminServerConnect.

hInterface

A handle to the interface obtained by a previous call to MprAdminInterfaceCreate.

dwLevel

The level of the information returned in lplpbBuffer. Must be zero.

lplpbBuffer

The address of a pointer. On successful return, this pointer will point to an MPR_INTERFACE_0 structure. Free this memory by calling MprAdminBufferFree.

Return Values

NO_ERROR

Router interface created successfully.

ERROR_ACCESS_DENIED

The caller does not have sufficient privilege.

ERROR_INVALID_HANDLE

The hInterface value is invalid.

ERROR_INVALID_PARAMETER

lplpbBuffer is NULL.

ERROR_NOT_ENOUGH_MEMORY

Not enough resources to complete the operation.

ERROR_NOT_SUPPORTED

The dwLevel value is invalid.

See Also

MPR_INTERFACE_0, MprAdminBufferFree, MprAdminInterfaceCreate, MprAdminServerConnect