MprConfigTransportDelete

The MprConfigTransportDelete function removes the specified transport from the list of transports present in the specified router configuration.

DWORD MprConfigTransportDelete(
  HANDLE hMprConfig,       // handle to the router configuration
  HANDLE hRouterTransport  // handle to the transport configuration
);

Parameters

hMprConfig
[in] Handle to the router configuration from which to remove the transport. Obtain this handle by calling MprConfigServerConnect.
hRouterTransport
[in] Handle to the configuration for the transport being deleted. Obtain this handle by calling MprConfigTransportCreate or MprConfigTransportGetHandle.

Return Values

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 The hMprConfig parameter is NULL, or the hRouterTransport parameter is NULL, or both are NULL.
ERROR_NOT_ENOUGH_MEMORY Insufficient resources to complete the operation.
Other Use FormatMessage to retrieve the system error message that corresponds to the error code returned.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Mprapi.h.
  Library: Use Mprapi.lib.

See Also

Router Management Reference, Router Configuration Functions, FormatMessage, MprConfigServerConnect, MprConfigTransportCreate, MprConfigTransportGetHandle