GetAnnotationAttribute
int GetAnnotationAttribute (int panelHandle, int controlID, int annotationIndex, int annotationAttribute, void *attributeValue);
Purpose
Obtains the value of a graph annotation attribute.
Supported Controls
You can use GetAnnotationAttribute with graph controls.
Parameters
| Input | ||
| Name | Type | Description |
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. |
| controlID | int | The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl. |
| annotationIndex | int | The one-based index of the graph annotation whose attribute value you want to obtain. |
| annotationAttribute | int | The graph annotation attribute value to get. In the function panel, when you click the control or press <Enter>, <Spacebar>, or <Ctrl-down arrow>, a dialog box appears containing a hierarchical list of the available attributes. Attributes whose values cannot be obtained are dimmed. Help text is shown for each attribute. To select an attribute, double-click it or select it and then press <Enter>. If the attribute shown in this ring control has named constants as valid values, you can open a list of them by moving to the Attribute Value control and pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants. |
| Output | ||
| Name | Type | Description |
| attributeValue | void * | The value of the specified annotation attribute. The data type for this parameter depends on the data type of the attribute you specify for the annotationAttribute parameter. Pass the address of a variable of the same data type of the attribute you pass to annotationAttribute. If the attribute shown in this ring control has named constants as valid values, you can open a list of them by pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants. |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 8.0 and later
Example
Refer to userint\GraphAnnotations.cws for an example of using the GetAnnotationAttribute function.