PdfTools_PdfToolsExtraction.h

Go to the documentation of this file.

/******************************************************************************
 *
 * File:            PdfTools_PdfToolsExtraction.h
 *
 * Description:     Sub Header file for Pdftools SDK
 *
 * Author:          PDF Tools AG
 *
 * Copyright:       Copyright (C) 2023 - 2025 PDF Tools AG, Switzerland
 *                  All rights reserved.
 *
 * Notice:          By downloading and using this artifact, you accept PDF Tools AG's
 *                  [license agreement](https://www.pdf-tools.com/license-agreement/),
 *                  [privacy policy](https://www.pdf-tools.com/privacy-policy/),
 *                  and allow PDF Tools AG to track your usage data.
 *
 *****************************************************************************/
 
#ifndef PDFTOOLS_PDFTOOLSEXTRACTION_H__
#define PDFTOOLS_PDFTOOLSEXTRACTION_H__
 
#ifndef PDFTOOLS_CALL
#if defined(WIN32)
#define PDFTOOLS_CALL __stdcall
#else
#define PDFTOOLS_CALL
#endif
#endif
 
#include "PdfTools_Types.h"
#include "PdfTools_PdfToolsSys.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#ifdef _UNICODE
#else
#endif
 
/******************************************************************************
 * TextOptions
 *****************************************************************************/
PDFTOOLS_EXPORT TPdfToolsExtraction_TextOptions* PDFTOOLS_CALL PdfToolsExtraction_TextOptions_New(void);
 
PDFTOOLS_EXPORT TPdfToolsExtraction_TextExtractionFormat PDFTOOLS_CALL
PdfToolsExtraction_TextOptions_GetExtractionFormat(TPdfToolsExtraction_TextOptions* pTextOptions);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsExtraction_TextOptions_SetExtractionFormat(
    TPdfToolsExtraction_TextOptions* pTextOptions, TPdfToolsExtraction_TextExtractionFormat iExtractionFormat);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
PdfToolsExtraction_TextOptions_GetAdvanceWidth(TPdfToolsExtraction_TextOptions* pTextOptions, double* pAdvanceWidth);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsExtraction_TextOptions_SetAdvanceWidth(
    TPdfToolsExtraction_TextOptions* pTextOptions, const double* pAdvanceWidth);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
PdfToolsExtraction_TextOptions_GetLineHeight(TPdfToolsExtraction_TextOptions* pTextOptions, double* pLineHeight);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL
PdfToolsExtraction_TextOptions_SetLineHeight(TPdfToolsExtraction_TextOptions* pTextOptions, const double* pLineHeight);
PDFTOOLS_EXPORT double PDFTOOLS_CALL
PdfToolsExtraction_TextOptions_GetWordSeparationFactor(TPdfToolsExtraction_TextOptions* pTextOptions);
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsExtraction_TextOptions_SetWordSeparationFactor(
    TPdfToolsExtraction_TextOptions* pTextOptions, double dWordSeparationFactor);
 
/******************************************************************************
 * Extractor
 *****************************************************************************/
PDFTOOLS_EXPORT TPdfToolsExtraction_Extractor* PDFTOOLS_CALL PdfToolsExtraction_Extractor_New(void);
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsExtraction_Extractor_ExtractText(
    TPdfToolsExtraction_Extractor* pExtractor, TPdfToolsPdf_Document* pInDoc,
    const TPdfToolsSys_StreamDescriptor* pOutStreamDesc, TPdfToolsExtraction_TextOptions* pOptions,
    const int* pFirstPage, const int* pLastPage);
 
#ifdef __cplusplus
}
#endif
 
#endif /* PDFTOOLS_PDFTOOLSEXTRACTION_H__ */