MprAdminInterfaceSetCustomInfoEx function (mprapi.h)
Sets the tunnel specific custom configuration for a specified demand dial interface on a specified server.
Syntax
DWORD MprAdminInterfaceSetCustomInfoEx(
[in] MPR_SERVER_HANDLE hMprServer,
[in] HANDLE hInterface,
[in] PMPR_IF_CUSTOMINFOEX pCustomInfo
);
Parameters
[in] hMprServer
The handle to the router to query. This handle is obtained by a previous call to the MprAdminServerConnect function.
[in] hInterface
The handle to the interface. This handle is obtained by a previous call to the MprAdminInterfaceCreate function or the MprAdminInterfaceGetHandle function.
[in] pCustomInfo
A pointer to a MPR_IF_CUSTOMINFOEX structure that contains tunnel specific custom configuration.
Return value
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 |
|---|---|
|
The calling application does not have sufficient privileges. |
|
The hInterface value is not valid. |
|
The pCustomInfo parameter is NULL or the interface type is not ROUTER_IF_TYPE_FULL_ROUTER. |
|
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.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows Server 2012 [desktop apps only] |
| Target Platform | Windows |
| Header | mprapi.h |
| Library | Mprapi.lib |
| DLL | Mprapi.dll |