GetAnnotationIndexFromCaption
int GetAnnotationIndexFromCaption (int panelHandle, int controlID, char *captionText, int beginningIndex, int *annotationIndex);
Purpose
Returns the 1-based index of the first graph annotation after begIndex that contains captionText in its caption. This function returns the index on a partial match, so captionText does not have to match the caption exactly.
 |
Note This function uses case-sensitive comparison. |
Supported Controls
You can use GetAnnotationIndexFromCaption 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. |
| captionText | char * | The text to find in the graph annotation captions. This function returns the index on a partial match, so captionText does not have to match the caption exactly to return the caption index. |
| beginningIndex | int | The annotation index from which to start searching. |
| Output | ||
| Name | Type | Description |
| annotationIndex | int | The one-based index of the first graph annotation that contains captionText in its caption. |
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