#include "PdfTools_Types.h"
#include "PdfTools_PdfToolsSys.h"

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]	pAuto	Acts as a handle to the native object of type TPdfToolsImage2Pdf_Auto.
[out]	pDefaultPageMargin	Retrieved value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument has negative margin values.

◆ 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]	pAuto	Acts as a handle to the native object of type TPdfToolsImage2Pdf_Auto.
[out]	pMaxPageSize	Retrieved value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument is smaller than "3pt 3pt" or larger than "14400pt 14400pt".

◆ 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 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with 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]	pAuto	Acts as a handle to the native object of type TPdfToolsImage2Pdf_Auto.
[in]	pDefaultPageMargin	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument has negative margin values.

◆ 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]	pAuto	Acts as a handle to the native object of type TPdfToolsImage2Pdf_Auto.
[in]	pMaxPageSize	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument is smaller than "3pt 3pt" or larger than "14400pt 14400pt".

◆ PdfToolsImage2Pdf_Converter_Convert()

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.

Parameters

[in,out]	pConverter	Acts as a handle to the native object of type TPdfToolsImage2Pdf_Converter.
[in,out]	pImage	The input image document containing one or more pages.
[in,out]	pOutStreamDesc	The stream to which the PDF is written.
[in,out]	pProfile	The profile defines the properties of the output document and how the images are placed onto the pages. For details, see TPdfToolsImage2PdfProfiles_Profile.
[in,out]	pOutOptions	The 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 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_License The license is invalid.
ePdfTools_Error_IO Writing to the output PDF failed.
ePdfTools_Error_Corrupt The input image document is corrupt and cannot be read.
ePdfTools_Error_Generic An unexpected failure occurred.
ePdfTools_Error_Processing The conversion failed.
ePdfTools_Error_IllegalArgument The pProfile specifies invalid options.
ePdfTools_Error_IllegalArgument The pOutOptions specifies document encryption and the pProfile PDF/A conformance, which is not allowed.

◆ 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]	pConverter	Acts as a handle to the native object of type TPdfToolsImage2Pdf_Converter.
[in,out]	pImages	The input image document list, each image containing one or more pages.
[in,out]	pOutStreamDesc	The stream to which the PDF is written.
[in,out]	pProfile	The profile defines the properties of the output document and how the images are placed onto the pages. For details, see TPdfToolsImage2PdfProfiles_Profile.
[in,out]	pOutOptions	The 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 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_License The license is invalid.
ePdfTools_Error_IO Writing to the output PDF failed.
ePdfTools_Error_Corrupt An input image document is corrupt and cannot be read.
ePdfTools_Error_Generic An unexpected failure occurred.
ePdfTools_Error_Processing The conversion failed.
ePdfTools_Error_IllegalArgument The pProfile specifies invalid options.
ePdfTools_Error_IllegalArgument The pOutOptions specifies document encryption and the pProfile PDF/A conformance, which is not allowed.

◆ 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 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with 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] pImageMapping Acts 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 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with 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] pImageOptions Acts 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 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with 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]	pImageOptions	Acts as a handle to the native object of type TPdfToolsImage2Pdf_ImageOptions.
[in,out]	pMapping	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note: An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with 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]	pShrinkToFit	Acts as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToFit.
[out]	pPageMargin	Retrieved value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument has negative margin values.

◆ 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]	pShrinkToFit	Acts as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToFit.
[out]	pPageSize	Retrieved value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument is smaller than "3pt 3pt" or larger than "14400pt 14400pt".

◆ 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 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with 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]	pShrinkToFit	Acts as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToFit.
[in]	pPageMargin	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument has negative margin values.

◆ 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]	pShrinkToFit	Acts as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToFit.
[in]	pPageSize	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument is smaller than "3pt 3pt" or larger than "14400pt 14400pt".

◆ 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]	pShrinkToPage	Acts as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPage.
[out]	pPageMargin	Retrieved value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument has negative margin values.

◆ 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]	pShrinkToPage	Acts as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPage.
[out]	pPageSize	Retrieved value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument is smaller than "3pt 3pt" or larger than "14400pt 14400pt".

◆ 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 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with 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]	pShrinkToPage	Acts as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPage.
[in]	pPageMargin	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument has negative margin values.

◆ 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]	pShrinkToPage	Acts as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPage.
[in]	pPageSize	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument is smaller than "3pt 3pt" or larger than "14400pt 14400pt".

◆ 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]	pShrinkToPortrait	Acts as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPortrait.
[out]	pPageMargin	Retrieved value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument has negative margin values.

◆ 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]	pShrinkToPortrait	Acts as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPortrait.
[out]	pPageSize	Retrieved value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument is smaller than "3pt 3pt" or larger than "14400pt 14400pt".

◆ 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 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with 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]	pShrinkToPortrait	Acts as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPortrait.
[in]	pPageMargin	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument has negative margin values.

◆ 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]	pShrinkToPortrait	Acts as a handle to the native object of type TPdfToolsImage2Pdf_ShrinkToPortrait.
[in]	pPageSize	Set value.

Returns: TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage. Possible error codes:

ePdfTools_Error_IllegalArgument The argument is smaller than "3pt 3pt" or larger than "14400pt 14400pt".

Macros

Functions

Macro Definition Documentation

◆ PDFTOOLS_CALL

Function Documentation

◆ PdfToolsImage2Pdf_Auto_GetDefaultPageMargin()

◆ PdfToolsImage2Pdf_Auto_GetMaxPageSize()

◆ PdfToolsImage2Pdf_Auto_New()

◆ PdfToolsImage2Pdf_Auto_SetDefaultPageMargin()

◆ PdfToolsImage2Pdf_Auto_SetMaxPageSize()

◆ PdfToolsImage2Pdf_Converter_Convert()

◆ PdfToolsImage2Pdf_Converter_ConvertMultiple()

◆ PdfToolsImage2Pdf_Converter_New()

◆ PdfToolsImage2Pdf_ImageMapping_GetType()

◆ PdfToolsImage2Pdf_ImageOptions_GetMapping()

◆ PdfToolsImage2Pdf_ImageOptions_SetMapping()

◆ PdfToolsImage2Pdf_ShrinkToFit_GetPageMargin()

◆ PdfToolsImage2Pdf_ShrinkToFit_GetPageSize()

◆ PdfToolsImage2Pdf_ShrinkToFit_New()

◆ PdfToolsImage2Pdf_ShrinkToFit_SetPageMargin()

◆ PdfToolsImage2Pdf_ShrinkToFit_SetPageSize()

◆ PdfToolsImage2Pdf_ShrinkToPage_GetPageMargin()

◆ PdfToolsImage2Pdf_ShrinkToPage_GetPageSize()

◆ PdfToolsImage2Pdf_ShrinkToPage_New()

◆ PdfToolsImage2Pdf_ShrinkToPage_SetPageMargin()

◆ PdfToolsImage2Pdf_ShrinkToPage_SetPageSize()

◆ PdfToolsImage2Pdf_ShrinkToPortrait_GetPageMargin()

◆ PdfToolsImage2Pdf_ShrinkToPortrait_GetPageSize()

◆ PdfToolsImage2Pdf_ShrinkToPortrait_New()

◆ PdfToolsImage2Pdf_ShrinkToPortrait_SetPageMargin()

◆ PdfToolsImage2Pdf_ShrinkToPortrait_SetPageSize()