Microsoft Information Protection SDK - C++ 1.17
API Reference Documentation for C++
Loading...
Searching...
No Matches
EditableStream Class Referenceabstract

#include <editable_stream.h>

Inheritance diagram for EditableStream:
Stream

Public Member Functions

virtual int64_t Update (const uint8_t *buffer, int64_t bufferLength, int64_t replaceLength)=0
 Update a number of bytes in the stream from a buffer.
 
virtual int64_t Delete (int64_t numBytes)=0
 Delete a number of bytes from the stream.
 
virtual int64_t Insert (const uint8_t *buffer, int64_t bufferLength)=0
 Insert a buffer into the stream.
 
- Public Member Functions inherited from Stream
virtual int64_t Read (uint8_t *buffer, int64_t bufferLength)=0
 Read into a buffer from the stream.
 
virtual int64_t Write (const uint8_t *buffer, int64_t bufferLength)=0
 Write into the stream from a buffer.
 
virtual bool Flush ()=0
 flush the stream.
 
virtual void Seek (int64_t position)=0
 Seek specific position within the stream.
 
virtual bool CanRead () const =0
 A check if stream can be read from.
 
virtual bool CanWrite () const =0
 A check if stream can be written to.
 
virtual int64_t Position ()=0
 Get the current position within the stream.
 
virtual int64_t Size ()=0
 Get the size of the content within the stream.
 
virtual void Size (int64_t value)=0
 Set the stream size.
 

Member Function Documentation

◆ Delete()

virtual int64_t EditableStream::Delete ( int64_t numBytes)
pure virtual

Delete a number of bytes from the stream.

Parameters
numBytesnumber of bytes to delete.
Returns
number of bytes deleted.
Note
This will not move the stream position.

◆ Insert()

virtual int64_t EditableStream::Insert ( const uint8_t * buffer,
int64_t bufferLength )
pure virtual

Insert a buffer into the stream.

Parameters
bufferpointer to a buffer
bufferLengthbuffer size.
Returns
number of bytes written.
Note
This will seek to the end of the inserted section.

◆ Update()

virtual int64_t EditableStream::Update ( const uint8_t * buffer,
int64_t bufferLength,
int64_t replaceLength )
pure virtual

Update a number of bytes in the stream from a buffer.

Parameters
bufferpointer to a buffer
bufferLengthbuffer size.
replaceLengthnumber of bytes to replace.
Returns
number of bytes written.
Note
This will seek to the end of the updated section.

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