ComPDFKit Conversion C++ SDK 3.0.0
API Documentation
com_config_macros.h File Reference

Go to the source code of this file.

Macros

#define COMPDFKIT_DECL   __attribute__((visibility("default")))
 
#define COMPDFKIT_STRING   const char*
 
#define CSDK_COMPDFKIT_CALL
 

Typedefs

typedef bool(* COMOCRCallback) (const char *image_path, bool enable_ocr)
 A callback function type for handling OCR operations on images.
 
typedef void(* COMProgress) (int current_page, int total_page)
 A callback function type for tracking the progress of a conversion process.
 
typedef void * COMHANDLE
 A generic handle type for managing various operations.
 

Macro Definition Documentation

◆ COMPDFKIT_DECL

#define COMPDFKIT_DECL   __attribute__((visibility("default")))

◆ COMPDFKIT_STRING

#define COMPDFKIT_STRING   const char*

◆ CSDK_COMPDFKIT_CALL

#define CSDK_COMPDFKIT_CALL

Typedef Documentation

◆ COMHANDLE

typedef void* COMHANDLE

A generic handle type for managing various operations.

◆ COMOCRCallback

typedef bool(* COMOCRCallback) (const char *image_path, bool enable_ocr)

A callback function type for handling OCR operations on images.

This callback is designed to handle the process of performing OCR on a given image. It can be used to either initiate OCR on an image or skip it based on the provided flag.

Parameters
[in]image_pathThe path to the input image file on which OCR is to be performed.
[in]enable_ocrA boolean flag indicating whether OCR should be enabled for the specified image.
Returns
A boolean value indicating the success or failure of the operation. True indicates success, while false indicates failure.

◆ COMProgress

typedef void(* COMProgress) (int current_page, int total_page)

A callback function type for tracking the progress of a conversion process.

This callback is designed to be used during operations that involve processing multiple pages, such as converting a document from one format to another. It provides updates on the current page being processed and the total number of pages in the document, allowing for the display or logging of progress.

Parameters
[in]current_pageThe page number that is currently being processed. This value starts at 1 for the first page.
[in]total_pageThe total number of pages in the document being processed.