MprConfigTransportGetHandle

[This is preliminary documentation and subject to change.]

The MprConfigTransportGetHandle function retrieves a handle to the specified transport's configuration in the specified router configuration.

DWORD  MprConfigTransportGetHandle(
  HANDLE hMprConfig,            // handle to the router configuration
  DWORD dwTransportId,          // transport identifier
  HANDLE * phRouterTransport    // handle to the transport's configuration
);

Parameters

hMprConfig

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

dwTransportId

Identifies the transport for which to retrieve the configuration.

phRouterTransport

Pointer to a handle variable. On successful return, this variable will contain a handle to the specified transport's configuration.

Return Values

NO_ERROR

Success.

ERROR_INVALID_PARAMETER

The hMprConfig parameter and/or the phRouterTransport parameter is NULL.

ERROR_NOT_ENOUGH_MEMORY

Insufficient resources to complete the operation.

ERROR_UNKNOWN_PROTOCOL_ID

The transport specified by dwTransportId was not found in the router configuration.

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