Vanilla.PDF  2.2.0
Cross-platform toolkit for creating and modifying PDF documents
List of all members
ByteRangeHandle Class Reference

Represents starting byte offset and length. More...

Inheritance diagram for ByteRangeHandle:
IUnknownHandle
error_type CALLING_CONVENTION ByteRange_Create (ByteRangeHandle **result)
 Create an empty ByteRange.
 
error_type CALLING_CONVENTION ByteRange_CreateFromData (IntegerObjectHandle *offset, IntegerObjectHandle *length, ByteRangeHandle **result)
 Create a ByteRange with offset and length values.
 
error_type CALLING_CONVENTION ByteRange_GetOffset (ByteRangeHandle *handle, IntegerObjectHandle **result)
 Get starting offset of byte range.
 
error_type CALLING_CONVENTION ByteRange_GetLength (ByteRangeHandle *handle, IntegerObjectHandle **result)
 Get length of byte range.
 
error_type CALLING_CONVENTION ByteRange_SetOffset (ByteRangeHandle *handle, IntegerObjectHandle *offset)
 Set starting offset of byte range.
 
error_type CALLING_CONVENTION ByteRange_SetLength (ByteRangeHandle *handle, IntegerObjectHandle *length)
 Set length of byte range.
 
error_type CALLING_CONVENTION ByteRange_Release (ByteRangeHandle *handle)
 Decrement the internal reference counter.
 

Additional Inherited Members

- Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION IUnknown_AddRef (IUnknownHandle *handle)
 Increment the internal reference counter.
 

Detailed Description

Represents starting byte offset and length.

ByteRange represents a single contiguous byte range in a PDF file, defined by a starting offset and a length.

Member Function Documentation

◆ ByteRange_Create()

error_type CALLING_CONVENTION ByteRange_Create ( ByteRangeHandle **  result)

Create an empty ByteRange.

Parameters
resultOutput ByteRange handle

Friends And Related Symbol Documentation

◆ ByteRange_CreateFromData()

error_type CALLING_CONVENTION ByteRange_CreateFromData ( IntegerObjectHandle offset,
IntegerObjectHandle length,
ByteRangeHandle **  result 
)
related

Create a ByteRange with offset and length values.

Parameters
offsetStarting byte offset
lengthLength in bytes
resultOutput ByteRange handle

◆ ByteRange_SetOffset()

error_type CALLING_CONVENTION ByteRange_SetOffset ( ByteRangeHandle handle,
IntegerObjectHandle offset 
)
related

Set starting offset of byte range.

Parameters
handleByteRange handle
offsetNew starting byte offset

◆ ByteRange_SetLength()

error_type CALLING_CONVENTION ByteRange_SetLength ( ByteRangeHandle handle,
IntegerObjectHandle length 
)
related

Set length of byte range.

Parameters
handleByteRange handle
lengthNew length in bytes

◆ ByteRange_Release()

error_type CALLING_CONVENTION ByteRange_Release ( ByteRangeHandle handle)
related

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also
IUnknown_Release

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