Edit

MprAdminInterfaceTransportGetInfo function (mprapi.h)

  • Article

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

Syntax

DWORD MprAdminInterfaceTransportGetInfo(
  [in]            MPR_SERVER_HANDLE hMprServer,
  [in]            HANDLE            hInterface,
  [in]            DWORD             dwTransportId,
  [out]           LPBYTE            *ppInterfaceInfo,
  [out, optional] LPDWORD           lpdwInterfaceInfoSize
);

Parameters

[in] hMprServer

Handle to the router from which information is being retrieved. Obtain this handle by calling MprAdminServerConnect.

[in] hInterface

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

[in] dwTransportId

A DWORD value that describes the transport for which information is requested. Acceptable values for dwTransportId are listed in the following table.

Value Transport (Protocol Family)
PID_ATALK AppleTalk
PID_IP Internet Protocol version 4
PID_IPX Internet Packet Exchange
PID_NBF NetBIOS Frames Protocol
PID_IPV6 Windows Server 2008 or later: Internet Protocol version 6

[out] ppInterfaceInfo

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. Free this memory by calling MprAdminBufferFree.

[out, optional] lpdwInterfaceInfoSize

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 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_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 supported transports.

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

MprAdminInterfaceCreate

MprAdminInterfaceTransportSetInfo

MprAdminServerConnect

Router Administration Functions

Router Management Reference