dfvifc_c.h File Reference

SBC C Interface. More...

Go to the source code of this file.

Defines

#define DFVINTERFACE_API

Typedefs

typedef long DfvIfErrorCode
 Error Code.
typedef void * CDfvObjPtr
 Pointer to DfvObj instance.
typedef void( DfvOnMessageProc )(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char *errMessage)
 Error callback handler.
typedef void( DfvOnMessageProcW )(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t *errMessage)
typedef void( DfvOnFormatPageProc )(long pageNo)
typedef void( DfvOnMessageProcEx )(void *pAnyObj, DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char *errMessage)
typedef void( DfvOnMessageProcExW )(void *pAnyObj, DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t *errMessage)
typedef void( DfvOnFormatPageProcEx )(void *pAnyObj, long pageNo)

Enumerations

enum  DfvIfErrorLevel {
  ELVL_NORMAL = 0, ELVL_INFORMATION = 1, ELVL_WARNING = 2, ELVL_RECOVERABLE = 3,
  ELVL_FATAL = 4
}
 Error Level. More...
enum  DfvErrorStreamType { EST_NONE, EST_STDOUT, EST_STDERR }
 Error Stream Type for MessageListener. More...
enum  DfvPDFVERSION {
  PDF_13, PDF_14, PDF_15, PDF_16,
  PDF_17, PDFX_1a_2001 = 101, PDFX_3_2002 = 103, PDFX_1a_2003 = 104,
  PDFX_2_2003 = 105, PDFX_3_2003 = 106, PDFA_1a_2005 = 200, PDFA_1b_2005 = 400
}
 PDF version. More...
enum  DfvPDFENCRYPTLEVEL { ENCLEVEL_40, ENCLEVEL_128 }
 PDF encrypt level. More...
enum  DfvPDFPRINTALLOW { PRALLOW_NONE, PRALLOW_LOW, PRALLOW_HIGH }
 PDF print allow. More...
enum  DfvPDFIMAGECOMPRESSION { IMGCMPR_AUTO, IMGCMPR_JPEG, IMGCMPR_ZLIB, IMGCMPR_JPEG2K }
 PDF image compression. More...
enum  DfvPDFRGBCONVERSION { RGBCONV_NONE, RGBCONV_BLACK, RGBCONV_GRAY, RGBCONV_ALL }
 PDF RGB conversion. More...
enum  DfvEMBEDALLFONT { EMBALLFONT_PART, EMBALLFONT_ALL, EMBALLFONT_BASE14 }
 Embed font. More...
enum  DfvIMAGEDOWNSAMPLING { IMGDOWNSAMPLING_NONE, IMGDOWNSAMPLING_AVERAGE, IMGDOWNSAMPLING_BICUBIC, IMGDOWNSAMPLING_SUBSAMPLING }
 Image downsampling. More...
enum  DfvMONOCHROMECOMPRESSION {
  MONOCMPR_CCITT4, MONOCMPR_CCITT3, MONOCMPR_RUNLENGTH, MONOCMPR_ZLIB,
  MONOCMPR_OFF
}
 Monochrome compression. More...
enum  DfvSVGVERSION { SVG_11, SVG_Basic, SVG_Tiny }
 SVG version. More...
enum  DfvIMAGEPROCTYPE { IMGPT_EMBED_ALL, IMGPT_COPY_ALL, IMGPT_LINK, IMGPT_COPY }
 Image processing. More...
enum  DfvIMAGECONVERSION { IMGCNV_AUTO, IMGCNV_JPEG, IMGCNV_PNG, IMGCNV_JPEGALL }
 Image conversion. More...
enum  DfvINXOUTPUTMODE { INXOM_TEXT, INXOM_LINE, INXOM_BLOCK }
 INX output mode. More...
enum  DfvMIFOUTPUTMODE { MIFOM_TEXT, MIFOM_LINE, MIFOM_BLOCK }
 MIF output mode. More...

Functions

CDfvObjPtr dfv_createDfvObject ()
 Create instance of DfvObj.
void dfv_releaseDfvObject (CDfvObjPtr pDfvObj)
 Release instance of DfvObj.
char * dfv_getDocumentURI (CDfvObjPtr pDfvObj, char *pVal, int size)
 Get the URL of XML document you will format.
wchar_t * dfv_getDocumentURIW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
 Get the URL of XML document you will format.
void dfv_setDocumentURI (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the URL of XML document you will format.
void dfv_setDocumentURIW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Specifies the URL of XML document you will format.
char * dfv_getOutputFilePath (CDfvObjPtr pDfvObj, char *pVal, int size)
 Get the path name of the output file.
wchar_t * dfv_getOutputFilePathW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
 Get the path name of the output file.
void dfv_setOutputFilePath (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the path name of the output file.
void dfv_setOutputFilePathW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Specifies the path name of the output file.
char * dfv_getOptionFileURI (CDfvObjPtr pDfvObj, char *pVal, int size, int n)
 Get the path name of XML-format Option setting file which describes Server Based Converter options.
wchar_t * dfv_getOptionFileURIW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size, int n)
 Get the path name of XML-format Option setting file which describes Server Based Converter options.
void dfv_setOptionFileURI (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the path name of XML-format Option setting file which describes Server Based Converter options.
void dfv_setOptionFileURIW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Specifies the path name of XML-format Option setting file which describes Server Based Converter options.
void dfv_addOptionFileURI (CDfvObjPtr pDfvObj, const char *newVal)
 Append the path name of XML-format Option setting file which describes Server Based Converter options.
void dfv_addOptionFileURIW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Append the path name of XML-format Option setting file which describes Server Based Converter options.
int dfv_getOptionFileCount (CDfvObjPtr pDfvObj)
 Get the number of URIs of XML-format Option setting file which describes Server Based Converter options.
long dfv_getStartPage (CDfvObjPtr pDfvObj)
 Get the start page number of document to output.
void dfv_setStartPage (CDfvObjPtr pDfvObj, long newVal)
 Specifies the start page number of document to output.
long dfv_getEndPage (CDfvObjPtr pDfvObj)
 Get the end page number of document to output.
void dfv_setEndPage (CDfvObjPtr pDfvObj, long newVal)
 Specifies the end page number of document to output.
void dfv_setPdfOwnerPassword (CDfvObjPtr pDfvObj, const char *newVal)
 Effective when outputting to PDF.
void dfv_setPdfOwnerPasswordW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Effective when outputting to PDF.
void dfv_setPdfUserPassword (CDfvObjPtr pDfvObj, const char *newVal)
 Effective when outputting to PDF.
void dfv_setPdfUserPasswordW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Effective when outputting to PDF.
void dfv_setPdfNoPrinting (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
long dfv_getPdfNoPrinting (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfNoChanging (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
long dfv_getPdfNoChanging (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfNoContentCopying (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
long dfv_getPdfNoContentCopying (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfNoAddingOrChangingCommnets (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
long dfv_getPdfNoAddingOrChangingCommnets (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfNoAddingOrChangingComments (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
long dfv_getPdfNoAddingOrChangingComments (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfVersion (CDfvObjPtr pDfvObj, DfvPDFVERSION newVal)
 Effective when outputting to PDF.
DfvPDFVERSION dfv_getPdfVersion (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfNoFillForm (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
long dfv_getPdfNoFillForm (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfNoAccessibility (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
long dfv_getPdfNoAccessibility (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfNoAssembleDoc (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
long dfv_getPdfNoAssembleDoc (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfEncryptLevel (CDfvObjPtr pDfvObj, DfvPDFENCRYPTLEVEL newVal)
 Effective when outputting to PDF.
DfvPDFENCRYPTLEVEL dfv_getPdfEncryptLevel (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
long dfv_getPdfEmbedAllFonts (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfEmbedAllFonts (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
char * dfv_getPdfEmbedFonts (CDfvObjPtr pDfvObj, char *pVal, int size)
 Effective when outputting to PDF.
wchar_t * dfv_getPdfEmbedFontsW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
 Effective when outputting to PDF.
void dfv_setPdfEmbedFonts (CDfvObjPtr pDfvObj, const char *newVal)
 Effective when outputting to PDF.
void dfv_setPdfEmbedFontsW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Effective when outputting to PDF.
long dfv_getPdfErrorOnEmbedFault (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfErrorOnEmbedFault (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
long dfv_getPdfErrorOnMissingGlyph (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfErrorOnMissingGlyph (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
DfvPDFPRINTALLOW dfv_getPdfPrintingAllowed (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfPrintingAllowed (CDfvObjPtr pDfvObj, DfvPDFPRINTALLOW newVal)
 Effective when outputting to PDF.
DfvPDFIMAGECOMPRESSION dfv_getPdfImageCompression (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfImageCompression (CDfvObjPtr pDfvObj, DfvPDFIMAGECOMPRESSION newVal)
 Effective when outputting to PDF.
int dfv_getPdfJPEGQuality (CDfvObjPtr pDfvObj)
 Gets the value of the quality of JPEG format that is specified by dfv_setPdfImageCompression() stored in PDF.
void dfv_setPdfJPEGQuality (CDfvObjPtr pDfvObj, int newVal)
 Effective when outputting to PDF.
long dfv_getPdfCompressContentStream (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfCompressContentStream (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
long dfv_getPdfUseLaunchForRelativeURI (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfUseLaunchForRelativeURI (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
DfvPDFRGBCONVERSION dfv_getPdfRGBConversion (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfRGBConversion (CDfvObjPtr pDfvObj, DfvPDFRGBCONVERSION newVal)
 Effective when outputting to PDF.
int dfv_getPdfRasterizeResolution (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfRasterizeResolution (CDfvObjPtr pDfvObj, int newVal)
 Effective when outputting to PDF.
long dfv_getPdfLinearize (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfLinearize (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
long dfv_getPdfSignature (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfSignature (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
char * dfv_getPdfSignatureName (CDfvObjPtr pDfvObj, char *pVal, int size)
 Effective when outputting to PDF.
wchar_t * dfv_getPdfSignatureNameW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
 Effective when outputting to PDF.
void dfv_setPdfSignatureName (CDfvObjPtr pDfvObj, const char *newVal)
 Effective when outputting to PDF.
void dfv_setPdfSignatureNameW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Effective when outputting to PDF.
char * dfv_getPdfCertificateName (CDfvObjPtr pDfvObj, char *pVal, int size)
 Effective when outputting to PDF.
wchar_t * dfv_getPdfCertificateNameW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
 Effective when outputting to PDF.
void dfv_setPdfCertificateName (CDfvObjPtr pDfvObj, const char *newVal)
 Effective when outputting to PDF.
void dfv_setPdfCertificateNameW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Effective when outputting to PDF.
DfvEMBEDALLFONT dfv_getPdfEmbedAllFontsEx (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfEmbedAllFontsEx (CDfvObjPtr pDfvObj, DfvEMBEDALLFONT newVal)
 Effective when outputting to PDF.
DfvIMAGEDOWNSAMPLING dfv_getPdfImageDownSampling (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfImageDownSampling (CDfvObjPtr pDfvObj, DfvIMAGEDOWNSAMPLING newVal)
 Effective when outputting to PDF.
int dfv_getPdfImageDownSamplingTarget (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfImageDownSamplingTarget (CDfvObjPtr pDfvObj, int newVal)
 Effective when outputting to PDF.
int dfv_getPdfImageDownSamplingDPI (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfImageDownSamplingDPI (CDfvObjPtr pDfvObj, int newVal)
 Effective when outputting to PDF.
long dfv_getPdfPutImageColorProfile (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfPutImageColorProfile (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
DfvPDFIMAGECOMPRESSION dfv_getPdfGrayscaleImageCompression (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfGrayscaleImageCompression (CDfvObjPtr pDfvObj, DfvPDFIMAGECOMPRESSION newVal)
 Effective when outputting to PDF.
int dfv_getPdfGrayscaleJPEGQuality (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfGrayscaleJPEGQuality (CDfvObjPtr pDfvObj, int newVal)
 Effective when outputting to PDF.
DfvIMAGEDOWNSAMPLING dfv_getPdfGrayscaleImageDownSampling (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfGrayscaleImageDownSampling (CDfvObjPtr pDfvObj, DfvIMAGEDOWNSAMPLING newVal)
 Effective when outputting to PDF.
int dfv_getPdfGrayscaleImageDownSamplingTarget (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfGrayscaleImageDownSamplingTarget (CDfvObjPtr pDfvObj, int newVal)
 Effective when outputting to PDF.
int dfv_getPdfGrayscaleImageDownSamplingDPI (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfGrayscaleImageDownSamplingDPI (CDfvObjPtr pDfvObj, int newVal)
 Effective when outputting to PDF.
DfvMONOCHROMECOMPRESSION dfv_getPdfMonochromeImageCompression (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfMonochromeImageCompression (CDfvObjPtr pDfvObj, DfvMONOCHROMECOMPRESSION newVal)
 Effective when outputting to PDF.
DfvIMAGEDOWNSAMPLING dfv_getPdfMonochromeImageDownSampling (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfMonochromeImageDownSampling (CDfvObjPtr pDfvObj, DfvIMAGEDOWNSAMPLING newVal)
 Effective when outputting to PDF.
int dfv_getPdfMonochromeImageDownSamplingTarget (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfMonochromeImageDownSamplingTarget (CDfvObjPtr pDfvObj, int newVal)
 Effective when outputting to PDF.
int dfv_getPdfMonochromeImageDownSamplingDPI (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfMonochromeImageDownSamplingDPI (CDfvObjPtr pDfvObj, int newVal)
 Effective when outputting to PDF.
char * dfv_getPdfOutputWidth (CDfvObjPtr pDfvObj, char *pVal, int size)
 Effective when outputting to PDF.
wchar_t * dfv_getPdfOutputWidthW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
 Effective when outputting to PDF.
void dfv_setPdfOutputWidth (CDfvObjPtr pDfvObj, const char *newVal)
 Effective when outputting to PDF.
void dfv_setPdfOutputWidthW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Effective when outputting to PDF.
char * dfv_getPdfOutputHeight (CDfvObjPtr pDfvObj, char *pVal, int size)
 Effective when outputting to PDF.
wchar_t * dfv_getPdfOutputHeightW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
 Effective when outputting to PDF.
void dfv_setPdfOutputHeight (CDfvObjPtr pDfvObj, const char *newVal)
 Effective when outputting to PDF.
void dfv_setPdfOutputHeightW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Effective when outputting to PDF.
long dfv_getPdfErrorOnPDFXFault (CDfvObjPtr pDfvObj)
 Effective when outputting to PDF.
void dfv_setPdfErrorOnPDFXFault (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to PDF.
DfvSVGVERSION dfv_getSvgVersion (CDfvObjPtr pDfvObj)
 Effective when outputting to SVG.
void dfv_setSvgVersion (CDfvObjPtr pDfvObj, DfvSVGVERSION newVal)
 Effective when outputting to SVG.
long dfv_getSvgGzipCompression (CDfvObjPtr pDfvObj)
 Effective when outputting to SVG.
void dfv_setSvgGzipCompression (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to SVG.
long dfv_getSvgEmbedAllFonts (CDfvObjPtr pDfvObj)
 Effective when outputting to SVG.
void dfv_setSvgEmbedAllFonts (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to SVG.
char * dfv_getSvgFormat (CDfvObjPtr pDfvObj, char *pVal, int size)
 Effective when outputting to SVG.
wchar_t * dfv_getSvgFormatW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
 Effective when outputting to SVG.
void dfv_setSvgFormat (CDfvObjPtr pDfvObj, const char *newVal)
 Effective when outputting to SVG.
void dfv_setSvgFormatW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Effective when outputting to SVG.
char * dfv_getSvgEmbedFonts (CDfvObjPtr pDfvObj, char *pVal, int size)
 Effective when outputting to SVG.
wchar_t * dfv_getSvgEmbedFontsW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
 Effective when outputting to SVG.
void dfv_setSvgEmbedFonts (CDfvObjPtr pDfvObj, const char *newVal)
 Effective when outputting to SVG.
void dfv_setSvgEmbedFontsW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Effective when outputting to SVG.
long dfv_getSvgErrorOnEmbedFault (CDfvObjPtr pDfvObj)
 Effective when outputting to SVG.
void dfv_setSvgErrorOnEmbedFault (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to SVG.
DfvIMAGECONVERSION dfv_getSvgImageConversion (CDfvObjPtr pDfvObj)
 Effective when outputting to SVG.
void dfv_setSvgImageConversion (CDfvObjPtr pDfvObj, DfvIMAGECONVERSION newVal)
 Effective when outputting to SVG.
int dfv_getSvgJPEGQuality (CDfvObjPtr pDfvObj)
 Gets the value of the quality of JPEG format that is specified by dfv_setSvgImageConversion() stored in SVG.
void dfv_setSvgJPEGQuality (CDfvObjPtr pDfvObj, int newVal)
 Effective when outputting to SVG.
DfvIMAGEPROCTYPE dfv_getSvgImageProcessingType (CDfvObjPtr pDfvObj)
 Effective when outputting to SVG.
void dfv_setSvgImageProcessingType (CDfvObjPtr pDfvObj, DfvIMAGEPROCTYPE newVal)
 Effective when outputting to SVG.
char * dfv_getSvgImageCopyPath (CDfvObjPtr pDfvObj, char *pVal, int size)
 Effective when outputting to SVG.
void dfv_setSvgImageCopyPath (CDfvObjPtr pDfvObj, const char *newVal)
 Effective when outputting to SVG.
wchar_t * dfv_getSvgImageCopyPathW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
 Effective when outputting to SVG.
void dfv_setSvgImageCopyPathW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Effective when outputting to SVG.
long dfv_getSvgSingleFile (CDfvObjPtr pDfvObj)
 Effective when outputting to SVG.
void dfv_setSvgSingleFile (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to SVG.
long dfv_getSvgImageRename (CDfvObjPtr pDfvObj)
 Effective when outputting to SVG.
void dfv_setSvgImageRename (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to SVG.
char * dfv_getSvgImagePrefix (CDfvObjPtr pDfvObj, char *pVal, int size)
 Effective when outputting to SVG.
void dfv_setSvgImagePrefix (CDfvObjPtr pDfvObj, const char *newVal)
 Effective when outputting to SVG.
wchar_t * dfv_getSvgImagePrefixW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
 Effective when outputting to SVG.
void dfv_setSvgImagePrefixW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Effective when outputting to SVG.
long dfv_getSvgSinglePageNumber (CDfvObjPtr pDfvObj)
 Effective when outputting to SVG.
void dfv_setSvgSinglePageNumber (CDfvObjPtr pDfvObj, long newVal)
 Effective when outputting to SVG.
int dfv_getSvgRasterizeResolution (CDfvObjPtr pDfvObj)
 Effective when outputting to SVG.
void dfv_setSvgRasterizeResolution (CDfvObjPtr pDfvObj, int newVal)
 Effective when outputting to SVG.
void dfv_setMultiVolume (CDfvObjPtr pDfvObj, long newVal)
 Specifies multiple volume of PDF output.
DfvIfErrorLevel dfv_getExitLevel (CDfvObjPtr pDfvObj)
 Get the error level to abort formatting process.
void dfv_setExitLevel (CDfvObjPtr pDfvObj, DfvIfErrorLevel newVal)
 Error level to abort formatting process.
DfvIfErrorLevel dfv_getErrorLevel (CDfvObjPtr pDfvObj)
 Returns the error level of the error that occurred during the formatting process.
DfvIfErrorCode dfv_getErrorCode (CDfvObjPtr pDfvObj)
 Returns the error code of the error that occurred during the formatting process.
char * dfv_getErrorMessage (CDfvObjPtr pDfvObj, char *pVal, int size)
 Returns the error message of the error that occurred during the formatting process.
wchar_t * dfv_getErrorMessageW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
 Returns the error message of the error that occurred during the formatting process.
void dfv_setFontAlias (CDfvObjPtr pDfvObj, const char *src, const char *dst)
 Sets the substitution of font name.
void dfv_setFontAliasW (CDfvObjPtr pDfvObj, const wchar_t *src, const wchar_t *dst)
 Sets the substitution of font name.
void dfv_clearFontAlias (CDfvObjPtr pDfvObj)
 Clear all substitutions of font name.
void dfv_eraseFontAlias (CDfvObjPtr pDfvObj, const char *src)
 Clear all substitutions of font name.
void dfv_eraseFontAliasW (CDfvObjPtr pDfvObj, const wchar_t *src)
DfvIfErrorCode dfv_execute (CDfvObjPtr pDfvObj)
 Execute formatting and output to a PDF specified in OutputFilePath or printer specified in PrinterName.
void dfv_clear (CDfvObjPtr pDfvObj)
 Initialize formatting engine.
void dfv_setOnMessageProc (CDfvObjPtr pDfvObj, DfvOnMessageProc *proc)
 Specifies the callback fucntion.
void dfv_setOnMessageProcW (CDfvObjPtr pDfvObj, DfvOnMessageProcW *proc)
 Specifies the callback fucntion.
void dfv_setOnFormatPageProc (CDfvObjPtr pDfvObj, DfvOnFormatPageProc *proc)
 Specifies the callback fucntion.
void dfv_setOnMessageProcEx (CDfvObjPtr pDfvObj, DfvOnMessageProcEx *proc, void *pAnyObj)
 Specifies the callback fucntion.
void dfv_setOnMessageProcExW (CDfvObjPtr pDfvObj, DfvOnMessageProcExW *proc, void *pAnyObj)
 Specifies the callback fucntion.
void dfv_setOnFormatPageProcEx (CDfvObjPtr pDfvObj, DfvOnFormatPageProcEx *proc, void *pAnyObj)
 Specifies the callback fucntion.
char * dfv_getPrinterName (CDfvObjPtr pDfvObj, char *pVal, int size)
 Get the printer name where the formatted result is outputted.
wchar_t * dfv_getPrinterNameW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
 Get the printer name where the formatted result is outputted.
void dfv_setPrinterName (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the output format or the printer name to output.
void dfv_setPrinterNameW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
 Specifies the output format or the printer name to output.
long dfv_getPrnCopies (CDfvObjPtr pDfvObj)
 Get the number of copies.
void dfv_setPrnCopies (CDfvObjPtr pDfvObj, long newVal)
 Specifies the number of copies.
long dfv_getPrnCollate (CDfvObjPtr pDfvObj)
 Get collation of multiple copies.
void dfv_setPrnCollate (CDfvObjPtr pDfvObj, long newVal)
 Specifies collation of multiple copies.
long dfv_getBatchPrint (CDfvObjPtr pDfvObj)
 Get the setting of whether print dialog box is displayed or not when printing.
void dfv_setBatchPrint (CDfvObjPtr pDfvObj, long newVal)
 When the value 'false' is specified, the print dialog box is displayed when printing.
char * dfv_getVersion (CDfvObjPtr pDfvObj, char *pVal, int size)
 Get the version string of Server Based Converter.
wchar_t * dfv_getVersionW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
 Get the version string of Server Based Converter.
DfvINXOUTPUTMODE dfv_getInxOutputMode (CDfvObjPtr pDfvObj)
 Get INX output mode.
void dfv_setInxOutputMode (CDfvObjPtr pDfvObj, DfvINXOUTPUTMODE newVal)
 Set INX output mode.
int dfv_getOmitBlankPages (CDfvObjPtr pDfvObj)
 Get the specification that omit blank pages.
void dfv_setOmitBlankPages (CDfvObjPtr pDfvObj, int newVal)
 Disregard any empty pages.
long dfv_getFlashPartiallyOutput (CDfvObjPtr pDfvObj)
 Get specifies of the FlashPartiallyOutput.
void dfv_setFlashPartiallyOutput (CDfvObjPtr pDfvObj, long newVal)
 When an error occurs within the document, the flash file in process will be outputted.
long dfv_getFlashHidePageButton (CDfvObjPtr pDfvObj)
 Get specifies of the FlashHidePageButton.
void dfv_setFlashHidePageButton (CDfvObjPtr pDfvObj, long newVal)
 Output a no page button.
void dfv_setPrnFitPaper (CDfvObjPtr pDfvObj, int newVal)
 It print at size of paper.
void dfv_setPdfOutputScale (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the scaling ratio of the PDF to output.
void dfv_setPdfOutputScaleW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
int dfv_getRasterDPI (CDfvObjPtr pDfvObj)
 Get the image resolution when outputting JPEG and PNG.
void dfv_setRasterDPI (CDfvObjPtr pDfvObj, int newVal)
 Effective when outputting to image, and only Windows version.
char * dfv_getRasterScale (CDfvObjPtr pDfvObj, char *pVal, int size)
 Get the image scale when outputting JPEG and PNG.
wchar_t * dfv_getRasterScaleW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
void dfv_setRasterScale (CDfvObjPtr pDfvObj, const char *newVal)
 Sets the image scale when outputting JPEG and PNG.
void dfv_setRasterScaleW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
int dfv_getRasterHeight (CDfvObjPtr pDfvObj)
 Get the maximum image height when outputting JPEG and PNG.
void dfv_setRasterHeight (CDfvObjPtr pDfvObj, int newVal)
 Sets the maximum image height decided by setRasterScale when outputting JPEG and PNG.
char * dfv_getRasterFormat (CDfvObjPtr pDfvObj, char *pVal, int size)
 Get the file name naming format when outputting PNG and JPEG.
wchar_t * dfv_getRasterFormatW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
void dfv_setRasterFormat (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the file name naming format when outputting PNG and JPEG.
void dfv_setRasterFormatW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
int dfv_getRasterJpegQuality (CDfvObjPtr pDfvObj)
 Get the conversion accuracy when outputting JPEG.
void dfv_setRasterJpegQuality (CDfvObjPtr pDfvObj, int newVal)
 Specifies the conversion accuracy by the value with the range of 1-100(%) when outputting JPEG.
long dfv_getRasterUseGdiPlus (CDfvObjPtr pDfvObj)
 Gets specification whether to use GdiPlus .
void dfv_setRasterUseGdiPlus (CDfvObjPtr pDfvObj, long newVal)
 GdiPlus is used when the file is converted to Jpeg or PNG.
long dfv_getRasterMonochrome (CDfvObjPtr pDfvObj)
 Gets specification whether to convert to monochrome image, when outputting JPEG and PNG.
void dfv_setRasterMonochrome (CDfvObjPtr pDfvObj, long newVal)
 Specifies whether to convert to monochrome image, when outputting JPEG and PNG.
void dfv_setTextPaperHeight (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the height of the paper when inputting text.
void dfv_setTextPaperHeightW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
void dfv_setTextPaperWidth (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the width of the paper when inputting text.
void dfv_setTextPaperWidthW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
void dfv_setTextMarginLeft (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the left margin of the paper when inputting text.
void dfv_setTextMarginLeftW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
void dfv_setTextMarginTop (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the right margin of the paper when inputting text.
void dfv_setTextMarginTopW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
void dfv_setTextMarginRight (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the right margin of the paper when inputting text.
void dfv_setTextMarginRightW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
void dfv_setTextMarginBottom (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the right margin of the paper when inputting text.
void dfv_setTextMarginBottomW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
void dfv_setTextFontFamily (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the font family name when inputting text.
void dfv_setTextFontFamilyW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
void dfv_setTextFontSize (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the font size when inputting text.
void dfv_setTextFontSizeW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
void dfv_setTextShowPageNumber (CDfvObjPtr pDfvObj, int newVal)
 Specifies the value of whether show page number or not when inputting text.
void dfv_setTextShowLineNumber (CDfvObjPtr pDfvObj, int newVal)
 Specifies the value of whether show page number or not when inputting text.
void dfv_setTextLineNumberOffset (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the offset value of range from body area when showing line number and inputting text.
void dfv_setTextLineNumberOffsetW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
void dfv_setTextLineNumberFormat (CDfvObjPtr pDfvObj, const char *newVal)
 Specifies the line number format when showing line number and inputting text.
void dfv_setTextLineNumberFormatW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
int dfv_getGdiTextAntialias (CDfvObjPtr pDfvObj)
 Acquires the setting of the smoothing processing to text.
void dfv_setGdiTextAntialias (CDfvObjPtr pDfvObj, int newVal)
 Performs the smoothing processing to text.
int dfv_getGdiLineartSmoothing (CDfvObjPtr pDfvObj)
 Acquires the setting of the smoothing processing to borders.
void dfv_setGdiLineartSmoothing (CDfvObjPtr pDfvObj, int newVal)
 Performs the smoothing processing to borders.
int dfv_getGdiImageSmoothing (CDfvObjPtr pDfvObj)
 Acquires the setting of the smoothing processing to images.
void dfv_setGdiImageSmoothing (CDfvObjPtr pDfvObj, int newVal)
 Performs the smoothing processing to images.
char * dfv_getWatermarkText (CDfvObjPtr pDfvObj, char *pVal, int size)
wchar_t * dfv_getWatermarkTextW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
void dfv_setWatermarkText (CDfvObjPtr pDfvObj, const char *newVal)
void dfv_setWatermarkTextW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
char * dfv_getWatermarkFontFamily (CDfvObjPtr pDfvObj, char *pVal, int size)
wchar_t * dfv_getWatermarkFontFamilyW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
void dfv_setWatermarkFontFamily (CDfvObjPtr pDfvObj, const char *newVal)
void dfv_setWatermarkFontFamilyW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
char * dfv_getWatermarkFontWeight (CDfvObjPtr pDfvObj, char *pVal, int size)
wchar_t * dfv_getWatermarkFontWeightW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
void dfv_setWatermarkFontWeight (CDfvObjPtr pDfvObj, const char *newVal)
void dfv_setWatermarkFontWeightW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
char * dfv_getWatermarkFontStyle (CDfvObjPtr pDfvObj, char *pVal, int size)
wchar_t * dfv_getWatermarkFontStyleW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
void dfv_setWatermarkFontStyle (CDfvObjPtr pDfvObj, const char *newVal)
void dfv_setWatermarkFontStyleW (CDfvObjPtr pDfvObj, const wchar_t *newVal)
char * dfv_getWatermarkOpacity (CDfvObjPtr pDfvObj, char *pVal, int size)
wchar_t * dfv_getWatermarkOpacityW (CDfvObjPtr pDfvObj, wchar_t *pVal, int size)
void dfv_setWatermarkOpacity (CDfvObjPtr pDfvObj, const char *newVal)
void dfv_setWatermarkOpacityW (CDfvObjPtr pDfvObj, const wchar_t *newVal)


Detailed Description

SBC C Interface.

Author:
Antenna House, Inc.
Copyright (C) 2002-2009 Antenna House, Inc. All rights reserved.

Define Documentation

#define DFVINTERFACE_API


Typedef Documentation

typedef long DfvIfErrorCode

Error Code.

typedef void* CDfvObjPtr

Pointer to DfvObj instance.

typedef void( DfvOnMessageProc)(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char *errMessage)

Error callback handler.

typedef void( DfvOnMessageProcW)(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t *errMessage)

typedef void( DfvOnFormatPageProc)(long pageNo)

typedef void( DfvOnMessageProcEx)(void *pAnyObj, DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char *errMessage)

typedef void( DfvOnMessageProcExW)(void *pAnyObj, DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t *errMessage)

typedef void( DfvOnFormatPageProcEx)(void *pAnyObj, long pageNo)


Enumeration Type Documentation

Error Level.

Enumerator:
ELVL_NORMAL 
ELVL_INFORMATION 
ELVL_WARNING 
ELVL_RECOVERABLE 
ELVL_FATAL 

Error Stream Type for MessageListener.

Enumerator:
EST_NONE 
EST_STDOUT 
EST_STDERR 

PDF version.

Enumerator:
PDF_13 
PDF_14 
PDF_15 
PDF_16 
PDF_17 
PDFX_1a_2001 
PDFX_3_2002 
PDFX_1a_2003 
PDFX_2_2003 
PDFX_3_2003 
PDFA_1a_2005 
PDFA_1b_2005 

PDF encrypt level.

Enumerator:
ENCLEVEL_40 
ENCLEVEL_128 

PDF print allow.

Enumerator:
PRALLOW_NONE 
PRALLOW_LOW 
PRALLOW_HIGH 

PDF image compression.

Enumerator:
IMGCMPR_AUTO 
IMGCMPR_JPEG 
IMGCMPR_ZLIB 
IMGCMPR_JPEG2K 

PDF RGB conversion.

Enumerator:
RGBCONV_NONE 
RGBCONV_BLACK 
RGBCONV_GRAY 
RGBCONV_ALL 

Embed font.

Enumerator:
EMBALLFONT_PART 
EMBALLFONT_ALL 
EMBALLFONT_BASE14 

Image downsampling.

Enumerator:
IMGDOWNSAMPLING_NONE 
IMGDOWNSAMPLING_AVERAGE 
IMGDOWNSAMPLING_BICUBIC 
IMGDOWNSAMPLING_SUBSAMPLING 

Monochrome compression.

Enumerator:
MONOCMPR_CCITT4 
MONOCMPR_CCITT3 
MONOCMPR_RUNLENGTH 
MONOCMPR_ZLIB 
MONOCMPR_OFF 

SVG version.

Enumerator:
SVG_11 
SVG_Basic 
SVG_Tiny 

Image processing.

Enumerator:
IMGPT_EMBED_ALL 
IMGPT_COPY_ALL 
IMGPT_LINK 
IMGPT_COPY 

Image conversion.

Enumerator:
IMGCNV_AUTO 
IMGCNV_JPEG 
IMGCNV_PNG 
IMGCNV_JPEGALL 

INX output mode.

Enumerator:
INXOM_TEXT 
INXOM_LINE 
INXOM_BLOCK 

MIF output mode.

Enumerator:
MIFOM_TEXT 
MIFOM_LINE 
MIFOM_BLOCK 


Function Documentation

CDfvObjPtr dfv_createDfvObject (  ) 

Create instance of DfvObj.

Returns:
Pointer to DfvObj instance.

void dfv_releaseDfvObject ( CDfvObjPtr  pDfvObj  ) 

Release instance of DfvObj.

Parameters:
pDfvObj Pointer to DfvObj instance.

char* dfv_getDocumentURI ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Get the URL of XML document you will format.

Parameters:
pDfvObj Pointer to DfvObj 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* dfv_getDocumentURIW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Get the URL of XML document you will format.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setDocumentURI ( CDfvObjPtr  pDfvObj,
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:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the URL of XSL document.

void dfv_setDocumentURIW ( CDfvObjPtr  pDfvObj,
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:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the URL of XSL document.

char* dfv_getOutputFilePath ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Get the path name of the output file.

Parameters:
pDfvObj Pointer to DfvObj 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* dfv_getOutputFilePathW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Get the path name of the output file.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setOutputFilePath ( CDfvObjPtr  pDfvObj,
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:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the path name of the output file.

void dfv_setOutputFilePathW ( CDfvObjPtr  pDfvObj,
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:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the path name of the output file.

char* dfv_getOptionFileURI ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size,
int  n 
)

Get the path name of XML-format Option setting file which describes Server Based Converter options.

Parameters:
pDfvObj Pointer to DfvObj 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* dfv_getOptionFileURIW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size,
int  n 
)

Get the path name of XML-format Option setting file which describes Server Based Converter options.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setOptionFileURI ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Specifies the path name of XML-format Option setting file which describes Server Based Converter options.

The set of former URIs is thrown away.

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

void dfv_setOptionFileURIW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Specifies the path name of XML-format Option setting file which describes Server Based Converter options.

The set of former URIs is thrown away.

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

void dfv_addOptionFileURI ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Append the path name of XML-format Option setting file which describes Server Based Converter options.

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

void dfv_addOptionFileURIW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Append the path name of XML-format Option setting file which describes Server Based Converter options.

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

int dfv_getOptionFileCount ( CDfvObjPtr  pDfvObj  ) 

Get the number of URIs of XML-format Option setting file which describes Server Based Converter options.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
Returns the number of URIs.

long dfv_getStartPage ( CDfvObjPtr  pDfvObj  ) 

Get the start page number of document to output.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
start page number of output.

void dfv_setStartPage ( CDfvObjPtr  pDfvObj,
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:
pDfvObj Pointer to DfvObj instance.
newVal start page number of output.

long dfv_getEndPage ( CDfvObjPtr  pDfvObj  ) 

Get the end page number of document to output.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
end page number of output.

void dfv_setEndPage ( CDfvObjPtr  pDfvObj,
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:
pDfvObj Pointer to DfvObj instance.
newVal end page number of output.

void dfv_setPdfOwnerPassword ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Effective when outputting to PDF.

Specifies the owner password for PDF. The password must be within 32 bytes.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the owner password.

void dfv_setPdfOwnerPasswordW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Effective when outputting to PDF.

Specifies the owner password for PDF. The password must be within 32 bytes.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the owner password.

void dfv_setPdfUserPassword ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Effective when outputting to PDF.

Specifies the user password for PDF. The password must be within 32 bytes.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the user password.

void dfv_setPdfUserPasswordW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Effective when outputting to PDF.

Specifies the user password for PDF. The password must be within 32 bytes.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the user password.

void dfv_setPdfNoPrinting ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to PDF.

Disables printing the PDF file.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If nonezero is specified, Disables printing the PDF file.

long dfv_getPdfNoPrinting ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Get disables printing the PDF file.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
If zero is returned, Enables printing the PDF file. If nonezero is returned, Disables printing the PDF file.

void dfv_setPdfNoChanging ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to PDF.

Disables making changes of the PDF file.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If nonezero is specified, Disables making changes of the PDF file.

long dfv_getPdfNoChanging ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Get disables making changes of the PDF file.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setPdfNoContentCopying ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to PDF.

Disables copying the content of the PDF file.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If nonezero is specified, Disables copying the content of the PDF file.

long dfv_getPdfNoContentCopying ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Get disables copying the content of the PDF file.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setPdfNoAddingOrChangingCommnets ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to PDF.

Disables adding comments and form fields to the PDF file.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If nonezero is specified, Disables adding comments and form fields to the PDF file.

long dfv_getPdfNoAddingOrChangingCommnets ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Get disables adding comments and form fields to the PDF file.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setPdfNoAddingOrChangingComments ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to PDF.

Disables adding comments and form fields to the PDF file.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If nonezero is specified, Disables adding comments and form fields to the PDF file.

long dfv_getPdfNoAddingOrChangingComments ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Get disables adding comments and form fields to the PDF file.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setPdfVersion ( CDfvObjPtr  pDfvObj,
DfvPDFVERSION  newVal 
)

Effective when outputting to PDF.

Enables specifying whether the version of PDF is 1.3, 1.4 or 1.5.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Specifies the version of PDF.

DfvPDFVERSION dfv_getPdfVersion ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Get the version of PDF.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the version of PDF.

void dfv_setPdfNoFillForm ( CDfvObjPtr  pDfvObj,
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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If nonezero is specified, Disables filling in of form fields and signing of the PDF file.

long dfv_getPdfNoFillForm ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Get disables filling in of form fields and signing of the PDF file.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setPdfNoAccessibility ( CDfvObjPtr  pDfvObj,
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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If nonezero is specified, Disables text access for screen reader devices of the PDF file.

long dfv_getPdfNoAccessibility ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Get disables text access for screen reader devices of the PDF file.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setPdfNoAssembleDoc ( CDfvObjPtr  pDfvObj,
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

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If nonezero is specified, Disables inserting, deleting and rotating the PDF pages.

long dfv_getPdfNoAssembleDoc ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Get disables inserting, deleting and rotating the PDF pages.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setPdfEncryptLevel ( CDfvObjPtr  pDfvObj,
DfvPDFENCRYPTLEVEL  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

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Specifies the key length.

DfvPDFENCRYPTLEVEL dfv_getPdfEncryptLevel ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Get the key length when encrypting the PDF file during outputting.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the key length.

long dfv_getPdfEmbedAllFonts ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of whether to embed all embeddable fonts in PDF.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of whether to embed all embeddable fonts

void dfv_setPdfEmbedAllFonts ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to PDF.

Embeds all embeddable fonts in PDF to create.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If the value is 'true' is specified, Embeds all embeddable fonts

char* dfv_getPdfEmbedFonts ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Effective when outputting to PDF.

Gets the font specified to be embedded in PDF.

Parameters:
pDfvObj Pointer to DfvObj 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* dfv_getPdfEmbedFontsW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Effective when outputting to PDF.

Gets the font specified to be embedded in PDF.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setPdfEmbedFonts ( CDfvObjPtr  pDfvObj,
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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal fonts specified to embed

void dfv_setPdfEmbedFontsW ( CDfvObjPtr  pDfvObj,
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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal fonts specified to embed

long dfv_getPdfErrorOnEmbedFault ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of whether to issues the error when failing to embed fonts.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of whether to issues the error

void dfv_setPdfErrorOnEmbedFault ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to PDF.

An error is issued in case of failing to embed fonts.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If the value is 'true' is specified, an error is issued.

long dfv_getPdfErrorOnMissingGlyph ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of whether to issues the error when missing glyph.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of whether to issues the error

void dfv_setPdfErrorOnMissingGlyph ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to PDF.

An error is issued in case of missing glyph.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If the value is 'true' is specified, an error is issued.

DfvPDFPRINTALLOW dfv_getPdfPrintingAllowed ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of whether to print the resulting PDF file or not.

PRALLOW_NONE = 0 Not Allowed
PRALLOW_LOW = 1 Low Resolution Printing
PRALLOW_HIGH = 2 High Resolution Printing

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of printing allowed

void dfv_setPdfPrintingAllowed ( CDfvObjPtr  pDfvObj,
DfvPDFPRINTALLOW  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).

PRALLOW_NONE = 0 Not Allowed
PRALLOW_LOW = 1 Low Resolution Printing
PRALLOW_HIGH = 2 High Resolution Printing

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of printing allowed

DfvPDFIMAGECOMPRESSION dfv_getPdfImageCompression ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of how to compress the color images embedded in PDF.

IMGCMPR_AUTO = 0 Auto
IMGCMPR_JPEG = 1 JPEG compression
IMGCMPR_ZLIB = 2 ZLIB compression
IMGCMPR_JPEG2K = 3 JPEG2000 compression

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of how raster graphics are compressed and stored

void dfv_setPdfImageCompression ( CDfvObjPtr  pDfvObj,
DfvPDFIMAGECOMPRESSION  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 dfv_setPdfJPEGQuality and dfv_setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected.
This is the setting for the color image. Spesify dfv_setPdfGrayscaleImageCompression for the grayscale image, and dfv_setPdfMonochromeImageCompression for the monochrome image.

IMGCMPR_AUTO = 0 Auto
IMGCMPR_JPEG = 1 JPEG compression
IMGCMPR_ZLIB = 2 ZLIB compression
IMGCMPR_JPEG2K = 3 JPEG2000 compression

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of how raster graphics are compressed and stored

int dfv_getPdfJPEGQuality ( CDfvObjPtr  pDfvObj  ) 

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

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of the quality of JPEG format

void dfv_setPdfJPEGQuality ( CDfvObjPtr  pDfvObj,
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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of the quality of JPEG format

long dfv_getPdfCompressContentStream ( CDfvObjPtr  pDfvObj  ) 

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.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of whether make the size of PDF smaller or not

void dfv_setPdfCompressContentStream ( CDfvObjPtr  pDfvObj,
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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If the value is 'true' is specified, make the PDF compress

long dfv_getPdfUseLaunchForRelativeURI ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of how to transform external link specified by the relative address in the PDF link.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of how to transform external link

void dfv_setPdfUseLaunchForRelativeURI ( CDfvObjPtr  pDfvObj,
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.

Parameters:
pDfvObj Pointer to DfvObj 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'

DfvPDFRGBCONVERSION dfv_getPdfRGBConversion ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of how to convert the RGB color space (DebiceRGB) to DeviceGray.

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:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of how to convert

void dfv_setPdfRGBConversion ( CDfvObjPtr  pDfvObj,
DfvPDFRGBCONVERSION  newVal 
)

Effective when outputting to PDF.

Specifies how to convert the RGB color space (DeviceRGB) to DeviceGray.

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:
pDfvObj Pointer to DfvObj instance.
newVal the value of how to convert

int dfv_getPdfRasterizeResolution ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of the rasterised-resolution of the transformed raster images.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
Rasterised-resolution

void dfv_setPdfRasterizeResolution ( CDfvObjPtr  pDfvObj,
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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Rasterised-resolution (70 to 500)

long dfv_getPdfLinearize ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of whether to output linearize PDF or not.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of whether to output linearize pdf or not.

void dfv_setPdfLinearize ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to PDF.

Specifies whether to output linearize PDF or not.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If the value is 'true' is specified, output linearlize PDF.

long dfv_getPdfSignature ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of whether to sign a signature to PDF or not.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of whether to sign a signature to PDF or not.

void dfv_setPdfSignature ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to PDF.

Specifies whether to sign a signature to PDF or not.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If the value is 'true' is specified, sign a signature to PDF.

char* dfv_getPdfSignatureName ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Effective when outputting to PDF.

Gets the value of a signature information name.

Parameters:
pDfvObj Pointer to DfvObj 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:
the value of a signature information name.

wchar_t* dfv_getPdfSignatureNameW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Effective when outputting to PDF.

Gets the value of a signature information name.

Parameters:
pDfvObj Pointer to DfvObj 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:
the value of a signature information name.

void dfv_setPdfSignatureName ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Effective when outputting to PDF.

Sets a signature information name.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of a signature information name.

void dfv_setPdfSignatureNameW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Effective when outputting to PDF.

Sets a signature information name.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of a signature information name.

char* dfv_getPdfCertificateName ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Effective when outputting to PDF.

Gets the value of a certificate information name.

Parameters:
pDfvObj Pointer to DfvObj 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:
the value of a certificate information name.

wchar_t* dfv_getPdfCertificateNameW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Effective when outputting to PDF.

Gets the value of a certificate information name.

Parameters:
pDfvObj Pointer to DfvObj 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:
the value of a certificate information name.

void dfv_setPdfCertificateName ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Effective when outputting to PDF.

Sets a certificate information name.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of a certificate information name.

void dfv_setPdfCertificateNameW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Effective when outputting to PDF.

Sets a certificate information name.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of a certificate information name.

DfvEMBEDALLFONT dfv_getPdfEmbedAllFontsEx ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of whether to embed all embeddable fonts

EMBALLFONT_PART = 0 Specified fonts
EMBALLFONT_ALL = 1 All fonts except Base14 fonts
EMBALLFONT_BASE14 = 2 All fonts

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of whether to embed all embeddable fonts

void dfv_setPdfEmbedAllFontsEx ( CDfvObjPtr  pDfvObj,
DfvEMBEDALLFONT  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.

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 dfv_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:
pDfvObj Pointer to DfvObj instance.
newVal the value of whether to embed all embeddable fonts

DfvIMAGEDOWNSAMPLING dfv_getPdfImageDownSampling ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of method to downsample the color image

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of method to downsample the color image

void dfv_setPdfImageDownSampling ( CDfvObjPtr  pDfvObj,
DfvIMAGEDOWNSAMPLING  newVal 
)

Effective when outputting to PDF.

Specifies the following either of method to downsample the color image that is put into PDF.

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 dfv_setPdfImageDownSamplingDPI will be downsampled into the resolution specified by dfv_setPdfImageDownSamplingTarget. This is the setting for the color image. Spesify dfv_setPdfGrayscaleImageDownSampling for the grayscale image, and dfv_setPdfMonochromeImageDownSampling for the monochrome image.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of method to downsample the color image

int dfv_getPdfImageDownSamplingTarget ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets resolution when the color image is downsampled.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of resolution.

void dfv_setPdfImageDownSamplingTarget ( CDfvObjPtr  pDfvObj,
int  newVal 
)

Effective when outputting to PDF.

Set resolution when the color image is downsampled.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of resolution.

int dfv_getPdfImageDownSamplingDPI ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets resolution of the color image which performs a downsampling.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of resolution.

void dfv_setPdfImageDownSamplingDPI ( CDfvObjPtr  pDfvObj,
int  newVal 
)

Effective when outputting to PDF.

Set resolution of the color image which performs a downsampling.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of resolution.

long dfv_getPdfPutImageColorProfile ( CDfvObjPtr  pDfvObj  ) 

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.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
If nonezero is specified, it is embedded. If zero is specified, it is not embedded.

void dfv_setPdfPutImageColorProfile ( CDfvObjPtr  pDfvObj,
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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If nonezero is specified, it is embedded. If zero is specified, it is not embedded.

DfvPDFIMAGECOMPRESSION dfv_getPdfGrayscaleImageCompression ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of how to compress the grayscale images embedded in PDF.

IMGCMPR_AUTO = 0 Auto
IMGCMPR_JPEG = 1 JPEG compression
IMGCMPR_ZLIB = 2 ZLIB compression
IMGCMPR_JPEG2K = 3 JPEG2000 compression

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of how raster graphics are compressed and stored

void dfv_setPdfGrayscaleImageCompression ( CDfvObjPtr  pDfvObj,
DfvPDFIMAGECOMPRESSION  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 dfv_setPdfGrayscaleJPEGQuality and dfv_setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected.
This is the setting for the grayscale image. Spesify dfv_setPdfImageCompression for the color image, and dfv_setPdfMonochromeImageCompression for the monochrome image.

IMGCMPR_AUTO = 0 Auto
IMGCMPR_JPEG = 1 JPEG compression
IMGCMPR_ZLIB = 2 ZLIB compression
IMGCMPR_JPEG2K = 3 JPEG2000 compression

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of how raster graphics are compressed and stored

int dfv_getPdfGrayscaleJPEGQuality ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of the quality of JPEG format that is specified by dfv_setPdfGrayscaleImageCompression stored in PDF.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of the quality of JPEG format

void dfv_setPdfGrayscaleJPEGQuality ( CDfvObjPtr  pDfvObj,
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 dfv_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 dfv_setPdfJPEGQuality for the color image.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of the quality of JPEG format

DfvIMAGEDOWNSAMPLING dfv_getPdfGrayscaleImageDownSampling ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of method to downsample the grayscale image

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of method to downsample the grayscale image

void dfv_setPdfGrayscaleImageDownSampling ( CDfvObjPtr  pDfvObj,
DfvIMAGEDOWNSAMPLING  newVal 
)

Effective when outputting to PDF.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal 

int dfv_getPdfGrayscaleImageDownSamplingTarget ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets resolution when the grayscale image is downsampled.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of resolution.

void dfv_setPdfGrayscaleImageDownSamplingTarget ( CDfvObjPtr  pDfvObj,
int  newVal 
)

Effective when outputting to PDF.

Specifies the following either of method to downsample the grayscale image that is put into PDF.

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 dfv_setPdfGrayscaleImageDownSamplingDPI will be downsampled into the resolution specified by dfv_setPdfGrayscaleImageDownSamplingTarget. This is the setting for the grayscale image. Spesify dfv_setPdfImageDownSampling for the color image, and dfv_setPdfMonochromeImageDownSampling for the monochrome image.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of method to downsample the grayscale image

int dfv_getPdfGrayscaleImageDownSamplingDPI ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets resolution of the grayscale image which performs a downsampling.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of resolution.

void dfv_setPdfGrayscaleImageDownSamplingDPI ( CDfvObjPtr  pDfvObj,
int  newVal 
)

Effective when outputting to PDF.

Set resolution of the grayscale image which performs a downsampling.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of resolution.

DfvMONOCHROMECOMPRESSION dfv_getPdfMonochromeImageCompression ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of how to compress the monochrome images embedded in PDF.

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:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of how raster graphics are compressed and stored

void dfv_setPdfMonochromeImageCompression ( CDfvObjPtr  pDfvObj,
DfvMONOCHROMECOMPRESSION  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 dfv_setPdfGrayscaleImageCompression for the grayscale image, and dfv_setPdfImageCompression for the color image.

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:
pDfvObj Pointer to DfvObj instance.
newVal the value of how raster graphics are compressed and stored

DfvIMAGEDOWNSAMPLING dfv_getPdfMonochromeImageDownSampling ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of method to downsample the monochrome image

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of method to downsample the monochrome image

void dfv_setPdfMonochromeImageDownSampling ( CDfvObjPtr  pDfvObj,
DfvIMAGEDOWNSAMPLING  newVal 
)

Effective when outputting to PDF.

Specifies the following either of method to downsample the monochrome image that is put into PDF.

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 dfv_setPdfMonochromeImageDownSamplingDPI will be downsampled into the resolution specified by dfv_setPdfMonochromeImageDownSamplingTarget. This is the setting for the monochrome image. Spesify dfv_setPdfImageDownSampling for the color image, and dfv_setPdfGrayscaleImageDownSampling for the grayscale image.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of method to downsample the monochrome image

int dfv_getPdfMonochromeImageDownSamplingTarget ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets resolution when the monochrome image is downsampled.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of resolution.

void dfv_setPdfMonochromeImageDownSamplingTarget ( CDfvObjPtr  pDfvObj,
int  newVal 
)

Effective when outputting to PDF.

Set resolution when the monochrome image is downsampled.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of resolution.

int dfv_getPdfMonochromeImageDownSamplingDPI ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets resolution of the monochrome image which performs a downsampling.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of resolution.

void dfv_setPdfMonochromeImageDownSamplingDPI ( CDfvObjPtr  pDfvObj,
int  newVal 
)

Effective when outputting to PDF.

Set resolution of the monochrome image which performs a downsampling.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of resolution.

char* dfv_getPdfOutputWidth ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Effective when outputting to PDF.

Gets the width of PDF to output.

Parameters:
pDfvObj Pointer to DfvObj instance.
pVal Pointer to the buffer that will receive the width of PDF. 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* dfv_getPdfOutputWidthW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Effective when outputting to PDF.

Gets the width of PDF to output.

Parameters:
pDfvObj Pointer to DfvObj instance.
pVal Pointer to the buffer that will receive the width of PDF. 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 dfv_setPdfOutputWidth ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Effective when outputting to PDF.

Scales the width of PDF to output. A value with a unit or % value can be specified as length.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the width of PDF to output.

void dfv_setPdfOutputWidthW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Effective when outputting to PDF.

Scales the width of PDF to output. A value with a unit or % value can be specified as length.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the width of PDF to output.

char* dfv_getPdfOutputHeight ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Effective when outputting to PDF.

Gets the height of PDF to output.

Parameters:
pDfvObj Pointer to DfvObj instance.
pVal Pointer to the buffer that will receive the height of PDF. 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* dfv_getPdfOutputHeightW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Effective when outputting to PDF.

Gets the height of PDF to output.

Parameters:
pDfvObj Pointer to DfvObj instance.
pVal Pointer to the buffer that will receive the height of PDF. 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 dfv_setPdfOutputHeight ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Effective when outputting to PDF.

Scales the height of PDF to output. A value with a unit or % value can be specified as length.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the width of PDF to output.

void dfv_setPdfOutputHeightW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Effective when outputting to PDF.

Scales the height of PDF to output. A value with a unit or % value can be specified as length.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the width of PDF to output.

long dfv_getPdfErrorOnPDFXFault ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to PDF.

Gets the value of whether to issue error or not when PDF/X is generating.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of whether to issue error.

void dfv_setPdfErrorOnPDFXFault ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to PDF.

An error is not issued when PDF/X is generating.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If the value is 'true' is specified, no error is issued.

DfvSVGVERSION dfv_getSvgVersion ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to SVG.

Get the version of SVG.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the version of SVG.

void dfv_setSvgVersion ( CDfvObjPtr  pDfvObj,
DfvSVGVERSION  newVal 
)

Effective when outputting to SVG.

Enables specifying whether the version of SVG is 1.1, Basic or Tiny.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Specifies the version of SVG.

long dfv_getSvgGzipCompression ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to SVG.

Gets the setting indicating whether to compress the outputted SVG into gzip format or not.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
whether gzip compression or not.

void dfv_setSvgGzipCompression ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to SVG.

Specifies whether to compress the outputted SVG into gzip format or not.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If the value is 'true' is specified, enables to compress data into gzip format.

long dfv_getSvgEmbedAllFonts ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to SVG.

Gets the setting indicating whether to embed fonts in the outputted SVG.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
whether embeds fonts or not.

void dfv_setSvgEmbedAllFonts ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to SVG.

Specifies whether to embed fonts in the outputted SVG.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If the value is 'true' is specified, embeds fonts.

char* dfv_getSvgFormat ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Effective when outputting to SVG.

Gets the format for naming files when the outputted SVG becomes multiple.

Parameters:
pDfvObj Pointer to DfvObj 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* dfv_getSvgFormatW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Effective when outputting to SVG.

Gets the format for naming files when the outputted SVG becomes multiple.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setSvgFormat ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Effective when outputting to SVG.

Specifies the format for naming files when the outputted SVG becomes multiple.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the SVG file name format.

void dfv_setSvgFormatW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Effective when outputting to SVG.

Specifies the format for naming files when the outputted SVG becomes multiple.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the SVG file name format.

char* dfv_getSvgEmbedFonts ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Effective when outputting to SVG.

Gets the font specified to be embedded in SVG.

Parameters:
pDfvObj Pointer to DfvObj 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* dfv_getSvgEmbedFontsW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Effective when outputting to SVG.

Gets the font specified to be embedded in SVG.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setSvgEmbedFonts ( CDfvObjPtr  pDfvObj,
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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal fonts specified to embed

void dfv_setSvgEmbedFontsW ( CDfvObjPtr  pDfvObj,
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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal fonts specified to embed

long dfv_getSvgErrorOnEmbedFault ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to SVG.

Gets the value of whether to issues the error when failing to embed fonts.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of whether to issues the error

void dfv_setSvgErrorOnEmbedFault ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to SVG.

An error is issued in case of failing to embed fonts.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If the value is 'true' is specified, an error is issued.

DfvIMAGECONVERSION dfv_getSvgImageConversion ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to SVG.

Gets the value of how to compress the images embedded in SVG.

IMGCMPR_AUTO = 0 Auto conversion
IMGCMPR_JPEG = 1 JPEG conversion
IMGCMPR_PNG = 2 PNG conversion

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of how raster graphics are compressed and stored

void dfv_setSvgImageConversion ( CDfvObjPtr  pDfvObj,
DfvIMAGECONVERSION  newVal 
)

Effective when outputting to SVG.

Selects how to compress the images embedded in SVG to create from the following.

IMGCMPR_AUTO = 0 Auto conversion
IMGCMPR_JPEG = 1 JPEG conversion
IMGCMPR_PNG = 2 PNG conversion

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of how raster graphics are compressed and stored

int dfv_getSvgJPEGQuality ( CDfvObjPtr  pDfvObj  ) 

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

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
the value of the quality

void dfv_setSvgJPEGQuality ( CDfvObjPtr  pDfvObj,
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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal JPEG quality (1 to 100)

DfvIMAGEPROCTYPE dfv_getSvgImageProcessingType ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to SVG.

Gets specification how to treat the referred image.

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:
pDfvObj Pointer to DfvObj instance.
Returns:
specification how to treat the referred image.

void dfv_setSvgImageProcessingType ( CDfvObjPtr  pDfvObj,
DfvIMAGEPROCTYPE  newVal 
)

Effective when outputting to SVG.

Specifies how to treat the referred image.

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:
pDfvObj Pointer to DfvObj instance.
newVal specification how to treat the referred image.

char* dfv_getSvgImageCopyPath ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Effective when outputting to SVG.

Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by dfv_setSvgImageProcessingType.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setSvgImageCopyPath ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Effective when outputting to SVG.

Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by dfv_setSvgImageProcessingType.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as image copy path

wchar_t* dfv_getSvgImageCopyPathW ( CDfvObjPtr  pDfvObj,
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 dfv_setSvgImageProcessingType.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setSvgImageCopyPathW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Effective when outputting to SVG.

Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by dfv_setSvgImageProcessingType.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as image copy path

long dfv_getSvgSingleFile ( CDfvObjPtr  pDfvObj  ) 

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.

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

void dfv_setSvgSingleFile ( CDfvObjPtr  pDfvObj,
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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.

long dfv_getSvgImageRename ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to SVG.

Gets specification whether to rename all file name to prefix specified by dfv_setSvgImagePrefix, or use original name.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
specification whether to rename all file name to prefix specified by dfv_setSvgImagePrefix, or use original name.

void dfv_setSvgImageRename ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to SVG.

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

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal specification whether to rename all file name to prefix specified by dfv_setSvgImagePrefix, or use original name.

char* dfv_getSvgImagePrefix ( CDfvObjPtr  pDfvObj,
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 dfv_setSvgImageCopyPath and processed.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setSvgImagePrefix ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Effective when outputting to SVG.

When images are copied to the directory specified by dfv_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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the prefix of the file name.

wchar_t* dfv_getSvgImagePrefixW ( CDfvObjPtr  pDfvObj,
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 dfv_setSvgImageCopyPath and processed.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setSvgImagePrefixW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Effective when outputting to SVG.

When images are copied to the directory specified by dfv_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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the prefix of the file name.

long dfv_getSvgSinglePageNumber ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to SVG.

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

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

void dfv_setSvgSinglePageNumber ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Effective when outputting to SVG.

When dfv_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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal specification whether to add sequential number to the output SVG even if it has only one-page.

int dfv_getSvgRasterizeResolution ( CDfvObjPtr  pDfvObj  ) 

Effective when outputting to SVG.

Gets the value of the rasterised-resolution of the transformed raster images.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
Rasterised-resolution

void dfv_setSvgRasterizeResolution ( CDfvObjPtr  pDfvObj,
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.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Rasterised-resolution (70 to 500)

void dfv_setMultiVolume ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Specifies multiple volume of PDF output.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Zpecifies zero or nonzero.

DfvIfErrorLevel dfv_getExitLevel ( CDfvObjPtr  pDfvObj  ) 

Get the error level to abort formatting process.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
Returns the error level.

void dfv_setExitLevel ( CDfvObjPtr  pDfvObj,
DfvIfErrorLevel  newVal 
)

Error level to abort formatting process.

Server Based Converter 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:
pDfvObj Pointer to DfvObj instance.
newVal error level to abort formatting process.

DfvIfErrorLevel dfv_getErrorLevel ( CDfvObjPtr  pDfvObj  ) 

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:
pDfvObj Pointer to DfvObj instance.
Returns:
Returns the error level.

DfvIfErrorCode dfv_getErrorCode ( CDfvObjPtr  pDfvObj  ) 

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

Zero means no error. Non-zero indicates any error occurred.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
Returns the error code.

char* dfv_getErrorMessage ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

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

Parameters:
pDfvObj Pointer to DfvObj 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* dfv_getErrorMessageW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

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

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setFontAlias ( CDfvObjPtr  pDfvObj,
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:
pDfvObj Pointer to DfvObj instance.
src Specifies the font name which is replaced.
dst Specifies the aliasName.

void dfv_setFontAliasW ( CDfvObjPtr  pDfvObj,
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:
pDfvObj Pointer to DfvObj instance.
src Specifies the font name which is replaced.
dst Specifies the aliasName.

void dfv_clearFontAlias ( CDfvObjPtr  pDfvObj  ) 

Clear all substitutions of font name.

Parameters:
pDfvObj Pointer to DfvObj instance.

void dfv_eraseFontAlias ( CDfvObjPtr  pDfvObj,
const char *  src 
)

Clear all substitutions of font name.

Parameters:
pDfvObj Pointer to DfvObj instance. Erase the substitution of font name 'fontName'.
pDfvObj Pointer to DfvObj instance.
src Specifies the font name which is replaced.

void dfv_eraseFontAliasW ( CDfvObjPtr  pDfvObj,
const wchar_t *  src 
)

DfvIfErrorCode dfv_execute ( CDfvObjPtr  pDfvObj  ) 

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

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
Returns the error code. Zero means no error. Non-zero indicates any error occurred.

void dfv_clear ( CDfvObjPtr  pDfvObj  ) 

Initialize formatting engine.

Parameters:
pDfvObj Pointer to DfvObj instance.

void dfv_setOnMessageProc ( CDfvObjPtr  pDfvObj,
DfvOnMessageProc proc 
)

Specifies the callback fucntion.

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

Parameters:
pDfvObj Pointer to DfvObj instance.
proc Address of the callback function.
Callback function has the following form:
 void DfvOnMessageProc(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage);
 void DfvOnMessageProcW(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage);

void dfv_setOnMessageProcW ( CDfvObjPtr  pDfvObj,
DfvOnMessageProcW proc 
)

Specifies the callback fucntion.

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

Parameters:
pDfvObj Pointer to DfvObj instance.
proc Address of the callback function.
Callback function has the following form:
 void DfvOnMessageProc(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage);
 void DfvOnMessageProcW(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage);

void dfv_setOnFormatPageProc ( CDfvObjPtr  pDfvObj,
DfvOnFormatPageProc proc 
)

Specifies the callback fucntion.

The page number in the formatting process can be received.

Parameters:
pDfvObj Pointer to DfvObj instance.
proc Address of the callback function.
Callback function has the following form:
 void DfvOnFormatPageProc(long pageNo);

void dfv_setOnMessageProcEx ( CDfvObjPtr  pDfvObj,
DfvOnMessageProcEx proc,
void *  pAnyObj 
)

Specifies the callback fucntion.

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

Parameters:
pDfvObj Pointer to DfvObj instance.
proc Address of the callback function.
Callback function has the following form:
 void DfvOnMessageProc(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage);
 void DfvOnMessageProcW(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage);
pAnyObj Address of an any object.

void dfv_setOnMessageProcExW ( CDfvObjPtr  pDfvObj,
DfvOnMessageProcExW proc,
void *  pAnyObj 
)

Specifies the callback fucntion.

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

Parameters:
pDfvObj Pointer to DfvObj instance.
proc Address of the callback function.
Callback function has the following form:
 void DfvOnMessageProc(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage);
 void DfvOnMessageProcW(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage);
pAnyObj Address of an any object.

void dfv_setOnFormatPageProcEx ( CDfvObjPtr  pDfvObj,
DfvOnFormatPageProcEx proc,
void *  pAnyObj 
)

Specifies the callback fucntion.

The page number in the formatting process can be received.

Parameters:
pDfvObj Pointer to DfvObj instance.
proc Address of the callback function.
Callback function has the following form:
 void DfvOnFormatPageProc(long pageNo);
pAnyObj Address of an any object.

char* dfv_getPrinterName ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Get the printer name where the formatted result is outputted.

Parameters:
pDfvObj Pointer to DfvObj 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* dfv_getPrinterNameW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Get the printer name where the formatted result is outputted.

Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setPrinterName ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Specifies the output format or the printer name to output.

When a printer name is specified, the formatted result is outputted to that printer. When "\@STDPRN" is specified, the formatted result is outputted to the currently used printer. When "\@PDF" is specified, the formatted result is outputted to PDF. When "\@SVG" is specified, the formatted result is outputted to SVG. When "\@PS" is specified, the formatted result is outputted to PostScript. When "\@INX" is specified, the formatted result is outputted to INX. When "\@MIF" is specified, the formatted result is outputted to MIF. When "\@TEXT" is specified, the formatted result is outputted to a text format file. When "\@AreaTree" is specified, the AreaTree will be outputted. When omitted, it is considered as "\@PDF" was specified. It's impossible to output to the printer with any OS's other than Windows.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the printer name.

void dfv_setPrinterNameW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Specifies the output format or the printer name to output.

When a printer name is specified, the formatted result is outputted to that printer. When "\@STDPRN" is specified, the formatted result is outputted to the currently used printer. When "\@PDF" is specified, the formatted result is outputted to PDF. When "\@SVG" is specified, the formatted result is outputted to SVG. When "\@PS" is specified, the formatted result is outputted to PostScript. When "\@INX" is specified, the formatted result is outputted to INX. When "\@MIF" is specified, the formatted result is outputted to MIF. When "\@TEXT" is specified, the formatted result is outputted to a text format file. When "\@AreaTree" is specified, the AreaTree will be outputted. When omitted, it is considered as "\@PDF" was specified. It's impossible to output to the printer with any OS's other than Windows.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string to be used as the printer name.

long dfv_getPrnCopies ( CDfvObjPtr  pDfvObj  ) 

Get the number of copies.

Effective when outputting to printer.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
Returns the number of copies.

void dfv_setPrnCopies ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Specifies the number of copies.

Effective when outputting to printer. If nothing is specified, the value is considered as 1. This setting is effective only with Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the number of copies.

long dfv_getPrnCollate ( CDfvObjPtr  pDfvObj  ) 

Get collation of multiple copies.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
If zero is returned, the same page is multi-copied continuously. If nonezero is returned, the pages specified from start to end are printed repeatedly.

void dfv_setPrnCollate ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Specifies collation of multiple copies.

Effective when outputting to printer and the number of copies is plural. If it is not specified or the value zero is specified, the same page is multi-copied continuously. If nonezero is specified, the pages specified from start to end are printed repeatedly. This setting is effective only with Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Zpecifies zero or nonzero.

long dfv_getBatchPrint ( CDfvObjPtr  pDfvObj  ) 

Get the setting of whether print dialog box is displayed or not when printing.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed.

void dfv_setBatchPrint ( CDfvObjPtr  pDfvObj,
long  newVal 
)

When the value 'false' is specified, the print dialog box is displayed when printing.

If the setting is omitted or the value 'true' is specified, the print dialog is not displayed. This setting is effective only with Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed.

char* dfv_getVersion ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Get the version string of Server Based Converter.

Parameters:
pDfvObj Pointer to DfvObj 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* dfv_getVersionW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Get the version string of Server Based Converter.

Parameters:
pDfvObj Pointer to DfvObj 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'.

DfvINXOUTPUTMODE dfv_getInxOutputMode ( CDfvObjPtr  pDfvObj  ) 

Get INX output mode.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
output mode of INX.

void dfv_setInxOutputMode ( CDfvObjPtr  pDfvObj,
DfvINXOUTPUTMODE  newVal 
)

Set INX output mode.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal mode of INX.

int dfv_getOmitBlankPages ( CDfvObjPtr  pDfvObj  ) 

Get the specification that omit blank pages.

return Specification that omit blank pages

void dfv_setOmitBlankPages ( CDfvObjPtr  pDfvObj,
int  newVal 
)

Disregard any empty pages.

Effective only when the original file is MS Word or MS Excel. Specifies to disregard any empty pages at the beginning of document. By using this parameter with setEndPage = 1 parameter, it is possible to acquire the output of the first page which has actual contents. Other operation is not guaranteed.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If the value is 'true' is specified, omit blank pages

long dfv_getFlashPartiallyOutput ( CDfvObjPtr  pDfvObj  ) 

Get specifies of the FlashPartiallyOutput.

Since:
2.1
Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
specifies of FlashPartiallyOutput.

void dfv_setFlashPartiallyOutput ( CDfvObjPtr  pDfvObj,
long  newVal 
)

When an error occurs within the document, the flash file in process will be outputted.

Effective when outputting to Flash.

Since:
2.1
Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If the value is 'true' is specified, output the flash file.

long dfv_getFlashHidePageButton ( CDfvObjPtr  pDfvObj  ) 

Get specifies of the FlashHidePageButton.

Since:
3.0
Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
specifies of FlashHidePageButton.

void dfv_setFlashHidePageButton ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Output a no page button.

Effective when outputting to Flash.

Since:
3.0
Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If the value is 'true' is specified, output a no page button.

void dfv_setPrnFitPaper ( CDfvObjPtr  pDfvObj,
int  newVal 
)

It print at size of paper.

Default is false. Effective when outputting to printer, and only Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal If the value is 'true' is specified, print at size of paper.

void dfv_setPdfOutputScale ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Specifies the scaling ratio of the PDF to output.

A value with a unit or % value can be specified as length. Effective when outputting to PDF.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the scaling ratio of the PDF

void dfv_setPdfOutputScaleW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

int dfv_getRasterDPI ( CDfvObjPtr  pDfvObj  ) 

Get the image resolution when outputting JPEG and PNG.

This setting is effective only with Windows version. Effective when outputting to image, and only Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
Image resolution

void dfv_setRasterDPI ( CDfvObjPtr  pDfvObj,
int  newVal 
)

Effective when outputting to image, and only Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Image resolution (50 to 500)

char* dfv_getRasterScale ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Get the image scale when outputting JPEG and PNG.

Effective when outputting to image, and only Windows version.

Parameters:
pDfvObj Pointer to DfvObj 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:
Image scale

wchar_t* dfv_getRasterScaleW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

void dfv_setRasterScale ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Sets the image scale when outputting JPEG and PNG.

A numerical value, "%", or "px" (pixel) is available as the unit. Specify the percentage for a numerical value and "%", and specify the width of image for pixel. Effective when outputting to image, and only Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Image scale

void dfv_setRasterScaleW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

int dfv_getRasterHeight ( CDfvObjPtr  pDfvObj  ) 

Get the maximum image height when outputting JPEG and PNG.


Effective when outputting to image, and only Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
Maximum image height

void dfv_setRasterHeight ( CDfvObjPtr  pDfvObj,
int  newVal 
)

Sets the maximum image height decided by setRasterScale when outputting JPEG and PNG.


"px" (pixel) is available as the unit. Effective when outputting to image, and only Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Maximum image height

char* dfv_getRasterFormat ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Get the file name naming format when outputting PNG and JPEG.


Effective when outputting to image, and only Windows version.

Parameters:
pDfvObj Pointer to DfvObj 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:
format for naming files

wchar_t* dfv_getRasterFormatW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

void dfv_setRasterFormat ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Specifies the file name naming format when outputting PNG and JPEG.


Effective when outputting to image, and only Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal format for naming files

void dfv_setRasterFormatW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

int dfv_getRasterJpegQuality ( CDfvObjPtr  pDfvObj  ) 

Get the conversion accuracy when outputting JPEG.


Effective when outputting to image, and only Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
JPEG quality

void dfv_setRasterJpegQuality ( CDfvObjPtr  pDfvObj,
int  newVal 
)

Specifies the conversion accuracy by the value with the range of 1-100(%) when outputting JPEG.


When this parameter is omitted, it is regarded as 80%. Effective when outputting to image, and only Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal JPEG quality

long dfv_getRasterUseGdiPlus ( CDfvObjPtr  pDfvObj  ) 

Gets specification whether to use GdiPlus .


Effective when outputting to image, and only Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance. return Specification whether to use GdiPlus.

void dfv_setRasterUseGdiPlus ( CDfvObjPtr  pDfvObj,
long  newVal 
)

GdiPlus is used when the file is converted to Jpeg or PNG.


This setting is effective only with Windows XP or later / Windows Server2003. Effective when outputting to image, and only Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Specifies whether to use GdiPlus.

long dfv_getRasterMonochrome ( CDfvObjPtr  pDfvObj  ) 

Gets specification whether to convert to monochrome image, when outputting JPEG and PNG.


Effective when outputting to image, and only Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance. return Specification whether to convert to monochrome.

void dfv_setRasterMonochrome ( CDfvObjPtr  pDfvObj,
long  newVal 
)

Specifies whether to convert to monochrome image, when outputting JPEG and PNG.


Effective when outputting to image, and only Windows version.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Specifies whether to convert to monochrome.

void dfv_setTextPaperHeight ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Specifies the height of the paper when inputting text.

Effective when inputting text.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the height of paper

void dfv_setTextPaperHeightW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

void dfv_setTextPaperWidth ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Specifies the width of the paper when inputting text.

Effective when inputting text.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the width of paper

void dfv_setTextPaperWidthW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

void dfv_setTextMarginLeft ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Specifies the left margin of the paper when inputting text.

Effective when inputting text.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the left margin of the paper

void dfv_setTextMarginLeftW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

void dfv_setTextMarginTop ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Specifies the right margin of the paper when inputting text.

Effective when inputting text.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the top margin of the paper

void dfv_setTextMarginTopW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

void dfv_setTextMarginRight ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Specifies the right margin of the paper when inputting text.

Effective when inputting text.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the right margin of the paper

void dfv_setTextMarginRightW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

void dfv_setTextMarginBottom ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Specifies the right margin of the paper when inputting text.

Effective when inputting text.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the bottom margin of the paper

void dfv_setTextMarginBottomW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

void dfv_setTextFontFamily ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Specifies the font family name when inputting text.

Effective when inputting text.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal font family name

void dfv_setTextFontFamilyW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

void dfv_setTextFontSize ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Specifies the font size when inputting text.

Effective when inputting text.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal font size

void dfv_setTextFontSizeW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

void dfv_setTextShowPageNumber ( CDfvObjPtr  pDfvObj,
int  newVal 
)

Specifies the value of whether show page number or not when inputting text.

Effective when inputting text.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of whether show page number or not

void dfv_setTextShowLineNumber ( CDfvObjPtr  pDfvObj,
int  newVal 
)

Specifies the value of whether show page number or not when inputting text.

Effective when inputting text.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the value of whether show page number or not

void dfv_setTextLineNumberOffset ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Specifies the offset value of range from body area when showing line number and inputting text.

Effective when inputting text.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal the offset value

void dfv_setTextLineNumberOffsetW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

void dfv_setTextLineNumberFormat ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Specifies the line number format when showing line number and inputting text.

Effective when inputting text.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal line number format

void dfv_setTextLineNumberFormatW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

int dfv_getGdiTextAntialias ( CDfvObjPtr  pDfvObj  ) 

Acquires the setting of the smoothing processing to text.


This setting is effective only with Windows XP or later / Windows Server2003 or later.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
Specify whether to perform the smoothing processing to text.

void dfv_setGdiTextAntialias ( CDfvObjPtr  pDfvObj,
int  newVal 
)

Performs the smoothing processing to text.


Effective only when printing and outputting images.
This setting is effective only with Windows XP or later / Windows Server2003 or later.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Performs the smoothing processing when true is specified.

int dfv_getGdiLineartSmoothing ( CDfvObjPtr  pDfvObj  ) 

Acquires the setting of the smoothing processing to borders.


This setting is effective only with Windows XP or later / Windows Server2003 or later.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
Specify whether to perform the smoothing processing to borders.

void dfv_setGdiLineartSmoothing ( CDfvObjPtr  pDfvObj,
int  newVal 
)

Performs the smoothing processing to borders.


Effective only when printing and outputting images.
This setting is effective only with Windows XP or later / Windows Server2003 or later.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Performs the smoothing processing when true is specified.

int dfv_getGdiImageSmoothing ( CDfvObjPtr  pDfvObj  ) 

Acquires the setting of the smoothing processing to images.


This setting is effective only with Windows XP or later / Windows Server2003 or later.

Parameters:
pDfvObj Pointer to DfvObj instance.
Returns:
Specify whether to perform the smoothing processing to images.

void dfv_setGdiImageSmoothing ( CDfvObjPtr  pDfvObj,
int  newVal 
)

Performs the smoothing processing to images.


Effective only when printing and outputting images.
This setting is effective only with Windows XP or later / Windows Server2003 or later.

Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Performs the smoothing processing when true is specified.

char* dfv_getWatermarkText ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Deprecated:
Get the watermark text on each page.
Parameters:
pDfvObj Pointer to DfvObj 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* dfv_getWatermarkTextW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Deprecated:
Get the watermark text on each page.
Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setWatermarkText ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Deprecated:
Displays the specified watermark text on each page. Possible to make it multiple lines by delimiting with the line feed
. This setting is invalid with the evaluation version.
Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string.

void dfv_setWatermarkTextW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Deprecated:
Displays the specified watermark text on each page. Possible to make it multiple lines by delimiting with the line feed
. This setting is invalid with the evaluation version.
Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string.

char* dfv_getWatermarkFontFamily ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Deprecated:
Get the font family of the watermark text.
Parameters:
pDfvObj Pointer to DfvObj 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* dfv_getWatermarkFontFamilyW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Deprecated:
Get the font family of the watermark text.
Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setWatermarkFontFamily ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Deprecated:
Specifies the font family to the character string which you set to watermark-text.
Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string.

void dfv_setWatermarkFontFamilyW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Deprecated:
Specifies the font family to the character string which you set to watermark-text.
Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string.

char* dfv_getWatermarkFontWeight ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Deprecated:
Get the font weight of the watermark text.
Parameters:
pDfvObj Pointer to DfvObj 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* dfv_getWatermarkFontWeightW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Deprecated:
Get the font weight of the watermark text.
Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setWatermarkFontWeight ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Deprecated:
Specifies the font weight to the character string which you set to watermark-text. Possible to specify normal, bold or the numerical value from 100 to 900.
Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string.

void dfv_setWatermarkFontWeightW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Deprecated:
Specifies the font weight to the character string which you set to watermark-text. Possible to specify normal, bold or the numerical value from 100 to 900.
Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string.

char* dfv_getWatermarkFontStyle ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Deprecated:
Get the font style of the watermark text.
Parameters:
pDfvObj Pointer to DfvObj 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* dfv_getWatermarkFontStyleW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Deprecated:
Get the font style of the watermark text.
Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setWatermarkFontStyle ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Deprecated:
Specifies the font style to the character string which you set to watermark-text.
Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string.

void dfv_setWatermarkFontStyleW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Deprecated:
Specifies the font style to the character string which you set to watermark-text.
Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string.

char* dfv_getWatermarkOpacity ( CDfvObjPtr  pDfvObj,
char *  pVal,
int  size 
)

Deprecated:
Get the opacity of the watermark text.
Parameters:
pDfvObj Pointer to DfvObj 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* dfv_getWatermarkOpacityW ( CDfvObjPtr  pDfvObj,
wchar_t *  pVal,
int  size 
)

Deprecated:
Get the opacity of the watermark text.
Parameters:
pDfvObj Pointer to DfvObj 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 dfv_setWatermarkOpacity ( CDfvObjPtr  pDfvObj,
const char *  newVal 
)

Deprecated:
Specifies the opacity to the character string which you set to watermark-text.
Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string.

void dfv_setWatermarkOpacityW ( CDfvObjPtr  pDfvObj,
const wchar_t *  newVal 
)

Deprecated:
Specifies the opacity to the character string which you set to watermark-text.
Parameters:
pDfvObj Pointer to DfvObj instance.
newVal Pointer to a null-terminated string.


Generated on 9 Sep 2010 for Server Based Converter C/C++ Interface by Doxygen 1.5.6