MprConfigTransportGetHandle function (mprapi.h)

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

Syntax

DWORD MprConfigTransportGetHandle(
  [in]  HANDLE hMprConfig,
  [in]  DWORD  dwTransportId,
  [out] HANDLE *phRouterTransport
);

Parameters

[in] hMprConfig

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

[in] dwTransportId

A DWORD value that describes the transport configuration handle type in the phRouterTransport parameter. Acceptable values for dwTransportId are listed in the following table.

Value	Transport (Protocol Family)
PID_ATALK	AppleTalk
PID_IP	Internet Protocol version 4
PID_IPX	Internet Packet Exchange
PID_NBF	NetBIOS Frames Protocol
PID_IPV6	Windows Server 2008 or later: Internet Protocol version 6

[out] phRouterTransport

A pointer to a
HANDLE variable that receives the transport configuration handle type indicated in the dwTransportId parameter.

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 and/or the phRouterTransport parameter is NULL.
ERROR_NOT_ENOUGH_MEMORY	Insufficient resources to complete the operation.
ERROR_UNKNOWN_PROTOCOL_ID	The transport protocol specified by dwTransportId was not found in the router configuration.
Other	Use FormatMessage to retrieve the system error message that corresponds to the error code returned.

Requirements

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

Router Configuration Functions

Router Management Reference