NAME

arm_get_correlator_flags - get value of flag

SYNOPSIS

#include <arm4.h>

arm_error_t
arm_get_correlator_flags(

 const arm_correlator_t *
correlator

 const arm_int32_t 
corr_flag_num

 arm_boolean_t *
flag);

DESCRIPTION

arm_get_correlator_flags() returns the value of a specified flag in the correlator header.

A correlator header contains bit flags. arm_get_correlator_flags() is used to test the value of those flags. See arm_generate_correlator() for a description of a correlator.

corr_flag_num is an enumerated value that indicates which flag's value is requested. The enumerated values are:

1 (ARM_CORR_FLAGNUM_APP_TRACE) = Application trace flag
2 (ARM_CORR_FLAGNUM_AGENT_TRACE) = Agent trace flag correlator is a pointer to a buffer containing a correlator. It serves no purpose to make the call if the pointer is null.

flag is a pointer to a boolean that is output indicating whether the flag is set.

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.

The following errors are recognized by this implementation, but may not be portable to other implementations:

ARM_FAILURE_NULL_ARGUMENT
The correlator and flag arguments must not be null.
ARM_FAILURE_INVALID_ARGUMENT
An unknown flag value has been specified.

CONFORMING TO

ARM Issue 4.0 C Language Bindings, Version 2

EXAMPLE

None.

SEE ALSO

arm_generate_correlator(3), arm_start_transaction(3)