Main Page Namespace List Compound List File List Compound Members File Members

xfoifc_c.h File Reference

XSL Formatter V3 C Interface. More...

Go to the source code of this file.

Defines

#define XFOINTERFACE_API

Typedefs

typedef long XfoIfErrorCode

Error Code.

typedef void * CXfoObjPtr

Pointer to XfoObj instance.

typedef void( XfoOnMessageProc )(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const char *errMessage)

Error callback handler.

typedef void( XfoOnMessageProcW )(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const wchar_t *errMessage)

typedef void( XfoOnFormatPageProc )(long pageNo)

Enumerations

enum XfoIfErrorLevel {
  ELVL_NORMAL, ELVL_INFORMATION, ELVL_WARNING, ELVL_RECOVERABLE,
  ELVL_FATAL
}

Error Level. More...

enum XfoErrorStreamType { EST_NONE, EST_STDOUT, EST_STDERR }

Error Stream Type for MessageListener. More...

enum PDFVERSION { PDF_13, PDF_14, PDF_15 }

PDF version. More...

enum PDFENCRYPTLEVEL { ENCLEVEL_40, ENCLEVEL_128 }

PDF encrypt level. More...

enum PDFPRINTALLOW { PRALLOW_NONE, PRALLOW_LOW, PRALLOW_HIGH }

PDF print allow. More...

enum PDFIMAGECOMPRESSION { IMGCMPR_AUTO, IMGCMPR_JPEG, IMGCMPR_ZLIB, IMGCMPR_JPEG2K }

PDF image compression. More...

enum PDFRGBCONVERSION { RGBCONV_NONE, RGBCONV_BLACK, RGBCONV_GRAY, RGBCONV_ALL }

PDF RGB conversion. More...

enum EMBEDALLFONT { EMBALLFONT_PART, EMBALLFONT_ALL, EMBALLFONT_BASE14 }

Embed font. More...

enum IMAGEDOWNSAMPLING { IMGDOWNSAMPLING_NONE, IMGDOWNSAMPLING_AVERAGE, IMGDOWNSAMPLING_BICUBIC, IMGDOWNSAMPLING_SUBSAMPLING }

Image downsampling. More...

enum MONOCHROMECOMPRESSION {
  MONOCMPR_CCITT4, MONOCMPR_CCITT3, MONOCMPR_RUNLENGTH, MONOCMPR_ZLIB,
  MONOCMPR_OFF
}

Monochrome compression. More...

enum SVGVERSION { SVG_11, SVG_Basic, SVG_Tiny }

SVG version. More...

enum IMAGEPROCTYPE { IMGPT_EMBED_ALL, IMGPT_COPY_ALL, IMGPT_LINK, IMGPT_COPY }

Image processing. More...

enum IMAGECONVERSION { IMGCNV_AUTO, IMGCNV_JPEG, IMGCNV_PNG }

Image conversion. More...

Functions

CXfoObjPtr xfo_createXfoObject ()

Create instance of XfoObj.

void xfo_releaseXfoObject (CXfoObjPtr pXfoObj)

Release instance of XfoObj.

char * xfo_getDocumentURI (CXfoObjPtr pXfoObj, char *pVal, int size)

Get the URL of XML document you will format.

wchar_t * xfo_getDocumentURIW (CXfoObjPtr pXfoObj, wchar_t *pVal, int size)

Get the URL of XML document you will format.

void xfo_setDocumentURI (CXfoObjPtr pXfoObj, const char *newVal)

Specifies the URL of XML document you will format.

void xfo_setDocumentURIW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Specifies the URL of XML document you will format.

char * xfo_getStylesheetURI (CXfoObjPtr pXfoObj, char *pVal, int size)

Get the URI of XSL stylesheet for formatting.

wchar_t * xfo_getStylesheetURIW (CXfoObjPtr pXfoObj, wchar_t *pVal, int size)

Get the URI of XSL stylesheet for formatting.

void xfo_setStylesheetURI (CXfoObjPtr pXfoObj, const char *newVal)

Specifies the URI of XSL stylesheet for formatting.

void xfo_setStylesheetURIW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Specifies the URI of XSL stylesheet for formatting.

char * xfo_getOutputFilePath (CXfoObjPtr pXfoObj, char *pVal, int size)

Get the path name of the output file.

wchar_t * xfo_getOutputFilePathW (CXfoObjPtr pXfoObj, wchar_t *pVal, int size)

Get the path name of the output file.

void xfo_setOutputFilePath (CXfoObjPtr pXfoObj, const char *newVal)

Specifies the path name of the output file.

void xfo_setOutputFilePathW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Specifies the path name of the output file.

char * xfo_getOptionFileURI (CXfoObjPtr pXfoObj, char *pVal, int size, int n)

Get the path name of XML-format Option setting file which describes XSL Formatter options.

wchar_t * xfo_getOptionFileURIW (CXfoObjPtr pXfoObj, wchar_t *pVal, int size, int n)

Get the path name of XML-format Option setting file which describes XSL Formatter options.

void xfo_setOptionFileURI (CXfoObjPtr pXfoObj, const char *newVal)

Specifies the path name of XML-format Option setting file which describes XSL Formatter options.

void xfo_setOptionFileURIW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Specifies the path name of XML-format Option setting file which describes XSL Formatter options.

void xfo_addOptionFileURI (CXfoObjPtr pXfoObj, const char *newVal)

Append the path name of XML-format Option setting file which describes XSL Formatter options.

void xfo_addOptionFileURIW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Append the path name of XML-format Option setting file which describes XSL Formatter options.

int xfo_getOptionFileCount (CXfoObjPtr pXfoObj)

Get the number of URIs of XML-format Option setting file which describes XSL Formatter options.

char * xfo_getOutputFOPath (CXfoObjPtr pXfoObj, char *pVal, int size)

Get the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.

wchar_t * xfo_getOutputFOPathW (CXfoObjPtr pXfoObj, wchar_t *pVal, int size)

Get the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.

void xfo_setOutputFOPath (CXfoObjPtr pXfoObj, const char *newVal)

Specifies the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.

void xfo_setOutputFOPathW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Specifies the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.

char * xfo_getExternalXSLT (CXfoObjPtr pXfoObj, char *pVal, int size)

Get the command line of External XSLT Processor.

wchar_t * xfo_getExternalXSLTW (CXfoObjPtr pXfoObj, wchar_t *pVal, int size)

Get the command line of External XSLT Processor.

void xfo_setExternalXSLT (CXfoObjPtr pXfoObj, const char *newVal)

Specifies the command line of External XSLT Processor.

void xfo_setExternalXSLTW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Specifies the command line of External XSLT Processor.

char * xfo_getBaseURI (CXfoObjPtr pXfoObj, char *pVal, int size)

Get the default base URI.

wchar_t * xfo_getBaseURIW (CXfoObjPtr pXfoObj, wchar_t *pVal, int size)

Get the default base URI.

void xfo_setBaseURI (CXfoObjPtr pXfoObj, const char *newVal)

Specifies the default base URI.

void xfo_setBaseURIW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Specifies the default base URI.

char * xfo_getXSLTParamFormat (CXfoObjPtr pXfoObj, char *pVal, int size)

Get the parameter format of xsl:param when using External XSLT Processor.

wchar_t * xfo_getXSLTParamFormatW (CXfoObjPtr pXfoObj, wchar_t *pVal, int size)

Get the parameter format of xsl:param when using External XSLT Processor.

void xfo_setXSLTParamFormat (CXfoObjPtr pXfoObj, const char *newVal)

Specifies the parameter format of xsl:param when using External XSLT Processor.

void xfo_setXSLTParamFormatW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Specifies the parameter format of xsl:param when using External XSLT Processor.

long xfo_getStartPage (CXfoObjPtr pXfoObj)

Get the start page number of document to output.

void xfo_setStartPage (CXfoObjPtr pXfoObj, long newVal)

Specifies the start page number of document to output.

long xfo_getEndPage (CXfoObjPtr pXfoObj)

Get the end page number of document to output.

void xfo_setEndPage (CXfoObjPtr pXfoObj, long newVal)

Specifies the end page number of document to output.

void xfo_setPdfMasterPassword (CXfoObjPtr pXfoObj, const char *newVal)

Effective when outputting to PDF.

void xfo_setPdfMasterPasswordW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Effective when outputting to PDF.

void xfo_setPdfUserPassword (CXfoObjPtr pXfoObj, const char *newVal)

Effective when outputting to PDF.

void xfo_setPdfUserPasswordW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Effective when outputting to PDF.

void xfo_setPdfNoPrinting (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to PDF.

long xfo_getPdfNoPrinting (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfNoChanging (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to PDF.

long xfo_getPdfNoChanging (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfNoContentCopying (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to PDF.

long xfo_getPdfNoContentCopying (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfNoAddingOrChangingCommnets (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to PDF.

long xfo_getPdfNoAddingOrChangingCommnets (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfNoAddingOrChangingComments (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to PDF.

long xfo_getPdfNoAddingOrChangingComments (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfVersion (CXfoObjPtr pXfoObj, PDFVERSION newVal)

Effective when outputting to PDF.

PDFVERSION xfo_getPdfVersion (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfNoFillForm (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to PDF.

long xfo_getPdfNoFillForm (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfNoAccessibility (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to PDF.

long xfo_getPdfNoAccessibility (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfNoAssembleDoc (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to PDF.

long xfo_getPdfNoAssembleDoc (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfEncryptLevel (CXfoObjPtr pXfoObj, PDFENCRYPTLEVEL newVal)

Effective when outputting to PDF.

PDFENCRYPTLEVEL xfo_getPdfEncryptLevel (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

long xfo_getPdfEmbedAllFonts (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfEmbedAllFonts (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to PDF.

char * xfo_getPdfEmbedFonts (CXfoObjPtr pXfoObj, char *pVal, int size)

Effective when outputting to PDF.

wchar_t * xfo_getPdfEmbedFontsW (CXfoObjPtr pXfoObj, wchar_t *pVal, int size)

Effective when outputting to PDF.

void xfo_setPdfEmbedFonts (CXfoObjPtr pXfoObj, const char *newVal)

Effective when outputting to PDF.

void xfo_setPdfEmbedFontsW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Effective when outputting to PDF.

long xfo_getPdfErrorOnEmbedFault (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfErrorOnEmbedFault (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to PDF.

PDFPRINTALLOW xfo_getPdfPrintingAllowed (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfPrintingAllowed (CXfoObjPtr pXfoObj, PDFPRINTALLOW newVal)

Effective when outputting to PDF.

PDFIMAGECOMPRESSION xfo_getPdfImageCompression (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfImageCompression (CXfoObjPtr pXfoObj, PDFIMAGECOMPRESSION newVal)

Effective when outputting to PDF.

int xfo_getPdfJPEGQuality (CXfoObjPtr pXfoObj)

Gets the value of the quality of JPEG format that is specified by xfo_setPdfImageCompression() stored in PDF.

void xfo_setPdfJPEGQuality (CXfoObjPtr pXfoObj, int newVal)

Effective when outputting to PDF.

long xfo_getPdfCompressContentStream (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfCompressContentStream (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to PDF.

long xfo_getPdfUseLaunchForRelativeURI (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfUseLaunchForRelativeURI (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to PDF.

PDFRGBCONVERSION xfo_getPdfRGBConversion (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfRGBConversion (CXfoObjPtr pXfoObj, PDFRGBCONVERSION newVal)

Effective when outputting to PDF.

int xfo_getPdfRasterizeResolution (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfRasterizeResolution (CXfoObjPtr pXfoObj, int newVal)

Effective when outputting to PDF.

long xfo_getPdfLinearize (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfLinearize (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to PDF.

EMBEDALLFONT xfo_getPdfEmbedAllFontsEx (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfEmbedAllFontsEx (CXfoObjPtr pXfoObj, EMBEDALLFONT newVal)

Effective when outputting to PDF.

IMAGEDOWNSAMPLING xfo_getPdfImageDownSampling (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfImageDownSampling (CXfoObjPtr pXfoObj, IMAGEDOWNSAMPLING newVal)

Effective when outputting to PDF.

int xfo_getPdfImageDownSamplingTarget (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfImageDownSamplingTarget (CXfoObjPtr pXfoObj, int newVal)

Effective when outputting to PDF.

int xfo_getPdfImageDownSamplingDPI (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfImageDownSamplingDPI (CXfoObjPtr pXfoObj, int newVal)

Effective when outputting to PDF.

long xfo_getPdfPutImageColorProfile (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfPutImageColorProfile (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to PDF.

PDFIMAGECOMPRESSION xfo_getPdfGrayscaleImageCompression (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfGrayscaleImageCompression (CXfoObjPtr pXfoObj, PDFIMAGECOMPRESSION newVal)

Effective when outputting to PDF.

int xfo_getPdfGrayscaleJPEGQuality (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfGrayscaleJPEGQuality (CXfoObjPtr pXfoObj, int newVal)

Effective when outputting to PDF.

IMAGEDOWNSAMPLING xfo_getPdfGrayscaleImageDownSampling (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfGrayscaleImageDownSampling (CXfoObjPtr pXfoObj, IMAGEDOWNSAMPLING newVal)

Effective when outputting to PDF.

int xfo_getPdfGrayscaleImageDownSamplingTarget (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfGrayscaleImageDownSamplingTarget (CXfoObjPtr pXfoObj, int newVal)

Effective when outputting to PDF.

int xfo_getPdfGrayscaleImageDownSamplingDPI (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfGrayscaleImageDownSamplingDPI (CXfoObjPtr pXfoObj, int newVal)

Effective when outputting to PDF.

MONOCHROMECOMPRESSION xfo_getPdfMonochromeImageCompression (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfMonochromeImageCompression (CXfoObjPtr pXfoObj, MONOCHROMECOMPRESSION newVal)

Effective when outputting to PDF.

IMAGEDOWNSAMPLING xfo_getPdfMonochromeImageDownSampling (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfMonochromeImageDownSampling (CXfoObjPtr pXfoObj, IMAGEDOWNSAMPLING newVal)

Effective when outputting to PDF.

int xfo_getPdfMonochromeImageDownSamplingTarget (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfMonochromeImageDownSamplingTarget (CXfoObjPtr pXfoObj, int newVal)

Effective when outputting to PDF.

int xfo_getPdfMonochromeImageDownSamplingDPI (CXfoObjPtr pXfoObj)

Effective when outputting to PDF.

void xfo_setPdfMonochromeImageDownSamplingDPI (CXfoObjPtr pXfoObj, int newVal)

Effective when outputting to PDF.

SVGVERSION xfo_getSvgVersion (CXfoObjPtr pXfoObj)

Effective when outputting to SVG.

void xfo_setSvgVersion (CXfoObjPtr pXfoObj, SVGVERSION newVal)

Effective when outputting to SVG.

long xfo_getSvgGzipCompression (CXfoObjPtr pXfoObj)

Effective when outputting to SVG.

void xfo_setSvgGzipCompression (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to SVG.

long xfo_getSvgEmbedAllFonts (CXfoObjPtr pXfoObj)

Effective when outputting to SVG.

void xfo_setSvgEmbedAllFonts (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to SVG.

char * xfo_getSvgFormat (CXfoObjPtr pXfoObj, char *pVal, int size)

Effective when outputting to SVG.

wchar_t * xfo_getSvgFormatW (CXfoObjPtr pXfoObj, wchar_t *pVal, int size)

Effective when outputting to SVG.

void xfo_setSvgFormat (CXfoObjPtr pXfoObj, const char *newVal)

Effective when outputting to SVG.

void xfo_setSvgFormatW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Effective when outputting to SVG.

char * xfo_getSvgEmbedFonts (CXfoObjPtr pXfoObj, char *pVal, int size)

Effective when outputting to SVG.

wchar_t * xfo_getSvgEmbedFontsW (CXfoObjPtr pXfoObj, wchar_t *pVal, int size)

Effective when outputting to SVG.

void xfo_setSvgEmbedFonts (CXfoObjPtr pXfoObj, const char *newVal)

Effective when outputting to SVG.

void xfo_setSvgEmbedFontsW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Effective when outputting to SVG.

long xfo_getSvgErrorOnEmbedFault (CXfoObjPtr pXfoObj)

Effective when outputting to SVG.

void xfo_setSvgErrorOnEmbedFault (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to SVG.

IMAGECONVERSION xfo_getSvgImageConversion (CXfoObjPtr pXfoObj)

Effective when outputting to SVG.

void xfo_setSvgImageConversion (CXfoObjPtr pXfoObj, IMAGECONVERSION newVal)

Effective when outputting to SVG.

int xfo_getSvgJPEGQuality (CXfoObjPtr pXfoObj)

Gets the value of the quality of JPEG format that is specified by xfo_setSvgImageConversion() stored in SVG.

void xfo_setSvgJPEGQuality (CXfoObjPtr pXfoObj, int newVal)

Effective when outputting to SVG.

IMAGEPROCTYPE xfo_getSvgImageProcessingType (CXfoObjPtr pXfoObj)

Effective when outputting to SVG.

void xfo_setSvgImageProcessingType (CXfoObjPtr pXfoObj, IMAGEPROCTYPE newVal)

Effective when outputting to SVG.

char * xfo_getSvgImageCopyPath (CXfoObjPtr pXfoObj, char *pVal, int size)

Effective when outputting to SVG.

void xfo_setSvgImageCopyPath (CXfoObjPtr pXfoObj, const char *newVal)

Effective when outputting to SVG.

wchar_t * xfo_getSvgImageCopyPathW (CXfoObjPtr pXfoObj, wchar_t *pVal, int size)

Effective when outputting to SVG.

void xfo_setSvgImageCopyPathW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Effective when outputting to SVG.

long xfo_getSvgSingleFile (CXfoObjPtr pXfoObj)

Effective when outputting to SVG.

void xfo_setSvgSingleFile (CXfoObjPtr pXfoObj, long newVal)

Effective when outputting to SVG.

bool xfo_getSvgImageRename (CXfoObjPtr pXfoObj)

Effective when outputting to SVG.

void xfo_setSvgImageRename (CXfoObjPtr pXfoObj, bool newVal)

Effective when outputting to SVG.

char * xfo_getSvgImagePrefix (CXfoObjPtr pXfoObj, char *pVal, int size)

Effective when outputting to SVG.

void xfo_setSvgImagePrefix (CXfoObjPtr pXfoObj, const char *newVal)

Effective when outputting to SVG.

wchar_t * xfo_getSvgImagePrefixW (CXfoObjPtr pXfoObj, wchar_t *pVal, int size)

Effective when outputting to SVG.

void xfo_setSvgImagePrefixW (CXfoObjPtr pXfoObj, const wchar_t *newVal)

Effective when outputting to SVG.

bool xfo_getSvgSinglePageNumber (CXfoObjPtr pXfoObj)

Effective when outputting to SVG.

void xfo_setSvgSinglePageNumber (CXfoObjPtr pXfoObj, bool newVal)

Effective when outputting to SVG.

int xfo_getSvgRasterizeResolution (CXfoObjPtr pXfoObj)

Effective when outputting to SVG.

void xfo_setSvgRasterizeResolution (CXfoObjPtr pXfoObj, int newVal)

Effective when outputting to SVG.

long xfo_getStartVolume (CXfoObjPtr pXfoObj)

Get the start volume of document to output.

void xfo_setStartVolume (CXfoObjPtr pXfoObj, long newVal)

Specifies the start volume of document to output.

long xfo_getEndVolume (CXfoObjPtr pXfoObj)

Get the end volume of document to output.

void xfo_setEndVolume (CXfoObjPtr pXfoObj, long newVal)

Specifies the end volume of document to output.

long xfo_getMultiVolume (CXfoObjPtr pXfoObj)

Get multiple volume of PDF output.

long xfo_getTotalVolumeCount (CXfoObjPtr pXfoObj)

Gets the number of all the separate volumes when outputting PDF to multiple separate volumes.

long xfo_getOutputVolumeCount (CXfoObjPtr pXfoObj)

Gets the number of the actual separate volumes when outputting PDF to multiple separate volumes.

void xfo_setMultiVolume (CXfoObjPtr pXfoObj, long newVal)

Specifies multiple volume of PDF output.

XfoIfErrorLevel xfo_getExitLevel (CXfoObjPtr pXfoObj)

Get the error level to abort formatting process.

void xfo_setExitLevel (CXfoObjPtr pXfoObj, XfoIfErrorLevel newVal)

Error level to abort formatting process.

XfoIfErrorLevel xfo_getErrorLevel (CXfoObjPtr pXfoObj)

Returns the error level of the error that occurred during the formatting process.

XfoIfErrorCode xfo_getErrorCode (CXfoObjPtr pXfoObj)

Returns the error code of the error that occurred during the formatting process.

char * xfo_getErrorMessage (CXfoObjPtr pXfoObj, char *pVal, int size)

Returns the error message of the error that occurred during the formatting process.

wchar_t * xfo_getErrorMessageW (CXfoObjPtr pXfoObj, wchar_t *pVal, int size)

Returns the error message of the error that occurred during the formatting process.

void xfo_setFontAlias (CXfoObjPtr pXfoObj, const char *src, const char *dst)

Sets the substitution of font name.

void xfo_setFontAliasW (CXfoObjPtr pXfoObj, const wchar_t *src, const wchar_t *dst)

Sets the substitution of font name.

void xfo_clearFontAlias (CXfoObjPtr pXfoObj)

Clear all substitutions of font name.

void xfo_eraseFontAlias (CXfoObjPtr pXfoObj, const char *src)

Erase the substitution of font name 'fontName'.

void xfo_eraseFontAliasW (CXfoObjPtr pXfoObj, const wchar_t *src)

XfoIfErrorCode xfo_execute (CXfoObjPtr pXfoObj)

Execute formatting and output to a PDF specified in OutputFilePath or printer specified in PrinterName.

void xfo_clear (CXfoObjPtr pXfoObj)

Initialize formatting engine.

void xfo_setOnMessageProc (CXfoObjPtr pXfoObj, XfoOnMessageProc *proc)

Specifies the callback fucntion.

void xfo_setOnMessageProcW (CXfoObjPtr pXfoObj, XfoOnMessageProcW *proc)

Specifies the callback fucntion.

Detailed Description

XSL Formatter V3 C Interface.

Author:: Antenna House, Inc.

Define Documentation

#define XFOINTERFACE_API

Typedef Documentation

typedef long XfoIfErrorCode

Error Code.

typedef void* CXfoObjPtr

Pointer to XfoObj instance.

typedef void( XfoOnMessageProc)(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const char* errMessage)

Error callback handler.

typedef void( XfoOnMessageProcW)(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const wchar_t* errMessage)

typedef void( XfoOnFormatPageProc)(long pageNo)

Enumeration Type Documentation

enum XfoIfErrorLevel

Error Level.

Enumeration values:

ELVL_NORMAL

ELVL_INFORMATION

ELVL_WARNING

ELVL_RECOVERABLE

ELVL_FATAL

enum XfoErrorStreamType

Error Stream Type for MessageListener.

Enumeration values:

EST_NONE

EST_STDOUT

EST_STDERR

enum PDFVERSION

PDF version.

Enumeration values:

PDF_13

PDF_14

PDF_15

enum PDFENCRYPTLEVEL

PDF encrypt level.

Enumeration values:

ENCLEVEL_40

ENCLEVEL_128

enum PDFPRINTALLOW

PDF print allow.

Enumeration values:

PRALLOW_NONE

PRALLOW_LOW

PRALLOW_HIGH

enum PDFIMAGECOMPRESSION

PDF image compression.

Enumeration values:

IMGCMPR_AUTO

IMGCMPR_JPEG

IMGCMPR_ZLIB

IMGCMPR_JPEG2K

enum PDFRGBCONVERSION

PDF RGB conversion.

Enumeration values:

RGBCONV_NONE

RGBCONV_BLACK

RGBCONV_GRAY

RGBCONV_ALL

enum EMBEDALLFONT

Embed font.

Enumeration values:

EMBALLFONT_PART

EMBALLFONT_ALL

EMBALLFONT_BASE14

enum IMAGEDOWNSAMPLING

Image downsampling.

Enumeration values:

IMGDOWNSAMPLING_NONE

IMGDOWNSAMPLING_AVERAGE

IMGDOWNSAMPLING_BICUBIC

IMGDOWNSAMPLING_SUBSAMPLING

enum MONOCHROMECOMPRESSION

Monochrome compression.

Enumeration values:

MONOCMPR_CCITT4

MONOCMPR_CCITT3

MONOCMPR_RUNLENGTH

MONOCMPR_ZLIB

MONOCMPR_OFF

enum SVGVERSION

SVG version.

Enumeration values:

SVG_11

SVG_Basic

SVG_Tiny

enum IMAGEPROCTYPE

Image processing.

Enumeration values:

IMGPT_EMBED_ALL

IMGPT_COPY_ALL

IMGPT_LINK

IMGPT_COPY

enum IMAGECONVERSION

Image conversion.

Enumeration values:

IMGCNV_AUTO

IMGCNV_JPEG

IMGCNV_PNG

Function Documentation

CXfoObjPtr xfo_createXfoObject ( )

Create instance of XfoObj.

Returns:
Pointer to XfoObj instance.

void xfo_releaseXfoObject ( CXfoObjPtr pXfoObj )

Release instance of XfoObj.

Parameters:

pXfoObj Pointer to XfoObj instance.

char* xfo_getDocumentURI ( CXfoObjPtr pXfoObj,

char * pVal,

int size

)

Get the URL of XML document you will format.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

wchar_t* xfo_getDocumentURIW ( CXfoObjPtr pXfoObj,

wchar_t * pVal,

int size

)

Get the URL of XML document you will format.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

void xfo_setDocumentURI ( CXfoObjPtr pXfoObj,

const char * newVal

)

Specifies the URL of XML document you will format.
If it is omitted or "@STDIN" is specified, XML document is loaded from stdin. The document loaded from stdin are supposed to be FO files.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the URL of XSL document.

void xfo_setDocumentURIW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Specifies the URL of XML document you will format.
If it is omitted or "@STDIN" is specified, XML document is loaded from stdin. The document loaded from stdin are supposed to be FO files.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the URL of XSL document.

char* xfo_getStylesheetURI ( CXfoObjPtr pXfoObj,

char * pVal,

int size

)

Get the URI of XSL stylesheet for formatting.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

wchar_t* xfo_getStylesheetURIW ( CXfoObjPtr pXfoObj,

wchar_t * pVal,

int size

)

Get the URI of XSL stylesheet for formatting.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

void xfo_setStylesheetURI ( CXfoObjPtr pXfoObj,

const char * newVal

)

Specifies the URI of XSL stylesheet for formatting.
If the specified XML document is FO, or the XML file contains the processing instruction <?xml-stylesheet ...?> and the XSL stylesheet is specified, this setting is ignored. Otherwise if there is no setting of this property, an error occurs.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the URL of XSL stylesheet.

void xfo_setStylesheetURIW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Specifies the URI of XSL stylesheet for formatting.
If the specified XML document is FO, or the XML file contains the processing instruction <?xml-stylesheet ...?> and the XSL stylesheet is specified, this setting is ignored. Otherwise if there is no setting of this property, an error occurs.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the URL of XSL stylesheet.

char* xfo_getOutputFilePath ( CXfoObjPtr pXfoObj,

char * pVal,

int size

)

Get the path name of the output file.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

wchar_t* xfo_getOutputFilePathW ( CXfoObjPtr pXfoObj,

wchar_t * pVal,

int size

)

Get the path name of the output file.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

void xfo_setOutputFilePath ( CXfoObjPtr pXfoObj,

const char * newVal

)

Specifies the path name of the output file.
When "@STDOUT" is specified, it is considered as stdout. If both the printer name and this property are specified, the formatted result will be stored in the file by the printer driver. When "@PDF" is specified as output, the PDF is stored in the file specified by this property. If the property is not specified, it is considered as stdout.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the path name of the output file.

void xfo_setOutputFilePathW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Specifies the path name of the output file.
When "@STDOUT" is specified, it is considered as stdout. If both the printer name and this property are specified, the formatted result will be stored in the file by the printer driver. When "@PDF" is specified as output, the PDF is stored in the file specified by this property. If the property is not specified, it is considered as stdout.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the path name of the output file.

char* xfo_getOptionFileURI ( CXfoObjPtr pXfoObj,

char * pVal,

int size,

int n

)

Get the path name of XML-format Option setting file which describes XSL Formatter options.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

n Specifies to get n-th URI. 0 means first URI.

Returns:
Returns the 'pVal'.

wchar_t* xfo_getOptionFileURIW ( CXfoObjPtr pXfoObj,

wchar_t * pVal,

int size,

int n

)

Get the path name of XML-format Option setting file which describes XSL Formatter options.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

n Specifies to get n-th URI. 0 means first URI.

Returns:
Returns the 'pVal'.

void xfo_setOptionFileURI ( CXfoObjPtr pXfoObj,

const char * newVal

)

Specifies the path name of XML-format Option setting file which describes XSL Formatter options.
The set of former URIs is thrown away.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.

void xfo_setOptionFileURIW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Specifies the path name of XML-format Option setting file which describes XSL Formatter options.
The set of former URIs is thrown away.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.

void xfo_addOptionFileURI ( CXfoObjPtr pXfoObj,

const char * newVal

)

Append the path name of XML-format Option setting file which describes XSL Formatter options.

Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.

void xfo_addOptionFileURIW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Append the path name of XML-format Option setting file which describes XSL Formatter options.

Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.

int xfo_getOptionFileCount ( CXfoObjPtr pXfoObj )

Get the number of URIs of XML-format Option setting file which describes XSL Formatter options.

Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
Returns the number of URIs.

char* xfo_getOutputFOPath ( CXfoObjPtr pXfoObj,

char * pVal,

int size

)

Get the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

wchar_t* xfo_getOutputFOPathW ( CXfoObjPtr pXfoObj,

wchar_t * pVal,

int size

)

Get the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

void xfo_setOutputFOPath ( CXfoObjPtr pXfoObj,

const char * newVal

)

Specifies the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
If the input file is FO, no file is outputted. When "@STDOUT" is specified, it is considered as stdout. If the setting is omitted, nothing outputs.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the path name of output FO file.

void xfo_setOutputFOPathW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Specifies the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
If the input file is FO, no file is outputted. When "@STDOUT" is specified, it is considered as stdout. If the setting is omitted, nothing outputs.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the path name of output FO file.

char* xfo_getExternalXSLT ( CXfoObjPtr pXfoObj,

char * pVal,

int size

)

Get the command line of External XSLT Processor.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

wchar_t* xfo_getExternalXSLTW ( CXfoObjPtr pXfoObj,

wchar_t * pVal,

int size

)

Get the command line of External XSLT Processor.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

void xfo_setExternalXSLT ( CXfoObjPtr pXfoObj,

const char * newVal

)

Specifies the command line of External XSLT Processor.
If this is omitted, default MSXML3 will be used. For example:
xslt %param -o %3 %1 %2

These meanings are as follows.
%1 : XML Document %2 : XSL Stylesheet %3 : XSLT Output File %param : xsl:param
%1 to %3 are used to express only parameter positions. Do not replace them actual file names. In case you use XSL:param for external XSLT processor, set the parameter in XSLTParamFormat and SetXSLTParam.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the command line of External XSLT Processor.

void xfo_setExternalXSLTW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Specifies the command line of External XSLT Processor.
If this is omitted, default MSXML3 will be used. For example:
xslt %param -o %3 %1 %2

These meanings are as follows.
%1 : XML Document %2 : XSL Stylesheet %3 : XSLT Output File %param : xsl:param
%1 to %3 are used to express only parameter positions. Do not replace them actual file names. In case you use XSL:param for external XSLT processor, set the parameter in XSLTParamFormat and SetXSLTParam.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the command line of External XSLT Processor.

char* xfo_getBaseURI ( CXfoObjPtr pXfoObj,

char * pVal,

int size

)

Get the default base URI.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

wchar_t* xfo_getBaseURIW ( CXfoObjPtr pXfoObj,

wchar_t * pVal,

int size

)

Get the default base URI.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

void xfo_setBaseURI ( CXfoObjPtr pXfoObj,

const char * newVal

)

Specifies the default base URI.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the default base URI.

void xfo_setBaseURIW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Specifies the default base URI.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the default base URI.

char* xfo_getXSLTParamFormat ( CXfoObjPtr pXfoObj,

char * pVal,

int size

)

Get the parameter format of xsl:param when using External XSLT Processor.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

wchar_t* xfo_getXSLTParamFormatW ( CXfoObjPtr pXfoObj,

wchar_t * pVal,

int size

)

Get the parameter format of xsl:param when using External XSLT Processor.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

void xfo_setXSLTParamFormat ( CXfoObjPtr pXfoObj,

const char * newVal

)

Specifies the parameter format of xsl:param when using External XSLT Processor.
For example:
-p %p %v

These meanings are as follows.
%p : Parameter Name %v : Parameter Value

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the parameter format of xsl:param when using External XSLT Processor.

void xfo_setXSLTParamFormatW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Specifies the parameter format of xsl:param when using External XSLT Processor.
For example:
-p %p %v

These meanings are as follows.
%p : Parameter Name %v : Parameter Value

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the parameter format of xsl:param when using External XSLT Processor.

long xfo_getStartPage ( CXfoObjPtr pXfoObj )

Get the start page number of document to output.

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
start page number of output.

void xfo_setStartPage ( CXfoObjPtr pXfoObj,

long newVal

)

Specifies the start page number of document to output.
If the start page is omitted or the specified value is 0 or less, the start page is considered from the first page. If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal start page number of output.

long xfo_getEndPage ( CXfoObjPtr pXfoObj )

Get the end page number of document to output.

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
end page number of output.

void xfo_setEndPage ( CXfoObjPtr pXfoObj,

long newVal

)

Specifies the end page number of document to output.
If the end page is omitted or the specified value exceeds the actual page number, the end page is considered as the last page. If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal end page number of output.

void xfo_setPdfMasterPassword ( CXfoObjPtr pXfoObj,

const char * newVal

)

Effective when outputting to PDF.
Specifies the master password for PDF. The password must be within 32 bytes.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the master password.

void xfo_setPdfMasterPasswordW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Effective when outputting to PDF.
Specifies the master password for PDF. The password must be within 32 bytes.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the master password.

void xfo_setPdfUserPassword ( CXfoObjPtr pXfoObj,

const char * newVal

)

Effective when outputting to PDF.
Specifies the user password for PDF. The password must be within 32 bytes.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the user password.

void xfo_setPdfUserPasswordW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Effective when outputting to PDF.
Specifies the user password for PDF. The password must be within 32 bytes.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the user password.

void xfo_setPdfNoPrinting ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to PDF.
Disables printing the PDF file.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If nonezero is specified, Disables printing the PDF file.

long xfo_getPdfNoPrinting ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Get disables printing the PDF file.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
If zero is returned, Enables printing the PDF file. If nonezero is returned, Disables printing the PDF file.

void xfo_setPdfNoChanging ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to PDF.
Disables making changes of the PDF file.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If nonezero is specified, Disables making changes of the PDF file.

long xfo_getPdfNoChanging ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Get disables making changes of the PDF file.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
If zero is returned, Enables making changes of the PDF file. If nonezero is returned, Disables making changes of the PDF file.

void xfo_setPdfNoContentCopying ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to PDF.
Disables copying the content of the PDF file.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If nonezero is specified, Disables copying the content of the PDF file.

long xfo_getPdfNoContentCopying ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Get disables copying the content of the PDF file.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
If zero is returned, Enables copying the content of the PDF file. If nonezero is returned, Disables copying the content of the PDF file.

void xfo_setPdfNoAddingOrChangingCommnets ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to PDF.
Disables adding comments and form fields to the PDF file.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If nonezero is specified, Disables adding comments and form fields to the PDF file.

long xfo_getPdfNoAddingOrChangingCommnets ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Get disables adding comments and form fields to the PDF file.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
If zero is returned, Enables adding comments and form fields to the PDF file. If nonezero is returned, Disables adding comments and form fields to the PDF file.

void xfo_setPdfNoAddingOrChangingComments ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to PDF.
Disables adding comments and form fields to the PDF file.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If nonezero is specified, Disables adding comments and form fields to the PDF file.

long xfo_getPdfNoAddingOrChangingComments ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Get disables adding comments and form fields to the PDF file.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
If zero is returned, Enables adding comments and form fields to the PDF file. If nonezero is returned, Disables adding comments and form fields to the PDF file.

void xfo_setPdfVersion ( CXfoObjPtr pXfoObj,

PDFVERSION newVal

)

Effective when outputting to PDF.
Enables specifying whether the version of PDF is 1.3, 1.4 or 1.5.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Specifies the version of PDF.

PDFVERSION xfo_getPdfVersion ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Get the version of PDF.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the version of PDF.

void xfo_setPdfNoFillForm ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to PDF.
Disables filling in of form fields and signing of the PDF file. This parameter is effective only when you specify PDF1.4 or later to PDF version.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If nonezero is specified, Disables filling in of form fields and signing of the PDF file.

long xfo_getPdfNoFillForm ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Get disables filling in of form fields and signing of the PDF file.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
If zero is returned, Enables filling in of form fields and signing of the PDF file. If nonezero is returned, Disables filling in of form fields and signing of the PDF file.

void xfo_setPdfNoAccessibility ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to PDF.
Disables text access for screen reader devices of the PDF file. This parameter is effective only when you specify 1.4 or later with PDF version.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If nonezero is specified, Disables text access for screen reader devices of the PDF file.

long xfo_getPdfNoAccessibility ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Get disables text access for screen reader devices of the PDF file.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
If zero is returned, Enables text access for screen reader devices of the PDF file. If nonezero is returned, Disables text access for screen reader devices of the PDF file.

void xfo_setPdfNoAssembleDoc ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to PDF.
Disables inserting, deleting and rotating the PDF pages. This parameter is effective only when you specify 1.4 or later with PDF version
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If nonezero is specified, Disables inserting, deleting and rotating the PDF pages.

long xfo_getPdfNoAssembleDoc ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Get disables inserting, deleting and rotating the PDF pages.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
If zero is returned, Enables inserting, deleting and rotating the PDF pages. If nonezero is returned, Disables inserting, deleting and rotating the PDF pages.

void xfo_setPdfEncryptLevel ( CXfoObjPtr pXfoObj,

PDFENCRYPTLEVEL newVal

)

Effective when outputting to PDF.
Specifies the key length when encrypting the PDF file during outputting. The key length can be specified as either 40 or 128 (bit). This parameter is effective only when you specify PDF1.4 or later with PDF version
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Specifies the key length.

PDFENCRYPTLEVEL xfo_getPdfEncryptLevel ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Get the key length when encrypting the PDF file during outputting.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the key length.

long xfo_getPdfEmbedAllFonts ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of whether to embed all embeddable fonts in PDF.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of whether to embed all embeddable fonts

void xfo_setPdfEmbedAllFonts ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to PDF.
Embeds all embeddable fonts in PDF to create.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If the value is 'true' is specified, Embeds all embeddable fonts

char* xfo_getPdfEmbedFonts ( CXfoObjPtr pXfoObj,

char * pVal,

int size

)

Effective when outputting to PDF.
Gets the font specified to be embedded in PDF.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

wchar_t* xfo_getPdfEmbedFontsW ( CXfoObjPtr pXfoObj,

wchar_t * pVal,

int size

)

Effective when outputting to PDF.
Gets the font specified to be embedded in PDF.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

void xfo_setPdfEmbedFonts ( CXfoObjPtr pXfoObj,

const char * newVal

)

Effective when outputting to PDF.
Embeds the specified font in PDF to create. If you want to specify plural fonts, put commas between fonts.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal fonts specified to embed

void xfo_setPdfEmbedFontsW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Effective when outputting to PDF.
Embeds the specified font in PDF to create. If you want to specify plural fonts, put commas between fonts.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal fonts specified to embed

long xfo_getPdfErrorOnEmbedFault ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of whether to issues the error when failing to embed fonts.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of whether to issues the error

void xfo_setPdfErrorOnEmbedFault ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to PDF.
an error is issued in case of failing to embed fonts.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If the value is 'true' is specified, an error is issued.

PDFPRINTALLOW xfo_getPdfPrintingAllowed ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of whether to print the resulting PDF file or not.
Since:
3.1

PRALLOW_NONE = 0 Not Allowed

PRALLOW_LOW = 1 Low Resolution Printing

PRALLOW_HIGH = 2 High Resolution Printing

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of printing allowed

void xfo_setPdfPrintingAllowed ( CXfoObjPtr pXfoObj,

PDFPRINTALLOW newVal

)

Effective when outputting to PDF.
Spesifies whether to permit printing PDF to create with one of the following values. This parameter is effective only when you specify PDF1.4 or later to PDF version (setPdfVersion).
Since:
3.1

PRALLOW_NONE = 0 Not Allowed

PRALLOW_LOW = 1 Low Resolution Printing

PRALLOW_HIGH = 2 High Resolution Printing

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of printing allowed

PDFIMAGECOMPRESSION xfo_getPdfImageCompression ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of how to compress the color images embedded in PDF.
Since:
3.1

IMGCMPR_AUTO = 0 Auto

IMGCMPR_JPEG = 1 JPEG compression

IMGCMPR_ZLIB = 2 ZLIB compression

IMGCMPR_JPEG2K = 3 JPEG2000 compression

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of how raster graphics are compressed and stored

void xfo_setPdfImageCompression ( CXfoObjPtr pXfoObj,

PDFIMAGECOMPRESSION newVal

)

Effective when outputting to PDF.
When the color image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.
When IMGCMPR_AUTO is selected, the process is automatically done and creates the image data according to the setting of xfo_setPdfJPEGQuality and xfo_setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected.
This is the setting for the color image. Spesify xfo_setPdfGrayscaleImageCompression for the grayscale image, and xfo_setPdfMonochromeImageCompression for the monochrome image.
Since:
3.1

IMGCMPR_AUTO = 0 Auto

IMGCMPR_JPEG = 1 JPEG compression

IMGCMPR_ZLIB = 2 ZLIB compression

IMGCMPR_JPEG2K = 3 JPEG2000 compression

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of how raster graphics are compressed and stored

int xfo_getPdfJPEGQuality ( CXfoObjPtr pXfoObj )

Gets the value of the quality of JPEG format that is specified by xfo_setPdfImageCompression() stored in PDF.

Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of the quality of JPEG format

void xfo_setPdfJPEGQuality ( CXfoObjPtr pXfoObj,

int newVal

)

Effective when outputting to PDF.
For the color image format that can not be stored directly in PDF, specifies the image quality by the numerical value within the range of 1-100 when IMGCMPR_JPEG is specified by setPdfImageCompression. The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.
CAUTION: It is not for changing the quality of a JPEG format image.
This is the setting for the color image. Spesify setPdfGrayscaleJPEGQuality for the grayscale image.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of the quality of JPEG format

long xfo_getPdfCompressContentStream ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of whether make the size of PDF smaller or not

void xfo_setPdfCompressContentStream ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to PDF.
Specifies whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If the value is 'true' is specified, make the PDF compress

long xfo_getPdfUseLaunchForRelativeURI ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of how to transform external link specified by the relative address in the PDF link.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of how to transform external link

void xfo_setPdfUseLaunchForRelativeURI ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to PDF.
Specifies whether the external link specified by the relative address is transformed into 'Open the file' or into 'World Wide Web link' in the PDF link properties.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If nonezero is specified, it is transformed to 'Open the file'. If zero is specified, it is transformed to 'World Wide Web link'

PDFRGBCONVERSION xfo_getPdfRGBConversion ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of how to convert the RGB color space (DebiceRGB) to DeviceGray.
Since:
3.1

RGBCONV_NONE = 0 No Conversion

RGBCONV_BLACK = 1 Black to DeviceGray

RGBCONV_GRAY = 2 Gray to DeviceGray

RGBCONV_ALL = 3 All RGB to DeviceGray

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of how to convert

void xfo_setPdfRGBConversion ( CXfoObjPtr pXfoObj,

PDFRGBCONVERSION newVal

)

Effective when outputting to PDF.
Specifies how to convert the RGB color space (DeviceRGB) to DeviceGray.
Since:
3.1

RGBCONV_NONE = 0 No Conversion

RGBCONV_BLACK = 1 Black to DeviceGray

RGBCONV_GRAY = 2 Gray to DeviceGray

RGBCONV_ALL = 3 All RGB to DeviceGray

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of how to convert

int xfo_getPdfRasterizeResolution ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of the rasterised-resolution of the transformed raster images.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
Rasterised-resolution

void xfo_setPdfRasterizeResolution ( CXfoObjPtr pXfoObj,

int newVal

)

Effective when outputting to PDF.
Specifies the value of the rasterised-resolution of the transformed raster images in the range from 70 to 500(dpi). SVG, EMF and WMF are drawn in PDF as vectors without being transformed to raster images. This setting is effective only with Windows version.
Since:
3.1

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Rasterised-resolution (70 to 500)

long xfo_getPdfLinearize ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of whether to output linearize PDF or not.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of whether to output linearize pdf or not.

void xfo_setPdfLinearize ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to PDF.
Specifies whether to output linearize PDF or not.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If the value is 'true' is specified, output linearlize PDF.

EMBEDALLFONT xfo_getPdfEmbedAllFontsEx ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of whether to embed all embeddable fonts
Since:
3.3

EMBALLFONT_PART = 0 Specified fonts

EMBALLFONT_ALL = 1 All fonts except Base14 fonts

EMBALLFONT_BASE14 = 2 All fonts

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of whether to embed all embeddable fonts

void xfo_setPdfEmbedAllFontsEx ( CXfoObjPtr pXfoObj,

EMBEDALLFONT newVal

)

Effective when outputting to PDF.
Specifies whether to embed the all outline data of fonts in PDF or not with one of the following values, which are True type fonts and Type1 Fonts and are embeddable in the formatted result.
Since:
3.3

EMBALLFONT_PART = 0 Specified fonts

EMBALLFONT_ALL = 1 All fonts except Base14 fonts

EMBALLFONT_BASE14 = 2 All fonts

If the value is EMBALLFONT_PART, only fonts specified in xfo_setPdfEmbedFonts are embedded. If the value is EMBALLFONT_ALL, all fonts that can be embedded except Base 14 fonts will be embedded. If the value is EMBALLFONT_BASE14, all fonts including Base 14 fonts that can be embedded will be embedded.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of whether to embed all embeddable fonts

IMAGEDOWNSAMPLING xfo_getPdfImageDownSampling ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of method to downsample the color image
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of method to downsample the color image

void xfo_setPdfImageDownSampling ( CXfoObjPtr pXfoObj,

IMAGEDOWNSAMPLING newVal

)

Effective when outputting to PDF.
Specifies the following either of method to downsample the color image that is put into PDF.
Since:
3.3

IMGDOWNSAMPLING_NONE = 0 No downsampling

IMGDOWNSAMPLING_AVERAGE = 1 Average downsamplin

IMGDOWNSAMPLING_BICUBIC = 2 Bicubic downsampling

IMGDOWNSAMPLING_SUBSAMPLING = 3 Subsampling

When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by xfo_setPdfImageDownSamplingDPI will be downsampled into the resolution specified by xfo_setPdfImageDownSamplingTarget. This is the setting for the color image. Spesify xfo_setPdfGrayscaleImageDownSampling for the grayscale image, and xfo_setPdfMonochromeImageDownSampling for the monochrome image.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of method to downsample the color image

int xfo_getPdfImageDownSamplingTarget ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets resolution when the color image is downsampled.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of resolution.

void xfo_setPdfImageDownSamplingTarget ( CXfoObjPtr pXfoObj,

int newVal

)

Effective when outputting to PDF.
Set resolution when the color image is downsampled.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of resolution.

int xfo_getPdfImageDownSamplingDPI ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets resolution of the color image which performs a downsampling.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of resolution.

void xfo_setPdfImageDownSamplingDPI ( CXfoObjPtr pXfoObj,

int newVal

)

Effective when outputting to PDF.
Set resolution of the color image which performs a downsampling.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of resolution.

long xfo_getPdfPutImageColorProfile ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets specification whether to embed to PDF the color profile of the color image that will be embedded to PDF.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
If nonezero is specified, it is embedded. If zero is specified, it is not embedded.

void xfo_setPdfPutImageColorProfile ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to PDF.
Specifies whether to embed to PDF the color profile of the color image that will be embedded to PDF.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If nonezero is specified, it is embedded. If zero is specified, it is not embedded.

PDFIMAGECOMPRESSION xfo_getPdfGrayscaleImageCompression ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of how to compress the grayscale images embedded in PDF.
Since:
3.3

IMGCMPR_AUTO = 0 Auto

IMGCMPR_JPEG = 1 JPEG compression

IMGCMPR_ZLIB = 2 ZLIB compression

IMGCMPR_JPEG2K = 3 JPEG2000 compression

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of how raster graphics are compressed and stored

void xfo_setPdfGrayscaleImageCompression ( CXfoObjPtr pXfoObj,

PDFIMAGECOMPRESSION newVal

)

Effective when outputting to PDF.
When the grayscale image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.
When IMGCMPR_AUTO is selected, the process is automatically done and creates the image data according to the setting of xfo_setPdfGrayscaleJPEGQuality and xfo_setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected.
This is the setting for the grayscale image. Spesify xfo_setPdfImageCompression for the color image, and xfo_setPdfMonochromeImageCompression for the monochrome image.
Since:
3.3

IMGCMPR_AUTO = 0 Auto

IMGCMPR_JPEG = 1 JPEG compression

IMGCMPR_ZLIB = 2 ZLIB compression

IMGCMPR_JPEG2K = 3 JPEG2000 compression

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of how raster graphics are compressed and stored

int xfo_getPdfGrayscaleJPEGQuality ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of the quality of JPEG format that is specified by xfo_setPdfGrayscaleImageCompression stored in PDF.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of the quality of JPEG format

void xfo_setPdfGrayscaleJPEGQuality ( CXfoObjPtr pXfoObj,

int newVal

)

Effective when outputting to PDF.
For the grayscale image format that can not be stored directly in PDF, specifies the image quality by the numerical value within the range of 1-100 when IMGCMPR_JPEG is specified by xfo_setPdfGrayscaleImageCompression. The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.
CAUTION: It is not for changing the quality of a JPEG format image.
This is the setting for the grayscale image. Spesify xfo_setPdfJPEGQuality for the color image.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of the quality of JPEG format

IMAGEDOWNSAMPLING xfo_getPdfGrayscaleImageDownSampling ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of method to downsample the grayscale image
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of method to downsample the grayscale image

void xfo_setPdfGrayscaleImageDownSampling ( CXfoObjPtr pXfoObj,

IMAGEDOWNSAMPLING newVal

)

Effective when outputting to PDF.

Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal

int xfo_getPdfGrayscaleImageDownSamplingTarget ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets resolution when the grayscale image is downsampled.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of resolution.

void xfo_setPdfGrayscaleImageDownSamplingTarget ( CXfoObjPtr pXfoObj,

int newVal

)

Effective when outputting to PDF.
Specifies the following either of method to downsample the grayscale image that is put into PDF.
Since:
3.3

IMGDOWNSAMPLING_NONE = 0 No downsampling

IMGDOWNSAMPLING_AVERAGE = 1 Average downsamplin

IMGDOWNSAMPLING_BICUBIC = 2 Bicubic downsampling

IMGDOWNSAMPLING_SUBSAMPLING = 3 Subsampling

When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by xfo_setPdfGrayscaleImageDownSamplingDPI will be downsampled into the resolution specified by xfo_setPdfGrayscaleImageDownSamplingTarget. This is the setting for the grayscale image. Spesify xfo_setPdfImageDownSampling for the color image, and xfo_setPdfMonochromeImageDownSampling for the monochrome image.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of method to downsample the grayscale image

int xfo_getPdfGrayscaleImageDownSamplingDPI ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets resolution of the grayscale image which performs a downsampling.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of resolution.

void xfo_setPdfGrayscaleImageDownSamplingDPI ( CXfoObjPtr pXfoObj,

int newVal

)

Effective when outputting to PDF.
Set resolution of the grayscale image which performs a downsampling.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of resolution.

MONOCHROMECOMPRESSION xfo_getPdfMonochromeImageCompression ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of how to compress the monochrome images embedded in PDF.
Since:
3.3

MONOCMPR_CCITT4 = 0 CCITTFaxDecode group 4 filter,default value

MONOCMPR_CCITT3 = 1 CCITTFaxDecode group 3 filter

MONOCMPR_RUNLENGTH = 2 RunLengthDecode filter

MONOCMPR_ZLIB = 3 FlateDecode filter

MONOCMPR_OFF = 4 no filter

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of how raster graphics are compressed and stored

void xfo_setPdfMonochromeImageCompression ( CXfoObjPtr pXfoObj,

MONOCHROMECOMPRESSION newVal

)

Effective when outputting to PDF.
When the monochrome image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.
This is the setting for the monochrome image. Spesify xfo_setPdfGrayscaleImageCompression for the grayscale image, and xfo_setPdfImageCompression for the color image.
Since:
3.3

MONOCMPR_CCITT4 = 0 CCITTFaxDecode group 4 filter,default value

MONOCMPR_CCITT3 = 1 CCITTFaxDecode group 3 filter

MONOCMPR_RUNLENGTH = 2 RunLengthDecode filter

MONOCMPR_ZLIB = 3 FlateDecode filter

MONOCMPR_OFF = 4 no filter

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of how raster graphics are compressed and stored

IMAGEDOWNSAMPLING xfo_getPdfMonochromeImageDownSampling ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets the value of method to downsample the monochrome image
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of method to downsample the monochrome image

void xfo_setPdfMonochromeImageDownSampling ( CXfoObjPtr pXfoObj,

IMAGEDOWNSAMPLING newVal

)

Effective when outputting to PDF.
Specifies the following either of method to downsample the monochrome image that is put into PDF.
Since:
3.3

IMGDOWNSAMPLING_NONE = 0 No downsampling

IMGDOWNSAMPLING_AVERAGE = 1 Average downsamplin

IMGDOWNSAMPLING_BICUBIC = 2 Bicubic downsampling

IMGDOWNSAMPLING_SUBSAMPLING = 3 Subsampling

When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by xfo_setPdfMonochromeImageDownSamplingDPI will be downsampled into the resolution specified by xfo_setPdfMonochromeImageDownSamplingTarget. This is the setting for the monochrome image. Spesify xfo_setPdfImageDownSampling for the color image, and xfo_setPdfGrayscaleImageDownSampling for the grayscale image.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of method to downsample the monochrome image

int xfo_getPdfMonochromeImageDownSamplingTarget ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets resolution when the monochrome image is downsampled.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of resolution.

void xfo_setPdfMonochromeImageDownSamplingTarget ( CXfoObjPtr pXfoObj,

int newVal

)

Effective when outputting to PDF.
Set resolution when the monochrome image is downsampled.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of resolution.

int xfo_getPdfMonochromeImageDownSamplingDPI ( CXfoObjPtr pXfoObj )

Effective when outputting to PDF.
Gets resolution of the monochrome image which performs a downsampling.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of resolution.

void xfo_setPdfMonochromeImageDownSamplingDPI ( CXfoObjPtr pXfoObj,

int newVal

)

Effective when outputting to PDF.
Set resolution of the monochrome image which performs a downsampling.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of resolution.

SVGVERSION xfo_getSvgVersion ( CXfoObjPtr pXfoObj )

Effective when outputting to SVG.
Get the version of SVG.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the version of SVG.

void xfo_setSvgVersion ( CXfoObjPtr pXfoObj,

SVGVERSION newVal

)

Effective when outputting to SVG.
Enables specifying whether the version of SVG is 1.1, Basic or Tiny.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Specifies the version of SVG.

long xfo_getSvgGzipCompression ( CXfoObjPtr pXfoObj )

Effective when outputting to SVG.
Gets the setting indicating whether to compress the outputted SVG into gzip format or not.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
whether gzip compression or not.

void xfo_setSvgGzipCompression ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to SVG.
Specifies whether to compress the outputted SVG into gzip format or not.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If the value is 'true' is specified, enables to compress data into gzip format.

long xfo_getSvgEmbedAllFonts ( CXfoObjPtr pXfoObj )

Effective when outputting to SVG.
Gets the setting indicating whether to embed fonts in the outputted SVG.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
whether embeds fonts or not.

void xfo_setSvgEmbedAllFonts ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to SVG.
Specifies whether to embed fonts in the outputted SVG.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If the value is 'true' is specified, embeds fonts.

char* xfo_getSvgFormat ( CXfoObjPtr pXfoObj,

char * pVal,

int size

)

Effective when outputting to SVG.
Gets the format for naming files when the outputted SVG becomes multiple.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

wchar_t* xfo_getSvgFormatW ( CXfoObjPtr pXfoObj,

wchar_t * pVal,

int size

)

Effective when outputting to SVG.
Gets the format for naming files when the outputted SVG becomes multiple.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

void xfo_setSvgFormat ( CXfoObjPtr pXfoObj,

const char * newVal

)

Effective when outputting to SVG.
Specifies the format for naming files when the outputted SVG becomes multiple.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the SVG file name format.

void xfo_setSvgFormatW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Effective when outputting to SVG.
Specifies the format for naming files when the outputted SVG becomes multiple.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as the SVG file name format.

char* xfo_getSvgEmbedFonts ( CXfoObjPtr pXfoObj,

char * pVal,

int size

)

Effective when outputting to SVG.
Gets the font specified to be embedded in SVG.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

wchar_t* xfo_getSvgEmbedFontsW ( CXfoObjPtr pXfoObj,

wchar_t * pVal,

int size

)

Effective when outputting to SVG.
Gets the font specified to be embedded in SVG.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

void xfo_setSvgEmbedFonts ( CXfoObjPtr pXfoObj,

const char * newVal

)

Effective when outputting to SVG.
Embeds the specified font in SVG to create. If you want to specify plural fonts, put commas between fonts.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal fonts specified to embed

void xfo_setSvgEmbedFontsW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Effective when outputting to SVG.
Embeds the specified font in SVG to create. If you want to specify plural fonts, put commas between fonts.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal fonts specified to embed

long xfo_getSvgErrorOnEmbedFault ( CXfoObjPtr pXfoObj )

Effective when outputting to SVG.
Gets the value of whether to issues the error when failing to embed fonts.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of whether to issues the error

void xfo_setSvgErrorOnEmbedFault ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to SVG.
an error is issued in case of failing to embed fonts.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal If the value is 'true' is specified, an error is issued.

IMAGECONVERSION xfo_getSvgImageConversion ( CXfoObjPtr pXfoObj )

Effective when outputting to SVG.
Gets the value of how to compress the images embedded in SVG.
Since:
3.3

IMGCMPR_AUTO = 0 Auto conversion

IMGCMPR_JPEG = 1 JPEG conversion

IMGCMPR_PNG = 2 PNG conversion

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of how raster graphics are compressed and stored

void xfo_setSvgImageConversion ( CXfoObjPtr pXfoObj,

IMAGECONVERSION newVal

)

Effective when outputting to SVG.
Selects how to compress the images embedded in SVG to create from the following.
Since:
3.3

IMGCMPR_AUTO = 0 Auto conversion

IMGCMPR_JPEG = 1 JPEG conversion

IMGCMPR_PNG = 2 PNG conversion

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the value of how raster graphics are compressed and stored

int xfo_getSvgJPEGQuality ( CXfoObjPtr pXfoObj )

Gets the value of the quality of JPEG format that is specified by xfo_setSvgImageConversion() stored in SVG.

Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
the value of the quality

void xfo_setSvgJPEGQuality ( CXfoObjPtr pXfoObj,

int newVal

)

Effective when outputting to SVG.
Specifies the quality of the Raster graphics when stored in JPEG format using the range of 1-100. The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger. The initial value is 80.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal JPEG quality (1 to 100)

IMAGEPROCTYPE xfo_getSvgImageProcessingType ( CXfoObjPtr pXfoObj )

Effective when outputting to SVG.
Gets specification how to treat the referred image.
Since:
3.3

IMGPT_EMBED_ALL = 0 Embeds all images to SVG.

IMGPT_COPY_ALL = 1 Copies all image files to the destination that is specified by setSvgImageCopyPath, and then links.

IMGPT_LINK = 2 Links images that have been linked, and embeds the embedded image. However, the raster images other than JPEG and PNG are always embedded.

IMGPT_COPY = 3 Copies images that have been linked to the destination that is specified by setSvgImageCopyPath, and links. The embedded image are embedded.

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
specification how to treat the referred image.

void xfo_setSvgImageProcessingType ( CXfoObjPtr pXfoObj,

IMAGEPROCTYPE newVal

)

Effective when outputting to SVG.
Specifies how to treat the referred image.
Since:
3.3

IMGPT_EMBED_ALL = 0 Embeds all images to SVG.

IMGPT_COPY_ALL = 1 Copies all image files to the destination that is specified by setSvgImageCopyPath, and then links.

IMGPT_LINK = 2 Links images that have been linked, and embeds the embedded image. However, the raster images other than JPEG and PNG are always embedded.

IMGPT_COPY = 3 Copies images that have been linked to the destination that is specified by setSvgImageCopyPath, and links. The embedded image are embedded.

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal specification how to treat the referred image.

char* xfo_getSvgImageCopyPath ( CXfoObjPtr pXfoObj,

char * pVal,

int size

)

Effective when outputting to SVG.
Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by xfo_setSvgImageProcessingType.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the image copy path. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

void xfo_setSvgImageCopyPath ( CXfoObjPtr pXfoObj,

const char * newVal

)

Effective when outputting to SVG.
Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by xfo_setSvgImageProcessingType.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as image copy path

wchar_t* xfo_getSvgImageCopyPathW ( CXfoObjPtr pXfoObj,

wchar_t * pVal,

int size

)

Effective when outputting to SVG.
Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by xfo_setSvgImageProcessingType.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the image copy path. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

void xfo_setSvgImageCopyPathW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Effective when outputting to SVG.
Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by xfo_setSvgImageProcessingType.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Pointer to a null-terminated string to be used as image copy path

long xfo_getSvgSingleFile ( CXfoObjPtr pXfoObj )

Effective when outputting to SVG.
Gets specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.

Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.

void xfo_setSvgSingleFile ( CXfoObjPtr pXfoObj,

long newVal

)

Effective when outputting to SVG.
Specifies whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.
If the value is true, outputs one SVG. If the value is false, outputs multiple SVG. When multiple SVG is output, the file name is modified by specifying format.
Effective only when outputting to the file. It is invalid in the output without the file name like the stream etc.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.

bool xfo_getSvgImageRename ( CXfoObjPtr pXfoObj )

Effective when outputting to SVG.
Gets specification whether to rename all file name to prefix specified by xfo_setSvgImagePrefix, or use original name.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
specification whether to rename all file name to prefix specified by xfo_setSvgImagePrefix, or use original name.

void xfo_setSvgImageRename ( CXfoObjPtr pXfoObj,

bool newVal

)

Effective when outputting to SVG.
When images are copied to the directory specified by xfo_setSvgImageCopyPath etc. and processed, specifies whether to rename all file name to prefix specified by xfo_setSvgImagePrefix, or use original name. When the file name overlaps, sequential number is added. When true is specified, all files are renamed.

Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal specification whether to rename all file name to prefix specified by xfo_setSvgImagePrefix, or use original name.

char* xfo_getSvgImagePrefix ( CXfoObjPtr pXfoObj,

char * pVal,

int size

)

Effective when outputting to SVG.
Gets the prefix of the file name when images are copied to the directory specified by xfo_setSvgImageCopyPath and processed.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the prefix. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

void xfo_setSvgImagePrefix ( CXfoObjPtr pXfoObj,

const char * newVal

)

Effective when outputting to SVG.
When images are copied to the directory specified by xfo_setSvgImageCopyPath and processed, specifies the prefix of the file name. The file name will be prefix with sequence numbers. Default is empty character string with only sequential numbers.

Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the prefix of the file name.

wchar_t* xfo_getSvgImagePrefixW ( CXfoObjPtr pXfoObj,

wchar_t * pVal,

int size

)

Effective when outputting to SVG.
Gets the prefix of the file name when images are copied to the directory specified by xfo_setSvgImageCopyPath and processed.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the prefix. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

void xfo_setSvgImagePrefixW ( CXfoObjPtr pXfoObj,

const wchar_t * newVal

)

Effective when outputting to SVG.
When images are copied to the directory specified by xfo_setSvgImageCopyPath and processed, specifies the prefix of the file name. The file name will be prefix with sequence numbers. Default is empty character string with only sequential numbers.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal the prefix of the file name.

bool xfo_getSvgSinglePageNumber ( CXfoObjPtr pXfoObj )

Effective when outputting to SVG.
Gets specification whether to add sequential number to the output SVG even if it has only one-page.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
specification whether to add sequential number to the output SVG even if it has only one-page.

void xfo_setSvgSinglePageNumber ( CXfoObjPtr pXfoObj,

bool newVal

)

Effective when outputting to SVG.
When xfo_setSvgSingleFile = 0 is specified, specifies whether to add sequential number to the output SVG even if it has only one-page. It is not added in case of false.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal specification whether to add sequential number to the output SVG even if it has only one-page.

int xfo_getSvgRasterizeResolution ( CXfoObjPtr pXfoObj )

Effective when outputting to SVG.
Gets the value of the rasterised-resolution of the transformed raster images.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
Rasterised-resolution

void xfo_setSvgRasterizeResolution ( CXfoObjPtr pXfoObj,

int newVal

)

Effective when outputting to SVG.
Specifies the value of the rasterised-resolution of the transformed raster images in the range from 70 to 500(dpi). SVG, EMF and WMF are drawn in SVG as vectors without being transformed to raster images. This setting is effective only with Windows version.
Since:
3.3

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Rasterised-resolution (70 to 500)

long xfo_getStartVolume ( CXfoObjPtr pXfoObj )

Get the start volume of document to output.

Since:
3.2

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
start volume of output.

void xfo_setStartVolume ( CXfoObjPtr pXfoObj,

long newVal

)

Specifies the start volume of document to output.
If the start volume is omitted or the specified value is 0 or less, the start volume is considered from the first volume. If the setting is inconsistent, (for example, StartVolume=5 EndVolume=3) an error occurs.
Since:
3.2

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal start volume of output.

long xfo_getEndVolume ( CXfoObjPtr pXfoObj )

Get the end volume of document to output.

Since:
3.2

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
end volume of output.

void xfo_setEndVolume ( CXfoObjPtr pXfoObj,

long newVal

)

Specifies the end volume of document to output.
If the end volume is omitted or the specified value exceeds the actual volume number, the end volume is considered as the last volume. If the setting is inconsistent, (for example, StartVolume=5 EndVolume=3) an error occurs.
Since:
3.2

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal end volume of output.

long xfo_getMultiVolume ( CXfoObjPtr pXfoObj )

Get multiple volume of PDF output.

Since:
3.2

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
If zero is returned, multiple volume don't specified. If nonezero is returned, multiple volume specified.

long xfo_getTotalVolumeCount ( CXfoObjPtr pXfoObj )

Gets the number of all the separate volumes when outputting PDF to multiple separate volumes.

Since:
3.2

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
Returns total volume count.

long xfo_getOutputVolumeCount ( CXfoObjPtr pXfoObj )

Gets the number of the actual separate volumes when outputting PDF to multiple separate volumes.

Since:
3.2

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
Returns output volume count.

void xfo_setMultiVolume ( CXfoObjPtr pXfoObj,

long newVal

)

Specifies multiple volume of PDF output.

Since:
3.2

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal Zpecifies zero or nonzero.

XfoIfErrorLevel xfo_getExitLevel ( CXfoObjPtr pXfoObj )

Get the error level to abort formatting process.

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
Returns the error level.

void xfo_setExitLevel ( CXfoObjPtr pXfoObj,

XfoIfErrorLevel newVal

)

Error level to abort formatting process.
XSL Formatter will stop formatting when the detected error level is equal to ExitLevel property or higher. The default value is 2 (Warning). Thus if an error occurred and error level is 2 (Warning) or higher, formatting process will be aborted. Please use the value from 1 to 4. When the value of 5 or more specified, it is considered to be the value of 4. If a error-level:4 (fatal error) occurs, the formatting process will be aborted unconditionally. BTW : An error is not displayed no matter what value may be specified to be this property.

ELVL_INFORMATION = 1 Information

ELVL_WARNING = 2 Warning

ELVL_RECOVERABLE = 3 Recoveable Error

ELVL_FATAL = 4 Fatal Error

Parameters:

pXfoObj Pointer to XfoObj instance.

newVal error level to abort formatting process.

XfoIfErrorLevel xfo_getErrorLevel ( CXfoObjPtr pXfoObj )

Returns the error level of the error that occurred during the formatting process.

ELVL_INFORMATION = 1 Information

ELVL_WARNING = 2 Warning

ELVL_RECOVERABLE = 3 Recoveable Error

ELVL_FATAL = 4 Fatal Error

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
Returns the error level.

XfoIfErrorCode xfo_getErrorCode ( CXfoObjPtr pXfoObj )

Returns the error code of the error that occurred during the formatting process.
Zero means no error. Non-zero indicates any error occurred.

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
Returns the error code.

char* xfo_getErrorMessage ( CXfoObjPtr pXfoObj,

char * pVal,

int size

)

Returns the error message of the error that occurred during the formatting process.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

wchar_t* xfo_getErrorMessageW ( CXfoObjPtr pXfoObj,

wchar_t * pVal,

int size

)

Returns the error message of the error that occurred during the formatting process.

Parameters:

pXfoObj Pointer to XfoObj instance.

pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.

size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Returns:
Returns the 'pVal'.

void xfo_setFontAlias ( CXfoObjPtr pXfoObj,

const char * src,

const char * dst

)

Sets the substitution of font name.
This substitution acts on the font names existing in FO. The font name 'fontName' is replaced to 'aliasName'.

Parameters:

pXfoObj Pointer to XfoObj instance.

src Specifies the font name which is replaced.

dst Specifies the aliasName.

void xfo_setFontAliasW ( CXfoObjPtr pXfoObj,

const wchar_t * src,

const wchar_t * dst

)

Sets the substitution of font name.
This substitution acts on the font names existing in FO. The font name 'fontName' is replaced to 'aliasName'.

Parameters:

pXfoObj Pointer to XfoObj instance.

src Specifies the font name which is replaced.

dst Specifies the aliasName.

void xfo_clearFontAlias ( CXfoObjPtr pXfoObj )

Clear all substitutions of font name.

Parameters:

pXfoObj Pointer to XfoObj instance.

void xfo_eraseFontAlias ( CXfoObjPtr pXfoObj,

const char * src

)

Erase the substitution of font name 'fontName'.

Parameters:

pXfoObj Pointer to XfoObj instance.

src Specifies the font name which is replaced.

void xfo_eraseFontAliasW ( CXfoObjPtr pXfoObj,

const wchar_t * src

)

XfoIfErrorCode xfo_execute ( CXfoObjPtr pXfoObj )

Execute formatting and output to a PDF specified in OutputFilePath or printer specified in PrinterName.

Parameters:

pXfoObj Pointer to XfoObj instance.

Returns:
Returns the error code. Zero means no error. Non-zero indicates any error occurred.

void xfo_clear ( CXfoObjPtr pXfoObj )

Initialize formatting engine.

Parameters:

pXfoObj Pointer to XfoObj instance.

void xfo_setOnMessageProc ( CXfoObjPtr pXfoObj,

XfoOnMessageProc * proc

)

Specifies the callback fucntion.
The error that occurred during the formatting process can be received.

Parameters:

pXfoObj Pointer to XfoObj instance.

proc Address of the callback function.
Callback function has the following form:
void XfoOnMessageProc(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const char* errMessage); void XfoOnMessageProcW(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const wchar_t* errMessage);

void xfo_setOnMessageProcW ( CXfoObjPtr pXfoObj,

XfoOnMessageProcW * proc

)

Specifies the callback fucntion.
The error that occurred during the formatting process can be received.

Parameters:

pXfoObj Pointer to XfoObj instance.

proc Address of the callback function.
Callback function has the following form:
void XfoOnMessageProc(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const char* errMessage); void XfoOnMessageProcW(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const wchar_t* errMessage);

Generated on 21 Nov 2005 for XSLFormatter V3.3 C++/C Interface by Doxygen 1.3-rc2