arm_get_correlator_flags(3)

1arm_get_correlator_flags(3)ARM 4 Programmer's Manualarm_get_correlator_flags(3)
2
3
4

NAME

6       arm_get_correlator_flags - get value of flag
7

SYNOPSIS

9       #include <arm4.h>
10
11       arm_error_t
12       arm_get_correlator_flags(
13           const arm_correlator_t *correlator,
14           const arm_int32_t corr_flag_num,
15           arm_boolean_t *flag);
16

DESCRIPTION

18       arm_get_correlator_flags() returns the value of a specified flag in the
19       correlator header.
20
21       A correlator header contains bit flags.  arm_get_correlator_flags()  is
22       used  to  test  the value of those flags. See arm_generate_correlator()
23       for a description of a correlator.
24
25       corr_flag_num is an enumerated value that indicates which flag's  value
26       is requested. The enumerated values are:
27
28              1 (ARM_CORR_FLAGNUM_APP_TRACE) = Application trace flag
29
30              2 (ARM_CORR_FLAGNUM_AGENT_TRACE) = Agent trace flag
31
32       correlator  is a pointer to a buffer containing a correlator. It serves
33       no purpose to make the call if the pointer is null.
34
35       flag is a pointer to a boolean that is output  indicating  whether  the
36       flag is set.
37

RETURN VALUE

39       On  success,  the  function returns ARM_SUCCESS. A non-zero value indi‐
40       cates an error.
41

ERRORS

43       If the return code is negative, an error occurred. If the  return  code
44       is not negative, an error may or may not have occurred - the determina‐
45       tion of what is an error and whether an error code is  returned  is  at
46       the  discretion of the ARM implementation. The application can test the
47       return code if it wants to provide its own error logging.
48
49       The following errors are recognized by this implementation, but may not
50       be portable to other implementations:
51
52
53       ARM_FAILURE_NULL_ARGUMENT
54              The correlator and flag arguments must not be null.
55
56       ARM_FAILURE_INVALID_ARGUMENT
57              An unknown flag value has been specified.
58

CONFORMING TO

60       ARM Issue 4.0 C Language Bindings, Version 2
61

EXAMPLE

63       None.
64