/*! ** ** \file ptbPreflightAPDFL.h ** ** \brief callas pdfEngine SDK: Preflight API - APDFL interface ** ** The Preflight API has functions for preflighting documents and creating ** preflight reports. ** ** \author © 2009-2011 callas software GmbH, Berlin, Germany - www.callassoftware.com ** */ /******************************************************************************/ #if !defined(PTB_PREFLIGHT_APDFL_H) /*! \def PTB_PREFLIGHT_APDFL_H header define */ #define PTB_PREFLIGHT_APDFL_H /******************************************************************************/ #include "ptbTypes.h" #include "ptbPRCTypes.h" #include "ptbProgress.h" #include "ptbPreflight.h" /******************************************************************************/ /* include PRODUCT file for Acrobat library definition. */ #include "HFTLibrary.h" /* needed to define type of PDDoc */ #include "PDBasicExpT.h" /* needed to define type of CosObj */ #include "CosExpT.h" /******************************************************************************/ #include "ptbProlog.h" /******************************************************************************/ /******************************************************************************* ** Preflight */ /*! ** \brief Runs preflight check ** Runs a preflight check for a given PDF document with a certain ** preflight profile ** ** \note The results ID obtained by this call must be released using the ** PTB_Release() function. ** ** \note All progress information is formatted in the current language ** ** General errors ** \retval PTB_eerrNone No error ** \retval PTB_eerrUnknown Unknown error ** \retval PTB_eerrInternal Internal error ** \retval PTB_eerrMemoryErr Not enough memory ** \retval PTB_eerrParamFailure A parameter is unknown or incorrect ** \retval PTB_eerrIsBusy The preflight engine is busy ** File name errors ** \retval PTB_eerrFileNameInvalid Invalid file name ** \retval PTB_eerrDestVolumeExist Destination volume does not exist (applies only if Profile has Save as PDF/X activated) ** \retval PTB_eerrDestFolderExist Destination folder does not exist (applies only if Profile has Save as PDF/X activated) ** \retval PTB_eerrDestFolderCreate Cannot create destination folder (applies only if Profile has Save as PDF/X activated) ** \retval PTB_eerrDestWrite No write access to destination (applies only if Profile has Save as PDF/X activated) ** Initialization errors ** \retval PTB_eerrNotInitialized Lib not initialized ** PRC errors ** \retval PTB_eerrInvalidEngineID PRC Engine ID is invalid ** \retval PTB_eerrInvalidProfID Profile ID is invalid ** Preflight errors ** \retval PTB_eerrPreflightNoPDFFile The file is not a PDF file, unable to locate root object ** \retval PTB_eerrPreflightPDFHasNoPages Unable to find the specified page ** \retval PTB_eerrPreflightOpenFileErr The PDF file is corrupt (could not be opened) ** \retval PTB_eerrPreflightEncrypted The PDF file is encrypted (processing of encrypted files in callas pdfEngine SDK not supported) ** \retval PTB_eerrPreflightContStrmFailure An error occurred while parsing the contents stream (unable to analyse the PDF file) ** \retval PTB_eerrCancel The caller has canceled the process. ** \retval PTB_eerrPreflightPDFX3CreateFail unable to convert the PDF file to PDF/X-3 (internal error/unknown exception) */ PTB_FUNC_PROTO enum PTB_EError PTB_PDDocPreflight( PDDoc doc /*!< PDF document to preflight */ , PTB_PRCEngineID idEng /*!< ID of PRC Engine that holds preflight profile */ , PTB_PRCProfID idProf /*!< ID of PRC profile to be used for preflight check */ , PTB_HitCB cbHit /*!< CB function to be called for every hit, might be NULL */ , void* cbHitUserData /*!< User data submitted to hit callback function */ , PTB_Preflight_ProgressCB cbProgress /*!< Progress CB function to be called during processing, might be NULL */ , void* cbProgressUserData /*!< User data submitted to progress callback function */ , PTB_SaveCB cbSave /*!< CB function to be called immediately before PDF/X creation, if NULL, no PDF/X PDF/A file gets created, even if requested by preflight profile */ , void* cbSaveUserData /*!< User data submitted to PTB_SaveCB callback function */ , PTB_uint32_t firstPage /*!< First page to be preflighted, this is a zero based index, i.e. first page has value of 0 (zero) */ , PTB_uint32_t lastPage /*!< Last page to be preflighted; might be PTB_MAX_END_PAGE for all pages */ , PTB_ResultID* idResult /*!< On return ID for results from this preflight check, can be NULL to omit preflight check (if possible), please note that then no creation of preflight reports is possible */ , void* reserved /*!< currently unused for future used */ ); PTB_FUNC_PROTO enum PTB_EError PTB_PDDocPreflight2( PDDoc doc /*!< PDF document to preflight */ , PTB_PRCEngineID idEng /*!< ID of PRC Engine that holds preflight profile */ , PTB_PRCProfID idProf /*!< ID of PRC profile to be used for preflight check */ , PTB_PRCEnumDynParamCallback cbDynParam /*!< CB function to be called for every dynamic param in profile, if NULL, the default values are used */ , void* cbDynParamUserData /*!< User data submitted to dyn param callback function */ , PTB_FixupCB cbFixup /*!< CB function to be called for every hit, might be NULL */ , void* cbFixupUserData /*!< User data submitted to hit callback function */ , PTB_HitCB cbHit /*!< CB function to be called for every hit, might be NULL */ , void* cbHitUserData /*!< User data submitted to hit callback function */ , PTB_Preflight_ProgressCB cbProgress /*!< Progress CB function to be called during processing, might be NULL */ , void* cbProgressUserData /*!< User data submitted to progress callback function */ , PTB_SaveCB cbSave /*!< CB function to be called immediately before PDF/X creation, if NULL, no PDF/X PDF/A file gets created, even if requested by preflight profile */ , void* cbSaveUserData /*!< User data submitted to PTB_SaveCB callback function */ , PTB_uint32_t firstPage /*!< First page to be preflighted, this is a zero based index, i.e. first page has value of 0 (zero) */ , PTB_uint32_t lastPage /*!< Last page to be preflighted; might be PTB_MAX_END_PAGE for all pages */ , PTB_ResultID* idResult /*!< On return ID for results from this preflight check, can be NULL to omit preflight check (if possible), please note that then no creation of preflight reports is possible */ , void* reserved /*!< currently unused for future used */ ); PTB_FUNC_PROTO enum PTB_EError PTB_PDDocPreflight3( PDDoc doc /*!< PDF document to preflight */ , PTB_PRCEngineID idEng /*!< ID of PRC Engine that holds preflight profile */ , PTB_PRCProfID idProf /*!< ID of PRC profile to be used for preflight check */ , PTB_PRCEnumDynParamCallback cbDynParam /*!< CB function to be called for every dynamic param in profile, if NULL, the default values are used */ , void* cbDynParamUserData /*!< User data submitted to dyn param callback function */ , PTB_FixupCB cbFixup /*!< CB function to be called for every hit, might be NULL */ , void* cbFixupUserData /*!< User data submitted to hit callback function */ , PTB_HitCB cbHit /*!< CB function to be called for every hit, might be NULL */ , void* cbHitUserData /*!< User data submitted to hit callback function */ , PTB_Preflight_ProgressCB cbProgress /*!< Progress CB function to be called during processing, might be NULL */ , void* cbProgressUserData /*!< User data submitted to progress callback function */ , PTB_SaveCB cbSave /*!< CB function to be called immediately before PDF/X creation, if NULL, no PDF/X PDF/A file gets created, even if requested by preflight profile */ , void* cbSaveUserData /*!< User data submitted to PTB_SaveCB callback function */ , PTB_bool_t fontquickembed /*!< Ignore missing glyphs or width mismatches */ , PTB_uint32_t firstPage /*!< First page to be preflighted, this is a zero based index, i.e. first page has value of 0 (zero) */ , PTB_uint32_t lastPage /*!< Last page to be preflighted; might be PTB_MAX_END_PAGE for all pages */ , PTB_ResultID* idResult /*!< On return ID for results from this preflight check, can be NULL to omit preflight check (if possible), please note that then no creation of preflight reports is possible */ , void* reserved /*!< currently unused for future used */ ); PTB_FUNC_PROTO enum PTB_EError PTB_PDDocPreflight4( PDDoc doc /*!< PDF document to preflight */ , PTB_PRCEngineID idEng /*!< ID of PRC Engine that holds preflight profile */ , PTB_PRCProfID idProf /*!< ID of PRC profile to be used for preflight check */ , PTB_PRCEnumDynParamCallback cbDynParam /*!< CB function to be called for every dynamic param in profile, if NULL, the default values are used */ , void* cbDynParamUserData /*!< User data submitted to dyn param callback function */ , PTB_FixupCB cbFixup /*!< CB function to be called for every hit, might be NULL */ , void* cbFixupUserData /*!< User data submitted to hit callback function */ , PTB_HitCB cbHit /*!< CB function to be called for every hit, might be NULL */ , void* cbHitUserData /*!< User data submitted to hit callback function */ , PTB_Preflight_ProgressCB cbProgress /*!< Progress CB function to be called during processing, might be NULL */ , void* cbProgressUserData /*!< User data submitted to progress callback function */ , PTB_SaveCB cbSave /*!< CB function to be called immediately before PDF/X creation, if NULL, no PDF/X PDF/A file gets created, even if requested by preflight profile */ , void* cbSaveUserData /*!< User data submitted to PTB_SaveCB callback function */ , PTB_bool_t fontquickembed /*!< Ignore missing glyphs or width mismatches */ , PTB_bool_t uncompressimages /*!< Analyzes image pixels for plate count */ , PTB_uint32_t firstPage /*!< First page to be preflighted, this is a zero based index, i.e. first page has value of 0 (zero) */ , PTB_uint32_t lastPage /*!< Last page to be preflighted; might be PTB_MAX_END_PAGE for all pages */ , PTB_ResultID* idResult /*!< On return ID for results from this preflight check, can be NULL to omit preflight check (if possible), please note that then no creation of preflight reports is possible */ , void* reserved /*!< currently unused for future used */ ); PTB_FUNC_PROTO enum PTB_EError PTB_PDDocPreflight5( PDDoc doc /*!< PDF document to preflight */ , PTB_PRCEngineID idEng /*!< ID of PRC Engine that holds preflight profile */ , PTB_PRCProfID idProf /*!< ID of PRC profile to be used for preflight check */ , PTB_PRCEnumDynParamCallback cbDynParam /*!< CB function to be called for every dynamic param in profile, if NULL, the default values are used */ , void* cbDynParamUserData /*!< User data submitted to dyn param callback function */ , PTB_FixupCB cbFixup /*!< CB function to be called for every hit, might be NULL */ , void* cbFixupUserData /*!< User data submitted to hit callback function */ , PTB_HitCB cbHit /*!< CB function to be called for every hit, might be NULL */ , void* cbHitUserData /*!< User data submitted to hit callback function */ , PTB_Preflight_ProgressCB cbProgress /*!< Progress CB function to be called during processing, might be NULL */ , void* cbProgressUserData /*!< User data submitted to progress callback function */ , PTB_SaveCB cbSave /*!< CB function to be called immediately before PDF/X creation, if NULL, no PDF/X PDF/A file gets created, even if requested by preflight profile */ , void* cbSaveUserData /*!< User data submitted to PTB_SaveCB callback function */ , PTB_uint32_t flags /*!< Flags (any combination of PTB_EPreflightFlags values) */ , PTB_uint32_t firstPage /*!< First page to be preflighted, this is a zero based index, i.e. first page has value of 0 (zero) */ , PTB_uint32_t lastPage /*!< Last page to be preflighted; might be PTB_MAX_END_PAGE for all pages */ , PTB_ResultID* idResult /*!< On return ID for results from this preflight check, can be NULL to omit preflight check (if possible), please note that then no creation of preflight reports is possible */ , void* reserved /*!< currently unused for future used */ ); PTB_FUNC_PROTO enum PTB_EError PTB_PDDocPreflight6( PDDoc doc /*!< PDF document to preflight */ , PTB_PRCEngineID idEng /*!< ID of PRC Engine that holds preflight profile */ , PTB_PRCProfID idProf /*!< ID of PRC profile to be used for preflight check */ , PTB_PRCEnumDynParamCallback cbDynParam /*!< CB function to be called for every dynamic param in profile, if NULL, the default values are used */ , void* cbDynParamUserData /*!< User data submitted to dyn param callback function */ , PTB_FixupCB cbFixup /*!< CB function to be called for every hit, might be NULL */ , void* cbFixupUserData /*!< User data submitted to hit callback function */ , PTB_HitCB cbHit /*!< CB function to be called for every hit, might be NULL */ , void* cbHitUserData /*!< User data submitted to hit callback function */ , PTB_Preflight_ProgressCB cbProgress /*!< Progress CB function to be called during processing, might be NULL */ , void* cbProgressUserData /*!< User data submitted to progress callback function */ , PTB_SaveCB cbSave /*!< CB function to be called immediately before PDF/X creation, if NULL, no PDF/X PDF/A file gets created, even if requested by preflight profile */ , void* cbSaveUserData /*!< User data submitted to PTB_SaveCB callback function */ , PTB_uint32_t flags /*!< Flags (any combination of PTB_EPreflightFlags values) */ , PTB_uint32_t hitsperpage /*!< Maximum number of hits in reports per page, might be PTB_MAX_HIT_NUM */ , PTB_uint32_t hitsperdoc /*!< Maximum number of hits in reports per document, might be PTB_MAX_HIT_NUM */ , PTB_uint32_t firstPage /*!< First page to be preflighted, this is a zero based index, i.e. first page has value of 0 (zero) */ , PTB_uint32_t lastPage /*!< Last page to be preflighted; might be PTB_MAX_END_PAGE for all pages */ , PTB_ResultID* idResult /*!< On return ID for results from this preflight check, can be NULL to omit preflight check (if possible), please note that then no creation of preflight reports is possible */ , void* reserved /*!< currently unused for future used */ ); PTB_FUNC_PROTO enum PTB_EError PTB_PDDocPreflight7( PDDoc doc /*!< PDF document to preflight */ , PTB_PRCEngineID idEng /*!< ID of PRC Engine that holds preflight profile */ , PTB_PRCProfID idProf /*!< ID of PRC profile to be used for preflight check */ , PTB_PRCEnumDynParamCallback cbDynParam /*!< CB function to be called for every dynamic param in profile, if NULL, the default values are used */ , void* cbDynParamUserData /*!< User data submitted to dyn param callback function */ , PTB_FixupCB cbFixup /*!< CB function to be called for every hit, might be NULL */ , void* cbFixupUserData /*!< User data submitted to hit callback function */ , PTB_HitCB cbHit /*!< CB function to be called for every hit, might be NULL */ , void* cbHitUserData /*!< User data submitted to hit callback function */ , PTB_Preflight_ProgressCB cbProgress /*!< Progress CB function to be called during processing, might be NULL */ , void* cbProgressUserData /*!< User data submitted to progress callback function */ , PTB_SaveCB cbSave /*!< CB function to be called immediately before PDF/X creation, if NULL, no PDF/X PDF/A file gets created, even if requested by preflight profile */ , void* cbSaveUserData /*!< User data submitted to PTB_SaveCB callback function */ , PTB_uint32_t flags /*!< Flags (any combination of PTB_EPreflightFlags values) */ , PTB_uint32_t hitsperpage /*!< Maximum number of hits in reports per page, might be PTB_MAX_HIT_NUM */ , PTB_uint32_t hitsperdoc /*!< Maximum number of hits in reports per document, might be PTB_MAX_HIT_NUM */ , PTB_uint32_t maxpages /*!< Maximum number of pages - after this limit only pages that have problems will be stored, might be PTB_MAX_PAGE_DEFAULT_NUM */ , PTB_uint32_t firstPage /*!< First page to be preflighted, this is a zero based index, i.e. first page has value of 0 (zero) */ , PTB_uint32_t lastPage /*!< Last page to be preflighted; might be PTB_MAX_END_PAGE for all pages */ , PTB_ResultID* idResult /*!< On return ID for results from this preflight check, can be NULL to omit preflight check (if possible), please note that then no creation of preflight reports is possible */ , void* reserved /*!< currently unused for future used */ ); PTB_FUNC_PROTO enum PTB_EError PTB_PDDocPreflight8( PDDoc doc /*!< PDF document to preflight */ , PTB_PRCEngineID idEng /*!< ID of PRC Engine that holds preflight profile */ , PTB_PRCProfID idProf /*!< ID of PRC profile to be used for preflight check */ , PTB_PRCEnumDynParamCallback cbDynParam /*!< CB function to be called for every dynamic param in profile, if NULL, the default values are used */ , void* cbDynParamUserData /*!< User data submitted to dyn param callback function */ , PTB_FixupCB cbFixup /*!< CB function to be called for every hit, might be NULL */ , void* cbFixupUserData /*!< User data submitted to hit callback function */ , PTB_HitCB cbHit /*!< CB function to be called for every hit, might be NULL */ , void* cbHitUserData /*!< User data submitted to hit callback function */ , PTB_Preflight_ProgressCB cbProgress /*!< Progress CB function to be called during processing, might be NULL */ , void* cbProgressUserData /*!< User data submitted to progress callback function */ , PTB_SaveCB cbSave /*!< CB function to be called immediately before PDF/X creation, if NULL, no PDF/X PDF/A file gets created, even if requested by preflight profile */ , void* cbSaveUserData /*!< User data submitted to PTB_SaveCB callback function */ , PTB_uint32_t flags /*!< Flags (any combination of PTB_EPreflightFlags values) */ , PTB_uint32_t hitsperpage /*!< Maximum number of hits in reports per page, might be PTB_MAX_HIT_NUM */ , PTB_uint32_t hitsperdoc /*!< Maximum number of hits in reports per document, might be PTB_MAX_HIT_NUM */ , PTB_uint32_t maxpages /*!< Maximum number of pages - after this limit only pages that have problems will be stored, might be PTB_MAX_PAGE_DEFAULT_NUM */ , const PTB_Path_t* refxobjectpath /*!< Search path for use with property 'File referenced by reference XObject not found' only, might be NULL to search only beside the input file */ , PTB_uint32_t firstPage /*!< First page to be preflighted, this is a zero based index, i.e. first page has value of 0 (zero) */ , PTB_uint32_t lastPage /*!< Last page to be preflighted; might be PTB_MAX_END_PAGE for all pages */ , PTB_ResultID* idResult /*!< On return ID for results from this preflight check, can be NULL to omit preflight check (if possible), please note that then no creation of preflight reports is possible */ , void* reserved /*!< currently unused for future used */ ); PTB_FUNC_PROTO enum PTB_EError PTB_PDDocPreflight9( PDDoc doc /*!< PDF document to preflight */ , PTB_PRCEngineID idEng /*!< ID of PRC Engine that holds preflight profile */ , PTB_PRCProfID idProf /*!< ID of PRC profile to be used for preflight check */ , PTB_PRCEnumDynParamCallback cbDynParam /*!< CB function to be called for every dynamic param in profile, if NULL, the default values are used */ , void* cbDynParamUserData /*!< User data submitted to dyn param callback function */ , PTB_FixupCB cbFixup /*!< CB function to be called for every hit, might be NULL */ , void* cbFixupUserData /*!< User data submitted to hit callback function */ , PTB_HitCB cbHit /*!< CB function to be called for every hit, might be NULL */ , void* cbHitUserData /*!< User data submitted to hit callback function */ , PTB_Preflight_ProgressCB cbProgress /*!< Progress CB function to be called during processing, might be NULL */ , void* cbProgressUserData /*!< User data submitted to progress callback function */ , PTB_SaveCB cbSave /*!< CB function to be called immediately before PDF/X creation, if NULL, no PDF/X PDF/A file gets created, even if requested by preflight profile */ , void* cbSaveUserData /*!< User data submitted to PTB_SaveCB callback function */ , PTB_uint32_t flags /*!< Flags (any combination of PTB_EPreflightFlags values) */ , PTB_uint32_t hitsperpage /*!< Maximum number of hits in reports per page, might be PTB_MAX_HIT_NUM */ , PTB_uint32_t hitsperdoc /*!< Maximum number of hits in reports per document, might be PTB_MAX_HIT_NUM */ , PTB_uint32_t maxpages /*!< Maximum number of pages - after this limit only pages that have problems will be stored, might be PTB_MAX_PAGE_DEFAULT_NUM */ , const PTB_Path_t* refxobjectpath /*!< Search path for use with property 'File referenced by reference XObject not found' only, might be NULL to search only beside the input file */ , enum PTB_ESyntaxCheckSeverity syntaxChecks /*!< Syntax checks severity, see PTB_ESyntaxCheckSeverity */ , PTB_uint32_t firstPage /*!< First page to be preflighted, this is a zero based index, i.e. first page has value of 0 (zero) */ , PTB_uint32_t lastPage /*!< Last page to be preflighted; might be PTB_MAX_END_PAGE for all pages */ , PTB_ResultID* idResult /*!< On return ID for results from this preflight check, can be NULL to omit preflight check (if possible), please note that then no creation of preflight reports is possible */ , void* reserved /*!< currently unused for future used */ ); /******************************************************************************/ /*! ** \brief Run a meta profile (Process plan) ** Runs a preflight check for a given document with a certain ** preflight profile ** ** \note The results ID obtained by this call must be released using the ** PTB_PreflightRelease() function. ** ** \note All progress information is formatted in the current language ** ** General errors ** \retval PTB_eerrNone No error ** \retval PTB_eerrUnknown Unknown error ** \retval PTB_eerrInternal Internal error ** \retval PTB_eerrMemoryErr Not enough memory ** \retval PTB_eerrParamFailure A parameter is unknown or incorrect ** \retval PTB_eerrIsBusy The preflight engine is busy ** File name errors ** \retval PTB_eerrFileNameInvalid Invalid file name ** \retval PTB_eerrDestVolumeExist Destination volume does not exist ** \retval PTB_eerrDestFolderExist Destination folder does not exist ** \retval PTB_eerrDestFolderCreate Cannot create destination folder ** \retval PTB_eerrDestWrite No write access to destination ** Initialization errors ** \retval PTB_eerrNotInitialized Lib not initialized ** PRC errors ** \retval PTB_eerrInvalidEngineID PRC Engine ID is invalid ** \retval PTB_eerrInvalidProfID Profile ID is invalid ** Preflight errors ** \retval PTB_eerrPreflightNoPDFFile The file is not a PDF file, unable to locate root object ** \retval PTB_eerrPreflightPDFHasNoPages Unable to find the specified page ** \retval PTB_eerrPreflightOpenFileErr The PDF file is corrupt (could not be opened) ** \retval PTB_eerrPreflightEncrypted The PDF file is encrypted (processing of encrypted files in callas pdfEngine SDK not supported) ** \retval PTB_eerrPreflightContStrmFailure An error occurred while parsing the contents stream (unable to analyse the PDF file) ** \retval PTB_eerrCancel The caller has canceled the process. */ PTB_FUNC_PROTO enum PTB_EError PTB_PDDocPreflightMetaProfile( PDDoc doc /*!< Document to preflight */ , PTB_PRCEngineID idEng /*!< ID of PRC Engine that holds preflight meta profile */ , PTB_PRCMPrfID idMPrf /*!< ID of PRC meta profile to be used for preflight check */ , PTB_PRCEnumDynParamCallback cbDynParam /*!< CB function to be called for every dynamic param in profile, if NULL, the default values are used */ , void* cbDynParamUserData /*!< User data submitted to dyn param callback function */ , PTB_SequenceCB cbSequence /*!< CB function to be called for every sequence, might be NULL */ , void* cbSequenceUserData /*!< User data submitted to sequence callback function */ , PTB_FixupCB cbFixup /*!< CB function to be called for every hit, might be NULL */ , void* cbFixupUserData /*!< User data submitted to hit callback function */ , PTB_HitCB cbHit /*!< CB function to be called for every hit, might be NULL */ , void* cbHitUserData /*!< User data submitted to hit callback function */ , PTB_Preflight_ProgressCB cbProgress /*!< Progress CB function to be called during processing, might be NULL */ , void* cbProgressUserData /*!< User data submitted to progress callback function */ , PTB_SequenceSaveCB cbSave /*!< CB function to be called if the SDK needs to save th document or a report, if NULL the original 'doc' will be overwritten */ , void* cbSaveUserData /*!< User data submitted to PTB_SequenceSaveCB callback function */ , PTB_uint32_t flags /*!< Flags (any combination of PTB_EPreflightFlags values) */ , PTB_uint32_t firstPage /*!< First page to be preflighted, this is a zero based index, i.e. first page has value of 0 (zero) */ , PTB_uint32_t lastPage /*!< Last page to be preflighted; might be PTB_MAX_END_PAGE for all pages */ , PTB_ResultID* idResult /*!< On return ID for results from this preflight run, please note only the report data of the last sequence step is available */ , void* reserved /*!< currently unused for future used */ ); PTB_FUNC_PROTO enum PTB_EError PTB_PDDocPreflightMetaProfile2( PDDoc doc /*!< Document to preflight */ , PTB_PRCEngineID idEng /*!< ID of PRC Engine that holds preflight meta profile */ , PTB_PRCMPrfID idMPrf /*!< ID of PRC meta profile to be used for preflight check */ , PTB_PRCEnumDynParamCallback cbDynParam /*!< CB function to be called for every dynamic param in profile, if NULL, the default values are used */ , void* cbDynParamUserData /*!< User data submitted to dyn param callback function */ , PTB_SequenceCB cbSequence /*!< CB function to be called for every sequence, might be NULL */ , void* cbSequenceUserData /*!< User data submitted to sequence callback function */ , PTB_FixupCB cbFixup /*!< CB function to be called for every hit, might be NULL */ , void* cbFixupUserData /*!< User data submitted to hit callback function */ , PTB_HitCB cbHit /*!< CB function to be called for every hit, might be NULL */ , void* cbHitUserData /*!< User data submitted to hit callback function */ , PTB_Preflight_ProgressCB cbProgress /*!< Progress CB function to be called during processing, might be NULL */ , void* cbProgressUserData /*!< User data submitted to progress callback function */ , PTB_SequenceSaveCB cbSave /*!< CB function to be called if the SDK needs to save th document or a report, if NULL the original 'doc' will be overwritten */ , void* cbSaveUserData /*!< User data submitted to PTB_SequenceSaveCB callback function */ , PTB_uint32_t flags /*!< Flags (any combination of PTB_EPreflightFlags values) */ , PTB_uint32_t hitsperpage /*!< Maximum number of hits in reports per page, might be PTB_MAX_HIT_NUM */ , PTB_uint32_t hitsperdoc /*!< Maximum number of hits in reports per document, might be PTB_MAX_HIT_NUM */ , PTB_uint32_t firstPage /*!< First page to be preflighted, this is a zero based index, i.e. first page has value of 0 (zero) */ , PTB_uint32_t lastPage /*!< Last page to be preflighted; might be PTB_MAX_END_PAGE for all pages */ , PTB_ResultID* idResult /*!< On return ID for results from this preflight run, please note only the report data of the last sequence step is available */ , void* reserved /*!< currently unused for future used */ ); PTB_FUNC_PROTO enum PTB_EError PTB_PDDocPreflightMetaProfile3( PDDoc doc /*!< Document to preflight */ , PTB_PRCEngineID idEng /*!< ID of PRC Engine that holds preflight meta profile */ , PTB_PRCMPrfID idMPrf /*!< ID of PRC meta profile to be used for preflight check */ , PTB_PRCEnumDynParamCallback cbDynParam /*!< CB function to be called for every dynamic param in profile, if NULL, the default values are used */ , void* cbDynParamUserData /*!< User data submitted to dyn param callback function */ , PTB_SequenceCB cbSequence /*!< CB function to be called for every sequence, might be NULL */ , void* cbSequenceUserData /*!< User data submitted to sequence callback function */ , PTB_FixupCB cbFixup /*!< CB function to be called for every hit, might be NULL */ , void* cbFixupUserData /*!< User data submitted to hit callback function */ , PTB_HitCB cbHit /*!< CB function to be called for every hit, might be NULL */ , void* cbHitUserData /*!< User data submitted to hit callback function */ , PTB_Preflight_ProgressCB cbProgress /*!< Progress CB function to be called during processing, might be NULL */ , void* cbProgressUserData /*!< User data submitted to progress callback function */ , PTB_SequenceSaveCB cbSave /*!< CB function to be called if the SDK needs to save th document or a report, if NULL the original 'doc' will be overwritten */ , void* cbSaveUserData /*!< User data submitted to PTB_SequenceSaveCB callback function */ , PTB_uint32_t flags /*!< Flags (any combination of PTB_EPreflightFlags values) */ , PTB_uint32_t hitsperpage /*!< Maximum number of hits in reports per page, might be PTB_MAX_HIT_NUM */ , PTB_uint32_t hitsperdoc /*!< Maximum number of hits in reports per document, might be PTB_MAX_HIT_NUM */ , PTB_uint32_t maxpages /*!< Maximum number of pages - after this limit only pages that have problems will be stored, might be PTB_MAX_PAGE_DEFAULT_NUM */ , PTB_uint32_t firstPage /*!< First page to be preflighted, this is a zero based index, i.e. first page has value of 0 (zero) */ , PTB_uint32_t lastPage /*!< Last page to be preflighted; might be PTB_MAX_END_PAGE for all pages */ , PTB_ResultID* idResult /*!< On return ID for results from this preflight run, please note only the report data of the last sequence step is available */ , void* reserved /*!< currently unused for future used */ ); PTB_FUNC_PROTO enum PTB_EError PTB_PDDocPreflightMetaProfile4( PDDoc doc /*!< Document to preflight */ , PTB_PRCEngineID idEng /*!< ID of PRC Engine that holds preflight meta profile */ , PTB_PRCMPrfID idMPrf /*!< ID of PRC meta profile to be used for preflight check */ , PTB_PRCEnumDynParamCallback cbDynParam /*!< CB function to be called for every dynamic param in profile, if NULL, the default values are used */ , void* cbDynParamUserData /*!< User data submitted to dyn param callback function */ , PTB_SequenceCB cbSequence /*!< CB function to be called for every sequence, might be NULL */ , void* cbSequenceUserData /*!< User data submitted to sequence callback function */ , PTB_FixupCB cbFixup /*!< CB function to be called for every hit, might be NULL */ , void* cbFixupUserData /*!< User data submitted to hit callback function */ , PTB_HitCB cbHit /*!< CB function to be called for every hit, might be NULL */ , void* cbHitUserData /*!< User data submitted to hit callback function */ , PTB_Preflight_ProgressCB cbProgress /*!< Progress CB function to be called during processing, might be NULL */ , void* cbProgressUserData /*!< User data submitted to progress callback function */ , PTB_SequenceSaveCB cbSave /*!< CB function to be called if the SDK needs to save th document or a report, if NULL the original 'doc' will be overwritten */ , void* cbSaveUserData /*!< User data submitted to PTB_SequenceSaveCB callback function */ , PTB_uint32_t flags /*!< Flags (any combination of PTB_EPreflightFlags values) */ , PTB_uint32_t hitsperpage /*!< Maximum number of hits in reports per page, might be PTB_MAX_HIT_NUM */ , PTB_uint32_t hitsperdoc /*!< Maximum number of hits in reports per document, might be PTB_MAX_HIT_NUM */ , PTB_uint32_t maxpages /*!< Maximum number of pages - after this limit only pages that have problems will be stored, might be PTB_MAX_PAGE_DEFAULT_NUM */ , enum PTB_ESyntaxCheckSeverity syntaxChecks /*!< Syntax checks severity, see PTB_ESyntaxCheckSeverity */ , PTB_uint32_t firstPage /*!< First page to be preflighted, this is a zero based index, i.e. first page has value of 0 (zero) */ , PTB_uint32_t lastPage /*!< Last page to be preflighted; might be PTB_MAX_END_PAGE for all pages */ , PTB_ResultID* idResult /*!< On return ID for results from this preflight run, please note only the report data of the last sequence step is available */ , void* reserved /*!< currently unused for future used */ ); /******************************************************************************/ enum PTB_EHitCosObjType { PTB_ehcotPageCosObj /*!< Page CosObj */ , PTB_ehcotHitCosObj /*!< Type see PTB_EHitType and can be retrieved with 'PTB_ResultGetHitData()' Only available for PTB_ehtTextFill, PTB_ehtTextOutline, PTB_ehtTextInvisible PTB_ehtImage, PTB_ehtFormXObj, PTB_ehtShade */ }; /*! ** \brief Get hit CosObj ** ** Get hit CosObj ** \note Possible values for \a ehcot are: ** PTB_ehcotPageCosObj ** - cosObj must point to a CosObj ** PTB_ehcotHitCosObj ** - cosObj must point to a CosObj ** ** \retval PTB_eerrNone No error ** \retval PTB_eerrParamFailure A parameter is unknown or incorrect ** */ PTB_FUNC_PROTO enum PTB_EError PTB_ResultGetHitCosObj( PTB_ResultID idResult /*!< ID of Result to get Hit data from */ , PTB_HitID idHit /*!< ID of Hit to get data from */ , enum PTB_EHitCosObjType ehcot /*!< Data type to retrieve */ , CosObj* cosObj /*!< Pointer to CosObj data */ ); /******************************************************************************/ #include "ptbEpilog.h" /******************************************************************************/ #endif // PTB_PREFLIGHT_APDFL_H /******************************************************************************/ /* EOF */