MprConfigInterfaceTransportRemove function (mprapi.h)

The MprConfigInterfaceTransportRemove function removes the specified transport from the specified interface configuration on the router.

Syntax

DWORD MprConfigInterfaceTransportRemove(
  [in] HANDLE hMprConfig,
  [in] HANDLE hRouterInterface,
  [in] HANDLE hRouterIfTransport
);

Parameters

[in] hMprConfig

Handle to the router configuration. The handle is obtained from a previous call to MprConfigServerConnect.

[in] hRouterInterface

Handle to the interface configuration from which to delete the specified transport. Obtain this handle by calling MprConfigInterfaceCreate, MprConfigInterfaceGetHandle, or MprConfigInterfaceEnum.

[in] hRouterIfTransport

Handle to the interface transport configuration to be deleted. Obtain this handle by calling MprConfigInterfaceTransportAdd, MprConfigInterfaceTransportGetHandle, or MprConfigInterfaceTransportEnum. Supported transport protocol types are listed on Transport Identifiers.

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_INVALID_PARAMETER
One of the following is true:
  • hMprConfig is NULL.
  • hRouterInterface is NULL.
  • phRouterIfTransport is NULL.
Other
Use FormatMessage to retrieve the system error message that corresponds to the error code returned.
 
 

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

FormatMessage

MprConfigInterfaceCreate

MprConfigInterfaceEnum

MprConfigInterfaceGetHandle

MprConfigInterfaceTransportAdd

MprConfigInterfaceTransportEnum

MprConfigInterfaceTransportGetHandle

MprConfigServerConnect

Router Configuration Functions

Router Management Reference