ADTF  3.15.3
IOutputStreamabstract

An interface for writing data to a stream. More...

Inheritance diagram for IOutputStream:
[legend]

Public Member Functions

 ADTF_IID (IOutputStream, "output_stream.ant.ucom.adtf.iid")
 Marks the IOutputStream to be castable with the ucom_cast<> More...
 
virtual tResult Write (const void *pvBuffer, size_t nBufferSize, size_t *pnBytesWritten=nullptr)=0
 Write data to 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 writing data to a stream.

Definition at line 53 of file stream_intf.h.

Member Function Documentation

◆ ADTF_IID()

ADTF_IID ( IOutputStream  ,
"output_stream.ant.ucom.adtf.iid"   
)

Marks the IOutputStream to be castable with the ucom_cast<>

See also
ADTF_IID(_interface, _striid)

◆ Write()

virtual tResult Write ( const void *  pvBuffer,
size_t  nBufferSize,
size_t *  pnBytesWritten = nullptr 
)
pure virtual

Write data to stream.

The Write method writes data to a stream.

Parameters
pvBuffer[in] Pointer to an existing buffer.
nBufferSize[in] Size in bytes of the existing buffer.
pnBytesWritten[in,out] Pointer to a variable that receives the number of bytes that actually have been written.
Returns
Returns a standard result code.