ddpi_access_term operation

The ddpi_access_term operation terminates a given Ddpi_Access object and calls ddpi_elf_term to terminate Ddpi_Elf objects referred to in the Ddpi_Access object.

Description

If ddpi_elf_term gives an unexpected return code, the return code and error will be returned to the caller of ddpi_access_term.

Note: If an error occurs in ddpi_elf_term, the remaining portions of the Ddpi_Elf list and the Ddpi_Access object are not deleted so that ddpi_access_term can be called again if the error is resolved. The ddpi_access_term operation does not call libdwarf to terminate the Dwarf_Debug object.

Prototype

int ddpi_access_term(
  Ddpi_Access           access,
  Ddpi_Error*           error);             

Parameters

access
Input. This accepts the Ddpi_Access object.
error
See The libddpi error parameter.

Return values

DW_DLV_OK
Returned upon successful termination of the Ddpi_Access object.
DW_DLV_NO_ENTRY
Returned if access does not match the access referred to in its parent.
DW_DLV_ERROR
This value is returned if:
  • access or its associated information is NULL
  • An error occurs while terminating child descriptors
  • An error during memory allocation.