MprConfigInterfaceGetCustomInfoEx function (mprapi.h)

Retrieves the custom IKEv2 policy configuration for the specified interface.

Syntax

DWORD MprConfigInterfaceGetCustomInfoEx(
  [in]  HANDLE               hMprConfig,
  [in]  HANDLE               hRouterInterface,
  [out] PMPR_IF_CUSTOMINFOEX pCustomInfo
);

Parameters

[in] hMprConfig

The handle to the router configuration. This handle is obtained by calling the MprConfigServerConnect function.

[in] hRouterInterface

The handle to the interface configuration being updated. Obtain this handle by calling the MprConfigInterfaceCreate function, the MprConfigInterfaceGetHandle function, or the MprConfigInterfaceEnum function.

[out] pCustomInfo

A pointer to a MPR_IF_CUSTOMINFOEX structure. When you have finished using the structure, free the buffer by calling the MprConfigBufferFree function.

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
ERROR_INVALID_PARAMETER	At least one of the following is true: The hMprConfig parameter is NULL. The hRouterInterface parameter is NULL. The pCustomInfo parameter is NULL.
ERROR_NOT_ENOUGH_MEMORY	There were insufficient resources to complete the operation.
ERROR_NO_SUCH_INTERFACE	The interface that corresponds to hRouterInterface parameter is not present in the router configuration.

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

See also

Router Configuration Functions

Router Management Reference