GetAsyncTimerAttribute
int GetAsyncTimerAttribute (int timerID, int timerAttribute, void *attributeValue);
Purpose
This function gets the value of the specified attribute for the timer with the given ID.
The attributes that can be queried are the Interval, Count, Enabled, Callback Function, Callback Data, Timer Time, or Delta Time attributes.
Parameters
| Input | ||
| Name | Type | Description |
| timerID | int | Specifies the ID of the timer for which you want to get the desired attribute. This is the value returned by a call to NewAsyncTimer. |
| timerAttribute | int | The asynchronous timer attribute value to obtain. 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. |
| attributeValue | void * | The value of the specified asynchronous timer attribute. If the attribute shown in this 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: Asynchronous Timers
Include file: toolbox\asynctmr.h
LabWindows/CVI compatibility: LabWindows/CVI 5.0 and later
Example
Refer to toolbox\asyncdem.cws for an example of using the GetAsyncTimerAttribute function.