Skip to content

Latest commit

 

History

History
189 lines (128 loc) · 6.08 KB

nf-mprapi-mprconfiginterfacetransportsetinfo.md

File metadata and controls

189 lines (128 loc) · 6.08 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:mprapi.MprConfigInterfaceTransportSetInfo
MprConfigInterfaceTransportSetInfo function (mprapi.h)
The MprConfigInterfaceTransportSetInfo function updates the configuration information for the client on the specified interface and transport protocol.
MprConfigInterfaceTransportSetInfo
MprConfigInterfaceTransportSetInfo function [RAS]
_mpr_mprconfiginterfacetransportsetinfo
mprapi/MprConfigInterfaceTransportSetInfo
rras.mprconfiginterfacetransportsetinfo
rras\mprconfiginterfacetransportsetinfo.htm
RRAS
1f46b528-d9a1-4967-afa2-424ee1eebbcb
12/05/2018
MprConfigInterfaceTransportSetInfo, MprConfigInterfaceTransportSetInfo function [RAS], _mpr_mprconfiginterfacetransportsetinfo, mprapi/MprConfigInterfaceTransportSetInfo, rras.mprconfiginterfacetransportsetinfo
mprapi.h
Windows
None supported
Windows 2000 Server [desktop apps only]
Mprapi.lib
Mprapi.dll
Windows
19H1
MprConfigInterfaceTransportSetInfo
mprapi/MprConfigInterfaceTransportSetInfo
c++
APIRef
kbSyntax
DllExport
Mprapi.dll
MprConfigInterfaceTransportSetInfo

MprConfigInterfaceTransportSetInfo function

-description

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

-parameters

-param hMprConfig [in]

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

-param hRouterInterface [in]

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

-param hRouterIfTransport [in]

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.

-param pInterfaceInfo [in, optional]

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.

-param dwInterfaceInfoSize [in, optional]

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.

-returns

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.

-see-also

FormatMessage

MprConfigInterfaceCreate

MprConfigInterfaceEnum

MprConfigInterfaceGetHandle

MprConfigInterfaceTransportEnum

MprConfigInterfaceTransportGetHandle

MprConfigServerConnect

Router Configuration Functions

Router Management Reference