The MprConfigInterfaceTransportGetInfo function retrieves the configuration information for the specified client on the specified interface.
DWORD MprConfigInterfaceTransportGetInfo( HANDLE hMprConfig, // handle to the router configuration HANDLE hRouterInterface, // handle to the interface configuration HANDLE hRouterIfTransport, // handle to the transport configuration LPBYTE *ppInterfaceInfo, // configuration information for interface // and interface LPDWORD lpdwInterfaceInfoSize // size of interface transport information );
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.
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.
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 |
---|---|
ERROR_INVALID_PARAMETER | One of the following is true:
|
ERROR_NO_SUCH_INTERFACE | The interface specified by hRouterInterface was not found in the router configuration, or the transport specified by hRouterIfTransport was not enabled on the specified interface. |
ERROR_NOT_ENOUGH_MEMORY | Insufficient resources to complete the operation. |
Other | Use FormatMessage to retrieve the system error message that corresponds to the error code returned. |
If the ppInterfaceInfo parameter is NULL, MprConfigInterfaceTransportGetInfo does nothing and returns immediately with a value of NO_ERROR.
Windows NT/2000: Requires Windows 2000.
Header: Declared in Mprapi.h.
Library: Use Mprapi.lib.
Router Management Reference, Router Configuration Functions, FormatMessage, MPR_IFTRANSPORT_0, MprConfigBufferFree, MprConfigInterfaceCreate, MprConfigInterfaceEnum, MprConfigInterfaceGetHandle, MprConfigInterfaceTransportEnum, MprConfigInterfaceTransportGetHandle, MprConfigServerConnect