MprAdminInterfaceTransportGetInfo

The MprAdminInterfaceTransportGetInfo function retrieves information about a transport running on a specified interface.

DWORD MprAdminInterfaceTransportGetInfo(
  MPR_SERVER_HANDLE hMprServer,  // handle to router
  HANDLE hInterface,             // handle to interface
  DWORD dwTransportId,           // transport/router manager ID
  LPBYTE *ppInterfaceInfo,       // buffer to receive
                                 // interface information
  LPDWORD lpdwInterfaceInfoSize  // size of interface
                                 // information returned
);

Parameters

hMprServer
[in] Handle to the Windows 2000 router on which to execute this call. Obtain this handle by calling MprAdminServerConnect.
hInterface
[in] Handle to the interface. This handle is obtained from a previous call to MprAdminInterfaceCreate.
dwTransportId
[in] Specifies the transport/router manager for which information is requested.
ppInterfaceInfo
[out] Pointer to a pointer variable. The pointer variable points to an information header that receives information for the specified interface and transport. Use the Information Header Functions to manipulate information headers.
lpdwInterfaceInfoSize
[out] Pointer to a DWORD variable. This variable receives the size in bytes of the interface information returned through the ppInterfaceInfo parameter.

This parameter is optional. If the calling application specifies NULL for this parameter, the function does not return the size of the interface information.

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_HANDLE The hInterface value is invalid, or if the interface specified is administratively disabled.
ERROR_NO_SUCH_INTERFACE The specified transport is not running on the specified interface.
ERROR_NOT_ENOUGH_MEMORY Insufficient resources to complete the operation.
ERROR_UNKNOWN_PROTOCOL_ID The dwTransportId value does not match any installed transport or router manager.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Mprapi.h.
  Library: Use Mprapi.lib.

See Also

Router Management Reference, Router Administration Functions, MprAdminInterfaceCreate, MprAdminInterfaceTransportSetInfo, MprAdminServerConnect