MprConfigInterfaceTransportGetHandle function (mprapi.h)
The MprConfigInterfaceTransportGetHandle function retrieves a handle to the transport configuration of an interface in the specified router configuration.
Syntax
DWORD MprConfigInterfaceTransportGetHandle(
[in] HANDLE hMprConfig,
[in] HANDLE hRouterInterface,
[in] DWORD dwTransportId,
[out] HANDLE *phRouterIfTransport
);
Parameters
[in] hMprConfig
Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.
[in] hRouterInterface
Handle to the interface configuration. Obtain this handle by calling MprConfigInterfaceCreate, MprConfigInterfaceGetHandle, or MprConfigInterfaceEnum.
[in] dwTransportId
A DWORD value that describes the transport configuration handle type in the phRouterIfTransport 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] phRouterIfTransport
A pointer to a
HANDLE variable that receives the transport configuration handle type for this interface 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 |
|---|---|
|
At least one of the following is true:
|
|
Insufficient resources to complete the operation. |
|
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. |
|
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 |