3156B User Manual
Racal Instrument © 2005
Programming Reference 5-75
Ri3156b_delete_segment
Description
Deletes the specified arbitrary waveform memory segment or ALL segments (if the segment number specified
is 0). Note that if a segment is deleted, the memory portion that belonged to this segment is no longer
accessible. The next segment that is defined will be placed after the last defined memory segment. However, if
the last segment is deleted, the next downloaded segment will be written on top of the deleted one. There is
danger that by deleting segments often, large portions of memory will remain unused. It is therefore suggested
that you periodically delete the entire memory and only reload waveforms that will be used.
Channel Dependency: Independent
C Syntax
ViStatus ri3156b_delete_segment (ViSession instrHandle, ViInt16 segmentNumber)
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.
segmentNumber
ViInt16
Select the segment number to be deleted. Selecting
Segment 0 deletes ALL segments
Valid range: 1 to 16k
Default: 1
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.
