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

Represents low-level file access handle. More...

Inheritance diagram for FileHandle:
error_type File_Open (string_type filename, FileHandle **result)
 Opens a file for reading. More...
error_type File_OpenStream (InputOutputStreamHandle *input_stream, string_type name, FileHandle **result)
 Opens an input stream for reading.
error_type File_Create (string_type filename, FileHandle **result)
 Creates a file for writing. More...
error_type File_CreateStream (InputOutputStreamHandle *input_stream, string_type name, FileHandle **result)
 Uses arbitrary stream as a file.
error_type File_Initialize (FileHandle *handle)
 Perform basic intialization. More...
error_type File_IsEncrypted (FileHandle *handle, boolean_type *result)
 Determine if file is encrypted. More...
error_type File_SetEncryptionPassword (FileHandle *handle, string_type password)
 Set encryption password.
error_type File_SetEncryptionKey (FileHandle *handle, EncryptionKeyHandle *key)
 Set files encryption key. More...
error_type File_XrefChain (FileHandle *handle, XrefChainHandle **result)
 Get chain of xref tables for iteration.
error_type File_GetIndirectObject (FileHandle *handle, biguint_type obj_number, ushort_type gen_number, ObjectHandle **result)
 Find exact object within all xref tables.
error_type File_ToUnknown (FileHandle *handle, IUnknownHandle **result)
 Reinterpret current object as IUnknownHandle.
error_type File_FromUnknown (IUnknownHandle *handle, FileHandle **result)
 Convert IUnknownHandle to FileHandle.
error_type File_Release (FileHandle *handle)
 Decrement the internal reference counter. More...

Additional Inherited Members

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

Detailed Description

Represents low-level file access handle.

The file is basically composed of:

When the file has been incrementally updated, there may be multiple cross-reference sections.

For more details please visit section 7.5 - File Structure and section 7.5.6 - Incremental Updates.

decrypt.c, extract.c, sign.c, sign_custom.c, and write_custom.c.

Member Function Documentation

◆ File_Open()

error_type File_Open ( string_type  filename,
FileHandle **  result 

Opens a file for reading.

The file must exist.

decrypt.c, extract.c, and write_custom.c.

Friends And Related Function Documentation

◆ File_Create()

error_type File_Create ( string_type  filename,
FileHandle **  result 

Creates a file for writing.

Truncates the contents if it already exists.

sign.c, sign_custom.c, and write_custom.c.

◆ File_Initialize()

error_type File_Initialize ( FileHandle handle)

Perform basic intialization.

Read xref tables, determine if file is encrypted.

extract.c, and write_custom.c.

◆ File_IsEncrypted()

error_type File_IsEncrypted ( FileHandle handle,
boolean_type result 

Determine if file is encrypted.

If the file was not initialized returns false.

◆ File_SetEncryptionKey()

error_type File_SetEncryptionKey ( FileHandle handle,
EncryptionKeyHandle key 

Set files encryption key.

This is most often certificate.

See also

◆ File_Release()

error_type File_Release ( FileHandle handle)

Decrement the internal reference counter.

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

See also
decrypt.c, sign.c, sign_custom.c, and write_custom.c.

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