MprConfigInterfaceTransportSetInfo

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

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,      // configuration information for transport 
                              // and interface
  DWORD dwInterfaceInfoSize   // size of configuration information
);

Parameters

hMprConfig
[in] Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.
hRouterInterface
[in] Handle to the interface configuration in which to update the information. Obtain this handle by calling MprConfigInterfaceCreate or MprConfigInterfaceEnum.
hRouterIfTransport
[in] Handle to the transport configuration in which to update the information for the client. Obtain this handle by calling MprConfigInterfaceTransportGetHandle or MprConfigInterfaceTransportEnum.
pInterfaceInfo
[in] Pointer to an information header that contains configuration information for the client on the specified interface and transport. The router manager for the specified transport interprets this information. Use the Information Header Functions to manipulate information headers.

This parameter is optional. If the calling application specifies NULL for this parameter, the function does not update the configuration information for the client.

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

This parameter is optional; the calling application may specify zero for this parameter. However, if pInterfaceInfo is not NULL, this parameter cannot be zero. For more information, see the Remarks section later in this topic.

Return Values

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 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 that corresponds to the error code returned.

Remarks

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

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Mprapi.h.
  Library: Use Mprapi.lib.

See Also

Router Management Reference, Router Configuration Functions, FormatMessage, MprConfigInterfaceCreate, MprConfigInterfaceEnum, MprConfigInterfaceGetHandle, MprConfigInterfaceTransportEnum, MprConfigInterfaceTransportGetHandle, MprConfigServerConnect