arm_destroy_application (3) - Linux Manuals

arm_destroy_application: destroy application data

NAME

arm_destroy_application - destroy application data

SYNOPSIS

#include <arm4.h>

arm_error_t
arm_destroy_application(

 const arm_id_t *app_id, 

 const arm_int32_t flags,

 const arm_buffer4_t *buffer4);

DESCRIPTION

arm_destroy_application() indicates that the registration data about an application previously registered with arm_register_application() is no longer needed.
  The purpose of this call is to signal the ARM implementation so it can release any storage it is holding. Ending a process or unloading the ARM library results in an implicit arm_destroy_application() for any previously registered applications.
  It is possible for multiple arm_register_application() calls to be made in the same process with identical identity data. When this is done, arm_destroy_application() is assumed to be paired with one arm_register_application(). For example, if arm_register_application() is executed twice with the same output ID, and arm_destroy_application() is executed once using this ID, it is assumed that an instance of the application is still active and it is not safe to discard the application registration data associated with the ID.

app_id is an application ID returned from an arm_register_application() call in the same process.

No sub-buffer types are currently valid with this function call, so the buffer4 pointer should be null (ARM_BUF4_NONE).

No values are currently defined for flags. The field should be zero (ARM_FLAG_NONE).

RETURN VALUE

On success, the function returns ARM_SUCCESS. A non-zero value indicates an error.

ERRORS

If the return code is negative, an error occurred. If the return code is not negative, an error may or may not have occurred - the determination of what is an error and whether an error code is returned is at the discretion of the ARM implementation. The application can test the return code if it wants to provide its own error logging.

This implementation returns no errors for arm_destroy_application().

CONFORMING TO

ARM Issue 4.0 C Language Bindings, Version 2

EXAMPLE

None.