| 1 | .\" Copyright (c) 2005-2008 David Carter <dcarter@arm4.org> and others. |
|---|
| 2 | .\" All rights reserved. This program and the accompanying materials |
|---|
| 3 | .\" are made available under the terms of the Eclipse Public License v1.0 |
|---|
| 4 | .\" which accompanies this distribution, and is available at |
|---|
| 5 | .\" http://www.eclipse.org/legal/epl-v10.html |
|---|
| 6 | .TH "arm_get_correlator_flags" 3 "August 2008" "arm4.org" "ARM 4 Programmer's Manual" |
|---|
| 7 | .SH NAME |
|---|
| 8 | arm_get_correlator_flags \- get value of flag |
|---|
| 9 | .SH SYNOPSIS |
|---|
| 10 | .B #include <arm4.h> |
|---|
| 11 | .sp |
|---|
| 12 | \fBarm_error_t |
|---|
| 13 | .br |
|---|
| 14 | arm_get_correlator_flags( |
|---|
| 15 | .br |
|---|
| 16 | const arm_correlator_t *\fIcorrelator\fB, |
|---|
| 17 | .br |
|---|
| 18 | const arm_int32_t \fIcorr_flag_num\fB, |
|---|
| 19 | .br |
|---|
| 20 | arm_boolean_t *\fIflag\fB);\fR |
|---|
| 21 | .SH DESCRIPTION |
|---|
| 22 | \fBarm_get_correlator_flags()\fR returns the value of a specified flag in the correlator header. |
|---|
| 23 | |
|---|
| 24 | A correlator header contains bit flags. \fBarm_get_correlator_flags()\fR is used to test the value of |
|---|
| 25 | those flags. See \fBarm_generate_correlator()\fR for a description of a correlator. |
|---|
| 26 | |
|---|
| 27 | \fIcorr_flag_num\fR is an enumerated value that indicates which flag's value is requested. The |
|---|
| 28 | enumerated values are: |
|---|
| 29 | .IP |
|---|
| 30 | 1 (\fBARM_CORR_FLAGNUM_APP_TRACE\fR) = Application trace flag |
|---|
| 31 | .IP |
|---|
| 32 | 2 (\fBARM_CORR_FLAGNUM_AGENT_TRACE\fR) = Agent trace flag |
|---|
| 33 | .P |
|---|
| 34 | \fIcorrelator\fR is a pointer to a buffer containing a correlator. It serves no purpose to make the call if |
|---|
| 35 | the pointer is null. |
|---|
| 36 | |
|---|
| 37 | \fIflag\fR is a pointer to a boolean that is output indicating whether the flag is set. |
|---|
| 38 | .SH "RETURN VALUE" |
|---|
| 39 | On success, the function returns \fBARM_SUCCESS\fR. A non-zero value indicates |
|---|
| 40 | an error. |
|---|
| 41 | .SH ERRORS |
|---|
| 42 | If the return code is negative, an error occurred. If the return code is not negative, an error may |
|---|
| 43 | or may not have occurred - the determination of what is an error and whether an error code is |
|---|
| 44 | returned is at the discretion of the ARM implementation. The application can test the return code |
|---|
| 45 | if it wants to provide its own error logging. |
|---|
| 46 | |
|---|
| 47 | The following errors are recognized by this implementation, but may not be portable to other implementations: |
|---|
| 48 | |
|---|
| 49 | .TP |
|---|
| 50 | .B ARM_FAILURE_NULL_ARGUMENT |
|---|
| 51 | The \fIcorrelator\fR and \fIflag\fR arguments must not be null. |
|---|
| 52 | .TP |
|---|
| 53 | .B ARM_FAILURE_INVALID_ARGUMENT |
|---|
| 54 | An unknown flag value has been specified. |
|---|
| 55 | .SH "CONFORMING TO" |
|---|
| 56 | ARM Issue 4.0 C Language Bindings, Version 2 |
|---|
| 57 | .SH EXAMPLE |
|---|
| 58 | None. |
|---|
| 59 | .SH "SEE ALSO" |
|---|
| 60 | .BR arm_generate_correlator (3), |
|---|
| 61 | .BR arm_start_transaction (3) |
|---|
