MprConfigInterfaceTransportGetHandle

The MprConfigInterfaceTransportGetHandle function retrieves a handle to the specified transport configuration on the specified interface in the specified router configuration.

DWORD MprConfigInterfaceTransportGetHandle(
  HANDLE hMprConfig,           // handle to the router configuration
  HANDLE hRouterInterface,     // handle to the interface configuration
  DWORD dwTransportId,         // identifier of the transport configuration
  HANDLE *phRouterIfTransport  // handle to the transport configuration
);

Parameters

hMprConfig
[in] Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.
hRouterInterface
[in] Handle to the interface configuration. Obtain this handle by calling MprConfigInterfaceCreate, MprConfigInterfaceGetHandle, or MprConfigInterfaceEnum.
dwTransportId
[in] Specifies the transport configuration.
phRouterIfTransport
[out] Pointer to a handle variable. This variable receives a handle to the transport configuration for this interface.

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 At least one of the following is true:
  • hMprConfig is NULL.
  • hRouterInterface is NULL.
  • phRouterIfTransport is NULL.
ERROR_NOT_ENOUGH_MEMORY Insufficient resources to complete the operation.
ERROR_NO_SUCH_INTERFACE The interface specified by hRouterInterface was not found in the router configuration, or the transport specified by dwTransportId was not enabled on the specified interface.
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, MprConfigInterfaceCreate, MprConfigInterfaceEnum, MprConfigInterfaceGetHandle, MprConfigServerConnect