MprAdminInterfaceTransportRemove

[This is preliminary documentation and subject to change.]

The MprAdminInterfaceTransportRemove function removes a transport (for example, IP or IPX) from an specified interface.

DWORD  MprAdminInterfaceTransportRemove(
  MPR_SERVER_HANDLE hMprServer,    // handle to router
  HANDLE hInterface,               // handle to interface
  DWORD dwTransportlId             // transport/router manager ID
);

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 from which to remove the transport. Obtain this handle by calling MprAdminInterfaceCreate.

dwTransportId

Identifies the transport to remove from the interface.

Return Values

NO_ERROR

The interface was removed successfully.

ERROR_ACCESS_DENIED

The caller does not have sufficient privilege.

ERROR_INTERFACE_CONNECTED

The interface specified is a demand dial interface and is currently connected.

ERROR_INVALID_HANDLE

The hInterface value is invalid.

ERROR_NO_SUCH_INTERFACE

The specified transport is not running on the specified interface.

ERROR_UNKNOWN_PROTOCOL_ID

The dwTransportId value does not match any installed transport.

Remarks

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

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