Vcl.AxCtrls.TOleStream.Read

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function Read(var Buffer; Count: Longint): Longint; override;

C++

virtual System::LongInt __fastcall Read(void *Buffer, System::LongInt Count)/* overload */;
inline System::LongInt __fastcall  Read(System::Sysutils::TBytes Buffer, System::LongInt Offset, System::LongInt Count){ return System::Classes::TStream::Read(Buffer, Offset, Count); }
inline System::LongInt __fastcall  Read(System::Sysutils::TBytes &Buffer, System::LongInt Count){ return System::Classes::TStream::Read(Buffer, Count); }

Properties

Type Visibility Source Unit Parent
function public
Vcl.AxCtrls.pas
Vcl.AxCtrls.hpp
Vcl.AxCtrls TOleStream

Description

Reads up to Count bytes from the current position into Buffer.

Call Read to read data from the Ole stream when it is not known how many bytes are available. Buffer must have at least Count bytes allocated to hold the data that was read from the stream.

Read uses the stream interface to transfer up to Count bytes into Buffer, starting at the current position, and then advances the current position by the number of bytes actually transferred. Read returns the number of bytes actually transferred (which may be less than the number requested in Count.)

All the other data-reading methods of an Ole stream (ReadBuffer, ReadComponent) call Read to do their actual reading.

See Also