Teledyne LeCroy BTTracer_Trainer - BTTrainer Users Manual - Manual (Page 162)

144
CATC BTT RAINER 2.11 C HAPTER
User’s Manual
Return value
• “Success”
• “Failure”
• “Pipe Not Found”
Comments
Opens a data pipe for reading or writing. If the data pipe type is “Receive”
and the pipe does not exist, a new pipe will be created. All open pipes will
be automatically closed upon script termination.
Example
OpenPipe("Data1", "Receive");
ReadPipe
ReadPipe(PipeName, PipeType, ByteCount)
Return values
Returns a list with three values: result, bytes read, and data.
Result (element 0) is one of the following:
• “Success”
• “Failure”
• “Invalid parameter”
• “Pipe not found”
• “Pipe not open”
Bytes read (element 1) is the number of bytes read in this transaction. Valid
only if result is “Success”.
PipeType “Transmit” or
“Receive”
pipe
“Receive”
Parameter Meaning Default Value Comments
PipeName Name of the
data pipe to
open
PipeType “Transmit” or
“Receive”
pipe
ByteCount Number of
bytes to read
1-65535
Parameter Meaning Default Value Comments