MprAdminInterfaceTransportGetInfo

[This is preliminary documentation and subject to change.]

The MprAdminInterfaceTransportGetInfo function retrieves information about a transport running on an 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

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

hInterface

Handle to the interface. This handle is obtained from a previous call to MprAdminInterfaceCreate.

dwTransportId

Identifies the transport/router manager for which information is requested.

ppInterfaceInfo

Pointer to a pointer variable. On successful return, the pointer variable will point to interface information for the specified transport.

lpdwInterfaceInfoSize

Pointer to a DWORD variable. On successful return, this variable contains the size in bytes of the interface information returned through the ppInterfaceInfo parameter.

This parameter is optional. If the caller specifies NULL for this parameter, the function will not return the size of the interface information.

Return Values

NO_ERROR

Success

ERROR_ACCESS_DENIED

The caller does not have sufficient privilege.

ERROR_INVALID_HANDLE

The hInterface value is invalid.

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/router manager.

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

MprAdminInterfaceCreate, MprAdminInterfaceTransportSetInfo, MprAdminServerConnect