API-ref-idrs16/html_c/_c_document_writer__interface_8h_source.html

#ifndef CDOCUMENTWRITER_INTERFACE_H


#define CDOCUMENTWRITER_INTERFACE_H


#include "CIDRS_interface.h"

#include "CPage_interface.h"

#include "COutputParams_interface.h"

#include "IStreamFactory_interface.h"

#include "IProgressDocumentWriting_interface.h"


#include "idrs_common.h"


#ifdef __cplusplus

extern "C" {

#endif


CDocumentWriter CDocumentWriter_Create(const CIDRS argIDRS, idrs_exception *pargException);


CDocumentWriter CDocumentWriter_Create2(const CIDRS argIDRS, IBaseImagePlugin argImagePlugin, idrs_exception *pargException);


IDRS_ERROR CDocumentWriter_Save(const CDocumentWriter argCDocumentWriter, const idrs_string strOutputFilePath, const CDocument argDocument, idrs_exception *pargException);


IDRS_ERROR CDocumentWriter_Save2(const CDocumentWriter argCDocumentWriter, IByteStream argOutputStream, const CDocument argDocument, idrs_exception *pargException);


IDRS_ERROR CDocumentWriter_Save3(const CDocumentWriter argCDocumentWriter, const idrs_string strOutputFilePath, const CPageArray argPageArray, idrs_exception *pargException);


IDRS_ERROR CDocumentWriter_Save4(const CDocumentWriter argCDocumentWriter, IByteStream argOutputStream, const CPageArray argPageArray, idrs_exception *pargException);


IDRS_ERROR CDocumentWriter_Save5(const CDocumentWriter argCDocumentWriter, const idrs_string strOutputFilePath, const CPage xargPageBuffer[], IDRS_UINT const uiPageCount, idrs_exception *pargException);


IDRS_ERROR CDocumentWriter_Save6(const CDocumentWriter argCDocumentWriter, IByteStream argOutputStream, const CPage xargPageBuffer[], IDRS_UINT const uiPageCount, idrs_exception *pargException);


IDRS_ERROR CDocumentWriter_Save7(const CDocumentWriter argCDocumentWriter, IStreamFactory argStreamFactory, const CDocument argDocument, idrs_exception *pargException);


IDRS_ERROR CDocumentWriter_Save8(const CDocumentWriter argCDocumentWriter, IStreamFactory argStreamFactory, const CPageArray argPageArray, idrs_exception *pargException);


IDRS_ERROR CDocumentWriter_Save9(const CDocumentWriter argCDocumentWriter, IStreamFactory argStreamFactory, const CPage xargPageBuffer[], IDRS_UINT const uiPageCount, idrs_exception *pargException);


void CDocumentWriter_SetOutputParams(CDocumentWriter argCDocumentWriter, const COutputParams argOutputParams, idrs_exception *pargException);


COutputParams CDocumentWriter_GetOutputParams(const CDocumentWriter argCDocumentWriter, idrs_exception *pargException);


IFontDataProviderCallback CDocumentWriter_GetFontDataProvider(const CDocumentWriter argCDocumentWriter, idrs_exception *pargException);


void CDocumentWriter_SetFontDataProvider(CDocumentWriter argCDocumentWriter, IFontDataProviderCallback argpFontProviderCallback, idrs_exception *pargException);


void CDocumentWriter_SetDocumentMaxMemoryConsumption(CDocumentWriter argCDocumentWriter, IDRS_UINT64 const uiMaxMemoryConsumption, idrs_exception *pargException);


IDRS_UINT64 CDocumentWriter_GetDocumentMaxMemoryConsumption(const CDocumentWriter argCDocumentWriter, idrs_exception *pargException);


void CDocumentWriter_SetOutputProgressCallback(CDocumentWriter argCDocumentWriter, IProgressDocumentWriting argpProgress, idrs_exception *pargException);


IProgressDocumentWriting CDocumentWriter_GetOutputProgressCallback(const CDocumentWriter argCDocumentWriter, idrs_exception *pargException);


enum ThreadingMode CDocumentWriter_GetThreadingMode(const CDocumentWriter argCDocumentWriter, idrs_exception *pargException);


void CDocumentWriter_SetThreadingMode(CDocumentWriter argCDocumentWriter, const enum ThreadingMode* const evThreadingMode, idrs_exception *pargException);


OutputThreadingConfig CDocumentWriter_GetAdvancedThreadingConfig(const CDocumentWriter argCDocumentWriter, idrs_exception *pargException);


void CDocumentWriter_SetAdvancedThreadingConfig(CDocumentWriter argCDocumentWriter, const OutputThreadingConfig* stThreadingConfig, idrs_exception *pargException);


void CDocumentWriter_Destroy(CDocumentWriter argCDocumentWriter, idrs_exception *pargException);


#ifdef __cplusplus

}

#endif /* __cplusplus */


#endif /* CDOCUMENTWRITER_INTERFACE_H */

CDocumentWriter_SetOutputProgressCallback
void CDocumentWriter_SetOutputProgressCallback(CDocumentWriter argCDocumentWriter, IProgressDocumentWriting argpProgress, idrs_exception *pargException)
Sets the object for monitoring progress.

CDocumentWriter_GetDocumentMaxMemoryConsumption
IDRS_UINT64 CDocumentWriter_GetDocumentMaxMemoryConsumption(const CDocumentWriter argCDocumentWriter, idrs_exception *pargException)
Gets the value for the max memory consumption threshold.

CDocumentWriter_Save8
IDRS_ERROR CDocumentWriter_Save8(const CDocumentWriter argCDocumentWriter, IStreamFactory argStreamFactory, const CPageArray argPageArray, idrs_exception *pargException)
Creates one or more output documents using the supplied pages array. The method is using argStreamFac...

CDocumentWriter_GetFontDataProvider
IFontDataProviderCallback CDocumentWriter_GetFontDataProvider(const CDocumentWriter argCDocumentWriter, idrs_exception *pargException)
Gets the callback object used for formatting.

CDocumentWriter_Save3
IDRS_ERROR CDocumentWriter_Save3(const CDocumentWriter argCDocumentWriter, const idrs_string strOutputFilePath, const CPageArray argPageArray, idrs_exception *pargException)
Creates the output file using the supplied pages array and writes it to the given file path.

CDocumentWriter_Save6
IDRS_ERROR CDocumentWriter_Save6(const CDocumentWriter argCDocumentWriter, IByteStream argOutputStream, const CPage xargPageBuffer[], IDRS_UINT const uiPageCount, idrs_exception *pargException)
Creates the output file using the supplied pages and writes it to the given stream.

CDocumentWriter_Save5
IDRS_ERROR CDocumentWriter_Save5(const CDocumentWriter argCDocumentWriter, const idrs_string strOutputFilePath, const CPage xargPageBuffer[], IDRS_UINT const uiPageCount, idrs_exception *pargException)
Creates the output file using the supplied pages and writes it to the given file path.

CDocumentWriter_Save2
IDRS_ERROR CDocumentWriter_Save2(const CDocumentWriter argCDocumentWriter, IByteStream argOutputStream, const CDocument argDocument, idrs_exception *pargException)
Creates the output file using the supplied document and writes it to the given stream.

CDocumentWriter_SetOutputParams
void CDocumentWriter_SetOutputParams(CDocumentWriter argCDocumentWriter, const COutputParams argOutputParams, idrs_exception *pargException)
Sets the parameters used to generate the output document.

CDocumentWriter_SetAdvancedThreadingConfig
void CDocumentWriter_SetAdvancedThreadingConfig(CDocumentWriter argCDocumentWriter, const OutputThreadingConfig *stThreadingConfig, idrs_exception *pargException)
Sets the threading config used for the document output process.

CDocumentWriter_Save4
IDRS_ERROR CDocumentWriter_Save4(const CDocumentWriter argCDocumentWriter, IByteStream argOutputStream, const CPageArray argPageArray, idrs_exception *pargException)
Creates the output file using the supplied pages array and writes it to the given stream.

CDocumentWriter_SetDocumentMaxMemoryConsumption
void CDocumentWriter_SetDocumentMaxMemoryConsumption(CDocumentWriter argCDocumentWriter, IDRS_UINT64 const uiMaxMemoryConsumption, idrs_exception *pargException)
Sets the threshold for the maximum amount of memory that will be allocated to store the output docume...

CDocumentWriter_Save9
IDRS_ERROR CDocumentWriter_Save9(const CDocumentWriter argCDocumentWriter, IStreamFactory argStreamFactory, const CPage xargPageBuffer[], IDRS_UINT const uiPageCount, idrs_exception *pargException)
Creates one or more output documents using the supplied pages. The method is using argStreamFactory t...

CDocumentWriter_Destroy
void CDocumentWriter_Destroy(CDocumentWriter argCDocumentWriter, idrs_exception *pargException)
Destroys a CDocumentWriter handle.

CDocumentWriter_Create
CDocumentWriter CDocumentWriter_Create(const CIDRS argIDRS, idrs_exception *pargException)
Create creates a CDocumentWriter object.

CDocumentWriter_GetOutputProgressCallback
IProgressDocumentWriting CDocumentWriter_GetOutputProgressCallback(const CDocumentWriter argCDocumentWriter, idrs_exception *pargException)
GetOutputProgressCallback gets the object used for monitoring progress.

CDocumentWriter_Create2
CDocumentWriter CDocumentWriter_Create2(const CIDRS argIDRS, IBaseImagePlugin argImagePlugin, idrs_exception *pargException)
Create creates a CDocumentWriter object.

CDocumentWriter_GetAdvancedThreadingConfig
OutputThreadingConfig CDocumentWriter_GetAdvancedThreadingConfig(const CDocumentWriter argCDocumentWriter, idrs_exception *pargException)
Gets the threading config used for the document output process.

CDocumentWriter_SetThreadingMode
void CDocumentWriter_SetThreadingMode(CDocumentWriter argCDocumentWriter, const enum ThreadingMode *const evThreadingMode, idrs_exception *pargException)
Sets the threading mode used for the document output process.

CDocumentWriter_SetFontDataProvider
void CDocumentWriter_SetFontDataProvider(CDocumentWriter argCDocumentWriter, IFontDataProviderCallback argpFontProviderCallback, idrs_exception *pargException)
Sets the callback class used by integrators to retrieve font data when creating documents.

CDocumentWriter_Save7
IDRS_ERROR CDocumentWriter_Save7(const CDocumentWriter argCDocumentWriter, IStreamFactory argStreamFactory, const CDocument argDocument, idrs_exception *pargException)
Creates one or more output documents using the supplied document object. The method is using argStrea...

CDocumentWriter_GetOutputParams
COutputParams CDocumentWriter_GetOutputParams(const CDocumentWriter argCDocumentWriter, idrs_exception *pargException)
Gets the output parameters property value.

CDocumentWriter_GetThreadingMode
enum ThreadingMode CDocumentWriter_GetThreadingMode(const CDocumentWriter argCDocumentWriter, idrs_exception *pargException)
Returns the threading mode that should be used for the document output process.

CDocumentWriter_Save
IDRS_ERROR CDocumentWriter_Save(const CDocumentWriter argCDocumentWriter, const idrs_string strOutputFilePath, const CDocument argDocument, idrs_exception *pargException)
Creates the output file using the supplied document and writes it to the given file path.

CIDRS_interface.h
Interface for CIDRS wrapper.

COutputParams_interface.h
Interface for COutputParams wrapper.

CPage_interface.h
Interface for CPage wrapper.

ThreadingMode
ThreadingMode
Multi-threading usage modes.
Definition EnumDefinitions_interface.h:3111

IProgressDocumentWriting_interface.h
Interface for IProgressDocumentWriting wrapper.

IStreamFactory_interface.h
Interface for IStreamFactory wrapper.

CDocument
CDocument class represents a document composed of a set of CPage elements.

CDocumentWriter
The CDocumentWriter class exports iDRS structures to external file formats.

COutputParams
COutputParams class is the base class for different output classes.

CPage
The CPage class manages a page in the IDRS.

IBaseImagePlugin
IBaseImagePlugin defines the interface required to provide custom image loading/saving capabilities.

IByteStream
IByteStream defines the interface required to provide read, write and seek functionalities for a sequ...

IFontDataProviderCallback
IFontDataProviderCallback defines the interface required to supply the fonts to be used by the docume...

IProgressDocumentWriting
IProgressDocumentWriting defines the interface required to monitor document writing progress.

IStreamFactory
IStreamFactory represents an interface used for output stream creation.

idrs_string
Class that handles a string of characters.

idrs_common.h

IDRS_ERROR
unsigned long IDRS_ERROR
The IDRS_ERROR data type defines an error code.
Definition idrserr_interface.h:16

IDRS_UINT64
unsigned long long IDRS_UINT64
An unsigned 64 bit value.
Definition idrsstd_interface.h:33

IDRS_UINT
unsigned int IDRS_UINT
An unsigned integer.
Definition idrsstd_interface.h:27

OutputThreadingConfig
Defines how many threads output operations should use for processing.
Definition StructDefinitions_interface.h:172