libCZI
Reading and Writing CZI documents made easy
libCZI::IOutputStream Class Referenceabstract

#include <libCZI.h>

Inheritance diagram for libCZI::IOutputStream:
libCZI::IInputOutputStream

Public Member Functions

virtual void Write (std::uint64_t offset, const void *pv, std::uint64_t size, std::uint64_t *ptrBytesWritten)=0
 

Detailed Description

Interface used for writing a data-stream. The abstraction used is:

  • It is possible to write to arbitrary positions.
  • The end of the stream is defined by the highest position written to.
  • If write-operations occur on non-consecutive positions, then the gaps can be assumed to have arbitrary content.

Member Function Documentation

◆ Write()

virtual void libCZI::IOutputStream::Write ( std::uint64_t  offset,
const void *  pv,
std::uint64_t  size,
std::uint64_t *  ptrBytesWritten 
)
pure virtual

Writes the specified data to the stream, starting at the position specified by "offset".

Parameters
offsetThe offset into the stream where to start the write-operation.
pvPointer to the data.
sizeThe size of the data.
[in,out]ptrBytesWrittenIf non-null, then the number of bytes actually written will be put here.

The documentation for this class was generated from the following file: