Admin Production ni-theme
Current Publication

SetAsyncTimerAttribute

LabWindows/CVI

SetAsyncTimerAttribute

int SetAsyncTimerAttribute (int timerID, int timerAttribute, ...);

Purpose

This function sets an attribute for the timer with the given ID.

The attributes that can be set are the Interval, Count, Enabled, Callback Data, or Callback Function attributes.

Parameters

Input
Name Type Description
timerID int Specifies the ID of the timer for which you want to set the desired attribute. This is the value returned by a call to NewAsyncTimer.
timerAttribute int The asynchronous timer attribute value to set.

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 ... 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.

Return Values:
0Success.
–1The system failed to allocate a timer.
–2No more IDs are available to assign to a new timer.
–3Not enough memory left for this operation.
–4The timer with the given ID was not found.
–5Initialization with a call to NewAsyncTimer was not done.
–6An internal error occurred.
–7The value of a parameter passed to this function was invalid.
–8The functionality is only available on real-time operating systems.
–9You cannot set this attribute.

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 SetAsyncTimerAttribute function.