MprConfigInterfaceTransportRemove

[This is preliminary documentation and subject to change.]

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

DWORD  MprConfigInterfaceTransportRemove(
  HANDLE hMprConfig,           // handle to the router configuration
  HANDLE hRouterInterface,     // handle to the interface configuration
  HANDLE hRouterIfTransport    // handle to the transport configuration
);

Parameters

hMprConfig

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

hRouterInterface

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

hRouterIfTransport

Handle to the interface transport configuration to be deleted. Obtain this handle by calling MprConfigInterfaceTransportAdd, MprConfigInterfaceTransportGetHandle, or MprConfigInterfaceTransportEnum.

Return Values

NO_ERROR

The transport configuration was removed successfully.

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 corresponding to the error code returned.

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

FormatMessage, MprConfigInterfaceCreate, MprConfigInterfaceEnum, MprConfigInterfaceGetHandle, MprConfigInterfaceTransportAdd, MprConfigInterfaceTransportEnum, MprConfigInterfaceTransportGetHandle, MprConfigServerConnect