MprConfigInterfaceTransportSetInfo function (mprapi.h)

Article
10/13/2021

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

Syntax

DWORD MprConfigInterfaceTransportSetInfo(
  [in]           HANDLE hMprConfig,
  [in]           HANDLE hRouterInterface,
  [in]           HANDLE hRouterIfTransport,
  [in, optional] LPBYTE pInterfaceInfo,
  [in, optional] DWORD  dwInterfaceInfoSize
);

Parameters

[in] hMprConfig

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

[in] hRouterInterface

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

[in] hRouterIfTransport

Handle to the transport configuration in which to update the information for the client. Obtain this handle by calling MprConfigInterfaceTransportAdd, MprConfigInterfaceTransportGetHandle, or MprConfigInterfaceTransportEnum. Supported transport protocol types are listed on Transport Identifiers.

[in, optional] pInterfaceInfo

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.

[in, optional] dwInterfaceInfoSize

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 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
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 hRouterInterface 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

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