MprConfigInterfaceTransportGetHandle
[This is preliminary documentation and subject to change.]
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
-
Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.
-
hRouterInterface
-
Handle to the interface configuration. Obtain this handle by calling MprConfigInterfaceCreate, MprConfigInterfaceGetHandle, or MprConfigInterfaceEnum.
-
dwTransportId
-
Identifies the transport configuration.
-
phRouterIfTranport
-
Pointer to a handle variable. On successful return, this variable contains a handle to the transport configuration for this interface.
Return Values
-
NO_ERROR
-
A handle to the interface transport configuration was returned successfully.
-
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 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, MprConfigInterfaceCreate, MprConfigInterfaceEnum, MprConfigInterfaceGetHandle, MprConfigServerConnect