Click or drag to resize
EmberReaderRead Method
Advances the reader to the next data value in the stream.

Namespace: Lawo.EmberPlusSharp.Ember
Assembly: Lawo.EmberPlusSharp (in Lawo.EmberPlusSharp.dll) Version: 1.4.1707.27006
Syntax
C#
public bool Read()

Return Value

Type: Boolean
true if the operation completed successfully; false if the end of the stream has been reached.
Exceptions
ExceptionCondition
EmberExceptionAn error occurred while parsing the EmBER-encoded data, see Message for more information.
ObjectDisposedExceptionDispose has been called.
Remarks

After this method returns true, client code usually examines the values of the InnerNumber and OuterId properties to determine the next steps. This method returns true in the following situations:

  • The identifiers and lengths of a data value with primitive encoding have been read successfully. Call the appropriate ReadContents method to retrieve the contents of the data value.
  • The identifiers and lengths of a sequence, a set or an application-defined type have been read successfully. Call Read to advance the reader to the data values of the container.
  • The reader has read past the end of a sequence, a set or an application-defined type with definite length. Call Read to advance the reader to the data values located after the container.
  • The End-of-contents marker of a sequence, a set or an application-defined type with indefinite length has been read successfully. Call Read to advance the reader to the data values located after the container.

When a EmberReader is first created and initialized, there is no information available. You must call Read to read the first data value.

Possibly unread contents of the previous data value with primitive encoding is skipped automatically.

Bibliography
See Also