IFormattedIO488::WriteList

Description

Appends an array of arguments to the write buffer in an ASCII list format.  The WriteList method can force the elements to a particular data type. The list separator token defaults to the comma ',' character, but can be changed to another ASCII character.  If the flushAndEND parameter is true, the buffer will be flushed before this method returns.

VB Prototype

WriteList(
  data As Variant,
  type As IEEEASCIType, ' Optional Parameter
  listSeperator As String, ' Optional Parameter
  flushAndEND As Boolean ' Optional Parameter
)

C++ Prototype

HRESULT WriteList(
  VARIANT* data,
  IEEEASCIIType type,
  BSTR listSeperator,
  VARIANT_BOOL flushAndEND
);

Parameters

data

The array of elements to write.

type

[Optional in Visual Basic] The format to write the number in.  This parameter defaults to ASCIIType_Any, meaning the list will be written in the format array's elements.

listSeperator

[Optional in Visual Basic] This parameter may only be a single character string.  This parameter defaults to the comma character.  If this parameter is provided, the character in the string will be used to seperate elements.

flushAndEND

[Optional in Visual Basic] If this parameter is true, the formatted I/O object will flush the contents of the write buffer and send an end to the instrument.

Return Value

Refer to the table of return codes.

See Also

IO, InstrumentBigEndian, WriteString, WriteNumber, WriteList, WriteIEEEBlock, ReadString, ReadNumber, ReadList, ReadIEEEBlock, FlushWrite, FlushRead, SetBufferSize, IFormattedIO488 Overview