IFormattedIO488::ReadNumber

Description

Reads from the read buffer, converting its contents into a numeric value, until an unparsable character is received or an end condition occurs.  If the flushToEND parameter is true, the method will discard all data in the I/O buffer and not return until an end condition occurs in the I/O stream.

VB Prototype

value As Variant = ReadNumber(
  type As IEEEASCIType, ' Optional Parameter
  flushToEND As Boolean ' Optional Parameter
)

C++ Prototype

HRESULT ReadNumber(
  IEEEASCIIType type,
  VARIANT_BOOL flushToEND,
  VARIANT* pData
);

Parameters

type

[Optional in Visual Basic] The formatted I/O object will verify that the data is in this format.  No verification will be done if the parameter's value is ASCIIType_Any.

flushToEND

[Optional in Visual Basic] If this parameter is true, the formatted I/O object will flush the contents of the write buffer after the retrieved data. until an end condition occurs.

pData

The number retrieved from the read buffer.

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