MprAdminInterfaceTransportAdd

[This is preliminary documentation and subject to change.]

The MprAdminInterfaceTransportAdd function adds a transport (for example, IP or IPX) to an specified interface.

DWORD  MprAdminInterfaceTransportAdd(
  MPR_SERVER_HANDLE hMprServer,    // handle to the router
  HANDLE hInterface,               // handle to the interface
  DWORD dwTransportlId,            // transport/router manager ID
  LPBYTE pInterfaceInfo,           // interface information
  DWORD dwInterfaceInfoSize        // size of interface information
);

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 to which to add the transport. This handle is obtained by a previous call to MprAdminInterfaceCreate.

dwTransportId

Identifies the transport to add to the interface.

pInterfaceInfo

Pointer to a buffer containing interface information for this transport.

dwInterfaceInfoSize

The size, in bytes, of the information pointed to by pInterfaceInfo.

Remarks

Note that the dwTransportId parameter also specifies a unique router manager, since Windows NT router uses a different router manager for each transport.

Return Values

NO_ERROR

The interface was added successfully.

ERROR_ACCESS_DENIED

The caller does not have sufficient privilege.

ERROR_INVALID_HANDLE

The hInterface value is invalid.

ERROR_INVALID_PARAMETER

The pInterfaceInfo parameter is NULL.

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, MprAdminInterfaceTransportRemove, MprAdminServerConnect