MprConfigInterfaceTransportSetInfo

[This is preliminary documentation and subject to change.]

The MprConfigInterfaceTransportSetInfo function updates the configuration information for the specified transport and interface.

DWORD  MprConfigInterfaceTransportSetInfo(
  HANDLE hMprConfig,            // handle to the router configuration
  HANDLE hRouterInterface,      // handle to the interface configuration
  HANDLE hRouterIfTransport,    // handle to the transport configuration
  LPBYTE pInterfaceInfo,        // interface transport information
  DWORD dwInterfaceInfoSize     // size of interface transport information
);

Parameters

hMprConfig

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

hRouterInterface

Handle to the interface configuration in which to update the information. Obtain this handle by calling MprConfigInterfaceCreate, or MprConfigInterfaceEnum.

hRouterIfTransport

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

pInterfaceInfo

Pointer to the interface transport information.

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

dwInterfaceInfoSize

Specifies the size, in bytes, of the data pointed to by pInterfaceInfo.

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

Return Values

NO_ERROR

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

ERROR_INVALID_PARAMETER

At least one of the following is true:

hMprConfig is NULL.

hRouterInterface is NULL.

hRouterIfTransport is NULL.

ERROR_NO_SUCH_INTERFACE

The interface specified by hRouterInterface is no longer present in the router configuration, or the transport specified by hRouterIfTransport is no longer present on the interface.

Other

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

Remarks

If the pInterfaceInfo parameter is NULL, MprConfigInterfaceTransportSetInfo 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, MprConfigInterfaceCreate, MprConfigInterfaceEnum, MprConfigInterfaceGetHandle, MprConfigServerConnect, MprConfigInterfaceTransportEnum, MprConfigInterfaceTransportGetHandle