Pdftools SDK
Loading...
Searching...
No Matches
Macros | Functions
PdfTools_PdfToolsImage2Pdf.h File Reference
#include "PdfTools_Types.h"
#include "PdfTools_PdfToolsSys.h"

Go to the source code of this file.

Macros

#define PDFTOOLS_CALL
 

Functions

PDFTOOLS_EXPORT TPdfToolsImage2Pdf_ImageMappingType PDFTOOLS_CALL PdfToolsImage2Pdf_ImageMapping_GetType (TPdfToolsImage2Pdf_ImageMapping *pImageMapping)
 Get actual derived type of base type TPdfToolsImage2Pdf_ImageMapping.
 
PDFTOOLS_EXPORT TPdfToolsImage2Pdf_Auto *PDFTOOLS_CALL PdfToolsImage2Pdf_Auto_New (void)
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_Auto_GetMaxPageSize (TPdfToolsImage2Pdf_Auto *pAuto, TPdfToolsGeomUnits_Size *pMaxPageSize)
 The maximum page size.
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_Auto_SetMaxPageSize (TPdfToolsImage2Pdf_Auto *pAuto, const TPdfToolsGeomUnits_Size *pMaxPageSize)
 The maximum page size.
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_Auto_GetDefaultPageMargin (TPdfToolsImage2Pdf_Auto *pAuto, TPdfToolsGeomUnits_Margin *pDefaultPageMargin)
 The default page margin Default value: 20mm (0.79in)
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_Auto_SetDefaultPageMargin (TPdfToolsImage2Pdf_Auto *pAuto, const TPdfToolsGeomUnits_Margin *pDefaultPageMargin)
 The default page margin Default value: 20mm (0.79in)
 
PDFTOOLS_EXPORT TPdfToolsImage2Pdf_ShrinkToPage *PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPage_New (void)
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPage_GetPageSize (TPdfToolsImage2Pdf_ShrinkToPage *pShrinkToPage, TPdfToolsGeomUnits_Size *pPageSize)
 The page size.
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPage_SetPageSize (TPdfToolsImage2Pdf_ShrinkToPage *pShrinkToPage, const TPdfToolsGeomUnits_Size *pPageSize)
 The page size.
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPage_GetPageMargin (TPdfToolsImage2Pdf_ShrinkToPage *pShrinkToPage, TPdfToolsGeomUnits_Margin *pPageMargin)
 The page margin Default value: 20mm (0.79in)
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPage_SetPageMargin (TPdfToolsImage2Pdf_ShrinkToPage *pShrinkToPage, const TPdfToolsGeomUnits_Margin *pPageMargin)
 The page margin Default value: 20mm (0.79in)
 
PDFTOOLS_EXPORT TPdfToolsImage2Pdf_ShrinkToFit *PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToFit_New (void)
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToFit_GetPageSize (TPdfToolsImage2Pdf_ShrinkToFit *pShrinkToFit, TPdfToolsGeomUnits_Size *pPageSize)
 The page size.
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToFit_SetPageSize (TPdfToolsImage2Pdf_ShrinkToFit *pShrinkToFit, const TPdfToolsGeomUnits_Size *pPageSize)
 The page size.
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToFit_GetPageMargin (TPdfToolsImage2Pdf_ShrinkToFit *pShrinkToFit, TPdfToolsGeomUnits_Margin *pPageMargin)
 The page margin Default value: 20mm (0.79in)
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToFit_SetPageMargin (TPdfToolsImage2Pdf_ShrinkToFit *pShrinkToFit, const TPdfToolsGeomUnits_Margin *pPageMargin)
 The page margin Default value: 20mm (0.79in)
 
PDFTOOLS_EXPORT TPdfToolsImage2Pdf_ShrinkToPortrait *PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPortrait_New (void)
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPortrait_GetPageSize (TPdfToolsImage2Pdf_ShrinkToPortrait *pShrinkToPortrait, TPdfToolsGeomUnits_Size *pPageSize)
 The page size.
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPortrait_SetPageSize (TPdfToolsImage2Pdf_ShrinkToPortrait *pShrinkToPortrait, const TPdfToolsGeomUnits_Size *pPageSize)
 The page size.
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPortrait_GetPageMargin (TPdfToolsImage2Pdf_ShrinkToPortrait *pShrinkToPortrait, TPdfToolsGeomUnits_Margin *pPageMargin)
 The page margin Default value: 20mm (0.79in)
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPortrait_SetPageMargin (TPdfToolsImage2Pdf_ShrinkToPortrait *pShrinkToPortrait, const TPdfToolsGeomUnits_Margin *pPageMargin)
 The page margin Default value: 20mm (0.79in)
 
PDFTOOLS_EXPORT TPdfToolsImage2Pdf_ImageMapping *PDFTOOLS_CALL PdfToolsImage2Pdf_ImageOptions_GetMapping (TPdfToolsImage2Pdf_ImageOptions *pImageOptions)
 The image mapping.
 
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ImageOptions_SetMapping (TPdfToolsImage2Pdf_ImageOptions *pImageOptions, TPdfToolsImage2Pdf_ImageMapping *pMapping)
 The image mapping.
 
PDFTOOLS_EXPORT TPdfToolsImage2Pdf_Converter *PDFTOOLS_CALL PdfToolsImage2Pdf_Converter_New (void)
 
PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsImage2Pdf_Converter_Convert (TPdfToolsImage2Pdf_Converter *pConverter, TPdfToolsImage_Document *pImage, const TPdfToolsSys_StreamDescriptor *pOutStreamDesc, TPdfToolsImage2PdfProfiles_Profile *pProfile, TPdfToolsPdf_OutputOptions *pOutOptions)
 Convert an image to a PDF document.
 
PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsImage2Pdf_Converter_ConvertMultiple (TPdfToolsImage2Pdf_Converter *pConverter, TPdfToolsImage_DocumentList *pImages, const TPdfToolsSys_StreamDescriptor *pOutStreamDesc, TPdfToolsImage2PdfProfiles_Profile *pProfile, TPdfToolsPdf_OutputOptions *pOutOptions)
 Convert a list of images to a PDF document.
 

Macro Definition Documentation

◆ PDFTOOLS_CALL

#define PDFTOOLS_CALL

Function Documentation

◆ PdfToolsImage2Pdf_Auto_GetDefaultPageMargin()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_Auto_GetDefaultPageMargin ( TPdfToolsImage2Pdf_Auto * pAuto,
TPdfToolsGeomUnits_Margin * pDefaultPageMargin )

The default page margin Default value: 20mm (0.79in)

Parameters
[in,out]pAutoActs as a handle to the native object of type TPdfToolsImage2Pdf_Auto.
[out]pDefaultPageMarginRetrieved value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_Auto_GetMaxPageSize()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_Auto_GetMaxPageSize ( TPdfToolsImage2Pdf_Auto * pAuto,
TPdfToolsGeomUnits_Size * pMaxPageSize )

The maximum page size.

Each image is scaled individually such that neither the width nor the height exceeds the maximum page size. For landscape images the maximum page size is assumed to be landscape, and equivalently for portrait images.

Default value: "A4" (210mm 297mm)

Parameters
[in,out]pAutoActs as a handle to the native object of type TPdfToolsImage2Pdf_Auto.
[out]pMaxPageSizeRetrieved value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_Auto_New()

PDFTOOLS_EXPORT TPdfToolsImage2Pdf_Auto *PDFTOOLS_CALL PdfToolsImage2Pdf_Auto_New ( void )
Returns
Handle to the newly created native object.

NULL if there is an error.

Note
An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsImage2Pdf_Auto_SetDefaultPageMargin()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_Auto_SetDefaultPageMargin ( TPdfToolsImage2Pdf_Auto * pAuto,
const TPdfToolsGeomUnits_Margin * pDefaultPageMargin )

The default page margin Default value: 20mm (0.79in)

Parameters
[in,out]pAutoActs as a handle to the native object of type TPdfToolsImage2Pdf_Auto.
[in]pDefaultPageMarginSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_Auto_SetMaxPageSize()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_Auto_SetMaxPageSize ( TPdfToolsImage2Pdf_Auto * pAuto,
const TPdfToolsGeomUnits_Size * pMaxPageSize )

The maximum page size.

Each image is scaled individually such that neither the width nor the height exceeds the maximum page size. For landscape images the maximum page size is assumed to be landscape, and equivalently for portrait images.

Default value: "A4" (210mm 297mm)

Parameters
[in,out]pAutoActs as a handle to the native object of type TPdfToolsImage2Pdf_Auto.
[in]pMaxPageSizeSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_Converter_Convert()

Convert an image to a PDF document.

Parameters
[in,out]pConverterActs as a handle to the native object of type TPdfToolsImage2Pdf_Converter.
[in,out]pImageThe input image document containing one or more pages.
[in,out]pOutStreamDescThe stream to which the PDF is written.
[in,out]pProfileThe profile defines the properties of the output document and how the images are placed onto the pages. For details, see TPdfToolsImage2PdfProfiles_Profile.
[in,out]pOutOptionsThe PDF output options, e.g. to encrypt the output document.
Returns
The resulting output PDF which can be used as a new input for further processing.

Note that, this object must be disposed before the output stream object (method argument pOutStreamDesc).

NULL if there is an error.

Note
An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_Converter_ConvertMultiple()

PDFTOOLS_EXPORT TPdfToolsPdf_Document *PDFTOOLS_CALL PdfToolsImage2Pdf_Converter_ConvertMultiple ( TPdfToolsImage2Pdf_Converter * pConverter,
TPdfToolsImage_DocumentList * pImages,
const TPdfToolsSys_StreamDescriptor * pOutStreamDesc,
TPdfToolsImage2PdfProfiles_Profile * pProfile,
TPdfToolsPdf_OutputOptions * pOutOptions )

Convert a list of images to a PDF document.

Parameters
[in,out]pConverterActs as a handle to the native object of type TPdfToolsImage2Pdf_Converter.
[in,out]pImagesThe input image document list, each image containing one or more pages.
[in,out]pOutStreamDescThe stream to which the PDF is written.
[in,out]pProfileThe profile defines the properties of the output document and how the images are placed onto the pages. For details, see TPdfToolsImage2PdfProfiles_Profile.
[in,out]pOutOptionsThe PDF output options, e.g. to encrypt the output document.
Returns
The resulting output PDF which can be used as a new input for further processing.

Note that, this object must be disposed before the output stream object (method argument pOutStreamDesc).

NULL if there is an error.

Note
An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_Converter_New()

PDFTOOLS_EXPORT TPdfToolsImage2Pdf_Converter *PDFTOOLS_CALL PdfToolsImage2Pdf_Converter_New ( void )
Returns
Handle to the newly created native object.

NULL if there is an error.

Note
An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsImage2Pdf_ImageMapping_GetType()

PDFTOOLS_EXPORT TPdfToolsImage2Pdf_ImageMappingType PDFTOOLS_CALL PdfToolsImage2Pdf_ImageMapping_GetType ( TPdfToolsImage2Pdf_ImageMapping * pImageMapping)

Get actual derived type of base type TPdfToolsImage2Pdf_ImageMapping.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters
[in,out]pImageMappingActs as a handle to a native object.
Returns
The item of the enumeration TPdfToolsImage2Pdf_ImageMappingType that refers to the actual derived type. 0 in case of an error.
Note
An error occurred when 0 is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsImage2Pdf_ImageOptions_GetMapping()

PDFTOOLS_EXPORT TPdfToolsImage2Pdf_ImageMapping *PDFTOOLS_CALL PdfToolsImage2Pdf_ImageOptions_GetMapping ( TPdfToolsImage2Pdf_ImageOptions * pImageOptions)

The image mapping.

The image mapping specifies how an input image is transformed and placed onto the output PDF page.

Default: TPdfToolsImage2Pdf_ShrinkToFit

Parameters
[in,out]pImageOptionsActs as a handle to the native object of type TPdfToolsImage2Pdf_ImageOptions.
Returns
Retrieved value.

NULL if there is an error.

Note
An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsImage2Pdf_ImageOptions_SetMapping()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ImageOptions_SetMapping ( TPdfToolsImage2Pdf_ImageOptions * pImageOptions,
TPdfToolsImage2Pdf_ImageMapping * pMapping )

The image mapping.

The image mapping specifies how an input image is transformed and placed onto the output PDF page.

Default: TPdfToolsImage2Pdf_ShrinkToFit

Parameters
[in,out]pImageOptionsActs as a handle to the native object of type TPdfToolsImage2Pdf_ImageOptions.
[in,out]pMappingSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsImage2Pdf_ShrinkToFit_GetPageMargin()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToFit_GetPageMargin ( TPdfToolsImage2Pdf_ShrinkToFit * pShrinkToFit,
TPdfToolsGeomUnits_Margin * pPageMargin )

The page margin Default value: 20mm (0.79in)

Parameters
[in,out]pShrinkToFitActs as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToFit.
[out]pPageMarginRetrieved value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_ShrinkToFit_GetPageSize()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToFit_GetPageSize ( TPdfToolsImage2Pdf_ShrinkToFit * pShrinkToFit,
TPdfToolsGeomUnits_Size * pPageSize )

The page size.

All output pages are created as that size.

Default value: "A4" (210mm 297mm)

Parameters
[in,out]pShrinkToFitActs as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToFit.
[out]pPageSizeRetrieved value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_ShrinkToFit_New()

PDFTOOLS_EXPORT TPdfToolsImage2Pdf_ShrinkToFit *PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToFit_New ( void )
Returns
Handle to the newly created native object.

NULL if there is an error.

Note
An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsImage2Pdf_ShrinkToFit_SetPageMargin()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToFit_SetPageMargin ( TPdfToolsImage2Pdf_ShrinkToFit * pShrinkToFit,
const TPdfToolsGeomUnits_Margin * pPageMargin )

The page margin Default value: 20mm (0.79in)

Parameters
[in,out]pShrinkToFitActs as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToFit.
[in]pPageMarginSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_ShrinkToFit_SetPageSize()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToFit_SetPageSize ( TPdfToolsImage2Pdf_ShrinkToFit * pShrinkToFit,
const TPdfToolsGeomUnits_Size * pPageSize )

The page size.

All output pages are created as that size.

Default value: "A4" (210mm 297mm)

Parameters
[in,out]pShrinkToFitActs as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToFit.
[in]pPageSizeSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_ShrinkToPage_GetPageMargin()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPage_GetPageMargin ( TPdfToolsImage2Pdf_ShrinkToPage * pShrinkToPage,
TPdfToolsGeomUnits_Margin * pPageMargin )

The page margin Default value: 20mm (0.79in)

Parameters
[in,out]pShrinkToPageActs as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPage.
[out]pPageMarginRetrieved value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_ShrinkToPage_GetPageSize()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPage_GetPageSize ( TPdfToolsImage2Pdf_ShrinkToPage * pShrinkToPage,
TPdfToolsGeomUnits_Size * pPageSize )

The page size.

All output pages are created with that size. The default page orientation is portrait, but if the image fits better, the page is rotated to landscape.

Default value: "A4" (210mm 297mm)

Parameters
[in,out]pShrinkToPageActs as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPage.
[out]pPageSizeRetrieved value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_ShrinkToPage_New()

PDFTOOLS_EXPORT TPdfToolsImage2Pdf_ShrinkToPage *PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPage_New ( void )
Returns
Handle to the newly created native object.

NULL if there is an error.

Note
An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsImage2Pdf_ShrinkToPage_SetPageMargin()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPage_SetPageMargin ( TPdfToolsImage2Pdf_ShrinkToPage * pShrinkToPage,
const TPdfToolsGeomUnits_Margin * pPageMargin )

The page margin Default value: 20mm (0.79in)

Parameters
[in,out]pShrinkToPageActs as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPage.
[in]pPageMarginSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_ShrinkToPage_SetPageSize()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPage_SetPageSize ( TPdfToolsImage2Pdf_ShrinkToPage * pShrinkToPage,
const TPdfToolsGeomUnits_Size * pPageSize )

The page size.

All output pages are created with that size. The default page orientation is portrait, but if the image fits better, the page is rotated to landscape.

Default value: "A4" (210mm 297mm)

Parameters
[in,out]pShrinkToPageActs as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPage.
[in]pPageSizeSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_ShrinkToPortrait_GetPageMargin()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPortrait_GetPageMargin ( TPdfToolsImage2Pdf_ShrinkToPortrait * pShrinkToPortrait,
TPdfToolsGeomUnits_Margin * pPageMargin )

The page margin Default value: 20mm (0.79in)

Parameters
[in,out]pShrinkToPortraitActs as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPortrait.
[out]pPageMarginRetrieved value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_ShrinkToPortrait_GetPageSize()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPortrait_GetPageSize ( TPdfToolsImage2Pdf_ShrinkToPortrait * pShrinkToPortrait,
TPdfToolsGeomUnits_Size * pPageSize )

The page size.

All output pages are created as that size and in portrait mode.

Default value: "A4" (210mm 297mm)

Parameters
[in,out]pShrinkToPortraitActs as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPortrait.
[out]pPageSizeRetrieved value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_ShrinkToPortrait_New()

PDFTOOLS_EXPORT TPdfToolsImage2Pdf_ShrinkToPortrait *PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPortrait_New ( void )
Returns
Handle to the newly created native object.

NULL if there is an error.

Note
An error occurred when NULL is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage.

◆ PdfToolsImage2Pdf_ShrinkToPortrait_SetPageMargin()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPortrait_SetPageMargin ( TPdfToolsImage2Pdf_ShrinkToPortrait * pShrinkToPortrait,
const TPdfToolsGeomUnits_Margin * pPageMargin )

The page margin Default value: 20mm (0.79in)

Parameters
[in,out]pShrinkToPortraitActs as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPortrait.
[in]pPageMarginSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes:

◆ PdfToolsImage2Pdf_ShrinkToPortrait_SetPageSize()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsImage2Pdf_ShrinkToPortrait_SetPageSize ( TPdfToolsImage2Pdf_ShrinkToPortrait * pShrinkToPortrait,
const TPdfToolsGeomUnits_Size * pPageSize )

The page size.

All output pages are created as that size and in portrait mode.

Default value: "A4" (210mm 297mm)

Parameters
[in,out]pShrinkToPortraitActs as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPortrait.
[in]pPageSizeSet value.
Returns
TRUE if the operation is successful; FALSE if there is an error.
Note
An error occurred when FALSE is returned. The specific error code can be retrieved by calling PdfTools_GetLastError. The error message can be obtained by calling PdfTools_GetLastErrorMessage. Possible error codes: