User`s guide

flush
Purpose Flush data or messages from specified RTDX channels
Note flush support C 5000 and C6000 processors will be remove d in a
future version.
Syntax flush(rx,channel,num,timeout)
flush(rx,channel,num)
flush(rx,channel,[],timeout)
flush(rx,channel)
flush(rx,'
all')
Description flush(rx,channel,num,timeout) rem oves num oldest data messag es
from the RTDX channel queue specified by
channel in rx. To determine
how long to wait for the function to complete,
flush uses timeout (in
seconds) rather than the global timeout pe riod s tored in
rx. flush
applies the timeout proces sing w hen it fl us he s the last message in the
channel q ueue, because the fl ush function performs a read to advance
the read pointer past the last message. Use this calling syntax only
when you specify a channel configured for read access.
flush(rx,channel,num) removes the num oldest me ssages from the
RTDX channel queue in
rx specified by the string channel. flush us es
the global timeout period stored in
rx to determine how long to wait
for the process to complete. Compare this to the previous syntax that
specifies the timeout period. Use this callingsyntaxonlywhenyou
specify a channel configured f or read access.
flush(rx,channel,[],timeout) removesalldatamessagesfromthe
RTDX channel queue specified by
channel in rx. To determine how long
to wait for the function to complete,
flush uses timeout (in seconds)
rather than the global timeout period stored i n
rx. flush applies the
timeout processing when it flushes the last message in the channel
queue, because
flush performs a read to advance the read pointer
past the last message . Use this callingsyntaxonlywhenyouspecifya
channel configured for read access.
7-53