awvSetCursorPrompts
awvSetCursorPrompts(
w_windowID
x_yAxisNumber
t_xPrompt
t_yPrompt
[ ?stripNumber x_stripNumber ]
[ ?subwindow x_subwindow ]
)
=> t / nil
Description
Sets the tracking cursor prompts for the waveforms around a particular Y axis and a particular strip in a subwindow. If you specify nil for the prompts, the default prompts are used.
Arguments
|
w_windowID
|
Waveform window ID.
|
|
x_yAxisNumber
|
Number of y axis for which the tracking cursor prompt is to be set.
Valid values are from 1 through 4.
|
|
t_xPrompt
|
Prompt to set for the x-axis value.
|
|
t_yPrompt
|
Prompt to set for the y-axis value.
|
|
?stripNumber x_stripNumber
|
|
|
Number of the strip in which the tracking cursor prompt is to be set.
Valid values are 1 through 20.
If you do not specify this argument, tracking cursor prompts are set in the current strip.
|
|
?subwindow x_subwindow
|
|
|
Number of the subwindow.
If you do not specify this argument, the current subwindow is used.
|
Value Returned
|
t
|
Tracking cursor prompt is set successfully.
|
|
nil
|
Tracking cursor prompt cannot be set because of an error.
|
Examples
The following example sets the tracking cursor prompt for
awvSetCursorPrompts(awvGetCurrentWindow() 1 "Time(ns)" "Voltage(V)")
=> t
Return to top
