Skip to content

Latest commit

 

History

History
138 lines (111 loc) · 4.32 KB

nf-mprapi-mpradmininterfacesetcustominfoex.md

File metadata and controls

138 lines (111 loc) · 4.32 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.MprAdminInterfaceSetCustomInfoEx
MprAdminInterfaceSetCustomInfoEx function (mprapi.h)
Sets the tunnel specific custom configuration for a specified demand dial interface on a specified server.
MprAdminInterfaceSetCustomInfoEx
MprAdminInterfaceSetCustomInfoEx function [RAS]
mprapi/MprAdminInterfaceSetCustomInfoEx
rras.mpradmininterfacesetcustominfoex
rras\mpradmininterfacesetcustominfoex.htm
RRAS
306d9d6c-6196-4a1f-8549-f8dd0fb5ab6f
12/05/2018
MprAdminInterfaceSetCustomInfoEx, MprAdminInterfaceSetCustomInfoEx function [RAS], mprapi/MprAdminInterfaceSetCustomInfoEx, rras.mpradmininterfacesetcustominfoex
mprapi.h
Windows
None supported
Windows Server 2012 [desktop apps only]
Mprapi.lib
Mprapi.dll
Windows
19H1
MprAdminInterfaceSetCustomInfoEx
mprapi/MprAdminInterfaceSetCustomInfoEx
c++
APIRef
kbSyntax
DllExport
Mprapi.dll
MprAdminInterfaceSetCustomInfoEx

MprAdminInterfaceSetCustomInfoEx function

-description

Sets the tunnel specific custom configuration for a specified demand dial interface on a specified server.

-parameters

-param hMprServer [in]

The handle to the router to query. This handle is obtained by a previous call to the MprAdminServerConnect function.

-param hInterface [in]

The handle to the interface. This handle is obtained by a previous call to the MprAdminInterfaceCreate function or the MprAdminInterfaceGetHandle function.

-param pCustomInfo [in]

A pointer to a MPR_IF_CUSTOMINFOEX structure that contains tunnel specific custom configuration.

-returns

If the function succeeds, the return value is NO_ERROR. If the function fails, the return value is one of the following error codes.

Return code Description
ERROR_ACCESS_DENIED
The calling application does not have sufficient privileges.
ERROR_INVALID_HANDLE
The hInterface value is not valid.
ERROR_INVALID_PARAMETER
The pCustomInfo parameter is NULL or the interface type is not ROUTER_IF_TYPE_FULL_ROUTER.
ERROR_NOT_ENOUGH_MEMORY
There were insufficient resources to complete the operation.

-remarks

If you need to delete the custom configuration for IKEv2 tunnel of an interface, call the MprAdminInterfaceSetCustomInfoEx function with the dwFlags member of the MPR_IF_CUSTOMINFOEX structure set to zero.

If you need to delete the IKEv2 main mode and quick mode policy configuration for an interface, set the customPolicy parameter of the customIkev2Config member in MPR_IF_CUSTOMINFOEX structure to NULL.

If you need to delete the certificate configured to be used during IKEv2 main mode SA negotiation, set the cbData member of certificateName in customIkev2Config member of MPR_IF_CUSTOMINFOEX structure to 0.

-see-also

Router Administration Functions

Router Management Reference