MprConfigTransportDelete function (mprapi.h)

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

Syntax

DWORD MprConfigTransportDelete(
  [in] HANDLE hMprConfig,
  [in] HANDLE hRouterTransport
);

Parameters

[in] hMprConfig

Handle to the router configuration from which to remove the transport. Obtain this handle by calling MprConfigServerConnect.

[in] hRouterTransport

Handle to the configuration for the transport being deleted. Obtain this handle by calling MprConfigTransportCreate or MprConfigTransportGetHandle.

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
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

   
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

MprConfigServerConnect

MprConfigTransportCreate

MprConfigTransportGetHandle

Router Configuration Functions

Router Management Reference