Open topic with navigation CAPL Functions » TCP/IP API » ipsecAssociationRelease

ipsecAssociationRelease

Valid for: CANoe DE • CANoe4SW DE Note

The function is dependent on the selected stack.
It is not possible to modify the security association database of the operating system TCP/IP stack.

Function Syntax

long ipsecAssociationRelease(long association);

Description

Release a security association record object. The association handle is invalid after calling this function. A security association record can be created with ipsecAssociationInit or with ipsecAssociationDatabaseGetSpi.

Parameters

association: Handle to an association object.

Return Values

0: Success
-1: Failed

Example

on start
{
  long association;

  // create and init a security association record
  association = ipsecAssociationInit(ip_Endpoint(192.168.1.1), ip_Endpoint(192.168.1.10), "ah", "any", 30000);

  // ... do something with the association ...
  // release the association object when it isn't needed anymore
  ipsecAssociationRelease(association);
}