3156B User Manual
Racal Instrument © 2005
Programming Reference 5-145
Return Values
Displays the return status of the function call. If the function was successful, it will return a status of
VI_SUCCESS, otherwise it will return an error code. Passing the error code into the function
"ri3156B_error_message()" will return a string describing the error.
Ri3156b_apply_video_str_character
Description
Programs all video pattern parameters simultaneously. It also sets video stroke as the active output function.
Note that this function can be used for the built-in library of video characters only. If you design your own
characters, you can use the Ri3156b_apply_video_stroke_pattern function instead.
Channel Dependency: Common
C Syntax
ViStatus ri3156b_apply_video_str_character (ViSession instrHandle, ViReal64 videoStrokePointFrequency,
ViReal64 videoStrokeOffsetStart, ViReal64 videoStrokeOffsetStop, ViReal64 videoStrokeOffsetStep, ViBoolean
videoStrokeCircType, ViInt16 videoStrokeCharacter)
Parameters
Name
Variable
Type
Description
instrHandle
ViSession
The Instrument Handle is used to identify the unique
session or communication channel between the driver
and the instrument. If more than one instrument of the
model type is used, this will be used to differentiate
between them. Note that the initialize function may be
used to associate multiple instrument handles with a
single instrument.
videoStrokePointFrequency
ViReal64
Programs the video waveform sample clock frequency.
Valid range: 1 to 100e6 (pps)
Default: 10e3
videoStrokeOffsetStart
ViReal64
Selects the video stroke offset start level.
Valid Range:
-4.995 to +4.995
(V into 50
Ω
)
Default Value: 0