arm_stop_application(3)

1arm_stop_application(3)    ARM 4 Programmer's Manual   arm_stop_application(3)
2
3
4

NAME

6       arm_stop_application - stop application
7

SYNOPSIS

9       #include <arm4.h>
10
11       arm_error_t
12       arm_stop_application(
13           const arm_app_start_handle_t app_handle,
14           const arm_int32_t flags,
15           const arm_buffer4_t *buffer4);
16

DESCRIPTION

18       arm_stop_application() indicates that the application instance has fin‐
19       ished making ARM calls. It typically means that the instance is ending,
20       such  as  just prior to the process exiting or a thread that represents
21       an application instance terminating.
22
23       For any transactions that are still in-process [arm_start_transaction()
24       executed   without  a  matching  arm_stop_transaction()],  an  implicit
25       arm_discard_transaction() is executed.
26
27       If the arm_start_application() used the system  address  sub-buffer  to
28       indicate that the ARM calls would be about an application instance on a
29       different system, arm_stop_application() indicates that no  more  calls
30       about that application instance and its transactions will be made.
31
32       After executing arm_stop_application(), no further calls should be made
33       for this application, including calls for transactions created by  this
34       application,   until   a   new  instance  "session"  is  started  using
35       arm_start_application(). Data from any other calls that are  made  will
36       be  ignored.   This  function is the equivalent of the ARM 2.0 function
37       arm_end().
38
39       app_handle  is  a  handle  returned  in  an  out  parameter   from   an
40       arm_start_application() call in the same process.
41
42       buffer4 is a pointer to the user data buffer, if any. If the pointer is
43       null, there is no buffer. No sub-buffer types are currently valid  with
44       this function call, so the pointer should be null (ARM_BUF4_NONE).
45
46       flags contains 32-bit flags. No values are currently defined. The field
47       should be zero (ARM_FLAG_NONE).
48
49

RETURN VALUE

51       On success, the function returns ARM_SUCCESS. A  non-zero  value  indi‐
52       cates an error.
53

ERRORS

55       If  the  return code is negative, an error occurred. If the return code
56       is not negative, an error may or may not have occurred - the determina‐
57       tion  of  what  is an error and whether an error code is returned is at
58       the discretion of the ARM implementation. The application can test  the
59       return code if it wants to provide its own error logging.
60
61       The following errors are recognized by this implementation, but may not
62       be portable to other implementations:
63
64
65       ARM_FAILURE_INTERNAL_ERROR
66              An internal error has occurred that prevented the operation from
67              completing. Check your system log for more details.
68

CONFORMING TO

70       ARM Issue 4.0 C Language Bindings, Version 2
71

EXAMPLE

73       None.
74