Read Method

Description

Read one or more bytes from the stream. Reading starts at the Position property. Set Position to change the position.

Syntax

Visual Basic
Public Function Read( _ ByRef Buffer As Variant, _ Optional ByVal Count As Long = 0 _ ) As Long

Parameters

Buffer: Read one or more bytes from the stream. Reading starts at the Position property. Set Position to change the position.
Count: Specifies how much data to read.

Return Value

Indicates how much data was read.

Remarks

If the Buffer parameter is omitted, then this method attempts to read all the data from the current position to the end of the stream. The position is advanced Count bytes upon completion.

Error Codes

This method may generate the following error code (refer to ErrorConstants for a complete list of error codes):

ptInvalidParam1
ptInvalidParam2
ptNoBufferSpace