MprConfigInterfaceTransportGetInfo function (mprapi.h)
The MprConfigInterfaceTransportGetInfo function retrieves the configuration information for the specified client on the specified interface.
Syntax
DWORD MprConfigInterfaceTransportGetInfo(
[in] HANDLE hMprConfig,
[in] HANDLE hRouterInterface,
[in] HANDLE hRouterIfTransport,
[in, out, optional] LPBYTE *ppInterfaceInfo,
[out, optional] LPDWORD lpdwInterfaceInfoSize
);
Parameters
[in] hMprConfig
Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.
[in] hRouterInterface
Handle to the interface configuration from which to retrieve the specified client information. Obtain this handle by calling MprConfigInterfaceCreate, MprConfigInterfaceGetHandle, or MprConfigInterfaceEnum.
[in] hRouterIfTransport
Handle to the transport configuration from which to retrieve the specified client information. Obtain this handle by calling MprConfigInterfaceTransportAdd, MprConfigInterfaceTransportGetHandle, or MprConfigInterfaceTransportEnum. Supported transport protocol types are listed on Transport Identifiers.
[in, out, optional] ppInterfaceInfo
On input, pointer to a pointer variable.
On output, this pointer variable points to an information header that contains configuration information for the client. Use the Information Header Functions to manipulate information headers. Free this memory by calling MprConfigBufferFree.
This parameter is optional. If the calling application specifies NULL for this parameter, the function does not return the configuration information.
[out, optional] lpdwInterfaceInfoSize
Pointer to a DWORD variable. This variable receives the size, in bytes, of the data pointed to by ppInterfaceInfo.
This parameter is optional; the calling application may specify NULL for this parameter. However, if ppInterfaceInfo is not NULL, this parameter cannot be NULL. For more information, see the Remarks section later in this topic.
Return value
If the function succeeds, the return value is NO_ERROR. For more information, see the Remarks section later in this topic.
If the function fails, the return value is one of the following error codes.
| Value | Meaning |
|---|---|
|
One of the following is true:
|
|
The interface specified by hRouterIfTransport was not found in the router configuration, or the transport specified by hRouterIfTransport was not enabled on the specified interface. |
|
Insufficient resources to complete the operation. |
|
Use FormatMessage to retrieve the system error message that corresponds to the error code returned. |
Remarks
If the ppInterfaceInfo parameter is NULL, MprConfigInterfaceTransportGetInfo does nothing and returns immediately with a value of NO_ERROR.
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
MprConfigInterfaceTransportEnum
MprConfigInterfaceTransportGetHandle