MprConfigInterfaceTransportGetInfo

[This is preliminary documentation and subject to change.]

The MprConfigInterfaceTransportGetInfo function retrieves the configuration information for the specified transport and 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,         // interface transport information
  LPDWORD lpdwInterfaceInfoSize    // size of interface transport information
);

Parameters

hMprConfig

Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.

hRouterInterface

Handle to the interface configuration from which to retrieve the specified transport information. Obtain this handle by calling MprConfigInterfaceCreate, MprConfigInterfaceGetHandle, or MprConfigInterfaceEnum.

hRouterIfTransport

Handle to the interface transport configuration from which to retrieve the information. Obtain this handle by calling MprConfigInterfaceTransportGetHandle, or MprConfigInterfaceTransportEnum.

ppInterfaceInfo

Pointer to a pointer variable. On successful return, this pointer variable points to the interface transport information. Free this memory by calling MprConfigBufferFree.

This parameter is optional. If the caller specifies NULL for this parameter, the function will not return the interface transport information.

lpdwInterfaceInfoSize

Pointer to a DWORD variable. On successful return, this variable contains the size, in bytes, of the data pointed to by *ppInterfaceInfo.

This parameter is optional; the caller may specify NULL for this parameter. However, if ppInterfaceInfo is not NULL, this parameter cannot be NULL (see Remarks section).

Return Values

NO_ERROR

The interface transport information was retrieved successfully. (Also, see Remarks section below.)

ERROR_INVALID_PARAMETER

One of the following is true:

hMprConfig is NULL.

hRouterInterface is NULL.

hRouterIfTransport is NULL.

ppInterfaceInfo is not NULL, but lpdwInterfaceInfoSize 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 hRouterIfTransport was not enabled on the specified interface.

Other

Use FormatMessage to retrieve the system error message corresponding to the error code returned.

Remarks

If the ppInterfaceInfo parameter is NULL, MprConfigInterfaceTransportGetInfo does nothing, and returns immediately with a value of NO_ERROR.

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, MprConfigBufferFree, MprConfigInterfaceCreate, MprConfigInterfaceEnum, MprConfigInterfaceGetHandle, MprConfigServerConnect, MprConfigInterfaceTransportEnum, MprConfigInterfaceTransportGetHandle, MPR_IFTRANSPORT_0