ADTF: IInputStream

An interface for reading data from a stream. More...

Inheritance diagram for IInputStream:

Public Member Functions
	ADTF_IID (IInputStream, "input_stream.ant.ucom.adtf.iid")
	Marks the `IInputStream` to be castable with the ucom_cast<> More...

virtual tResult	Read (void pvBuffer, size_t nBufferSize, size_t pnBytesRead=nullptr) const =0
	Read data from stream. More...

Public Member Functions inherited from IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the `IObject` to be castable with the `ucom_cast()` More...

Additional Inherited Members
Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Use implemented Destroy() instead of delete!

Detailed Description

An interface for reading data from a stream.

Definition at line 23 of file stream_intf.h.

ADTF_IID	(	IInputStream	,
		"input_stream.ant.ucom.adtf.iid"
	)

Marks the IInputStream to be castable with the ucom_cast<>

pure virtual

Read data from stream.

The Read method reads data from a stream.

Parameters

pvBuffer	[in] Pointer to an existing buffer.
nBufferSize	[in] Size in bytes of the existing buffer.
pnBytesRead	[in,out] Pointer to a variable that receives the number of bytes that actually have been read.