MprAdminInterfaceTransportRemove function (mprapi.h)
The MprAdminInterfaceTransportRemove function removes a transport (for example, IP or IPX) from a specified interface.
Syntax
DWORD MprAdminInterfaceTransportRemove(
[in] MPR_SERVER_HANDLE hMprServer,
[in] HANDLE hInterface,
[in] DWORD dwTransportId
);
Parameters
[in] hMprServer
Handle to the router from which the transport is being removed. Obtain this handle by calling MprAdminServerConnect.
[in] hInterface
Handle to the interface from which the transport is being removed. Obtain this handle by calling MprAdminInterfaceCreate.
[in] dwTransportId
A DWORD value that describes the transport type to remove. 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 |
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 |
---|---|
|
The calling application does not have sufficient privileges. |
|
The interface specified is a demand-dial interface and is currently connected. |
|
The hInterface value is invalid. |
|
The specified transport is not running on the specified interface. |
|
The dwTransportId value does not match any supported transport. |
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 |