PdfTools_PdfToolsPdf2ImageProfiles.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 TPdfToolsPdf2Image_ContentOptions *PDFTOOLS_CALL	PdfToolsPdf2ImageProfiles_Profile_GetContentOptions (TPdfToolsPdf2ImageProfiles_Profile *pProfile)
	The parameters how to render PDF content elements.
PDFTOOLS_EXPORT TPdfToolsPdf2ImageProfiles_ProfileType PDFTOOLS_CALL	PdfToolsPdf2ImageProfiles_Profile_GetType (TPdfToolsPdf2ImageProfiles_Profile *pProfile)
	Get actual derived type of base type TPdfToolsPdf2ImageProfiles_Profile.
PDFTOOLS_EXPORT TPdfToolsPdf2ImageProfiles_Fax *PDFTOOLS_CALL	PdfToolsPdf2ImageProfiles_Fax_New (void)
PDFTOOLS_EXPORT TPdfToolsPdf2Image_FaxImageOptions *PDFTOOLS_CALL	PdfToolsPdf2ImageProfiles_Fax_GetImageOptions (TPdfToolsPdf2ImageProfiles_Fax *pFax)
	The settings for the output image.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_RenderPageAsFax *PDFTOOLS_CALL	PdfToolsPdf2ImageProfiles_Fax_GetImageSectionMapping (TPdfToolsPdf2ImageProfiles_Fax *pFax)
	The image section mapping This property specifies how a PDF page is placed onto the target image.
PDFTOOLS_EXPORT TPdfToolsPdf2ImageProfiles_Archive *PDFTOOLS_CALL	PdfToolsPdf2ImageProfiles_Archive_New (void)
PDFTOOLS_EXPORT TPdfToolsPdf2Image_ImageOptions *PDFTOOLS_CALL	PdfToolsPdf2ImageProfiles_Archive_GetImageOptions (TPdfToolsPdf2ImageProfiles_Archive *pArchive)
	The settings for the output TIFF.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2ImageProfiles_Archive_SetImageOptions (TPdfToolsPdf2ImageProfiles_Archive *pArchive, TPdfToolsPdf2Image_ImageOptions *pImageOptions)
	The settings for the output TIFF.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_RenderPageAtResolution *PDFTOOLS_CALL	PdfToolsPdf2ImageProfiles_Archive_GetImageSectionMapping (TPdfToolsPdf2ImageProfiles_Archive *pArchive)
	The image section mapping.
PDFTOOLS_EXPORT TPdfToolsPdf2ImageProfiles_Viewing *PDFTOOLS_CALL	PdfToolsPdf2ImageProfiles_Viewing_New (void)
PDFTOOLS_EXPORT TPdfToolsPdf2Image_ImageOptions *PDFTOOLS_CALL	PdfToolsPdf2ImageProfiles_Viewing_GetImageOptions (TPdfToolsPdf2ImageProfiles_Viewing *pViewing)
	The settings for the output image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2ImageProfiles_Viewing_SetImageOptions (TPdfToolsPdf2ImageProfiles_Viewing *pViewing, TPdfToolsPdf2Image_ImageOptions *pImageOptions)
	The settings for the output image.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_ImageSectionMapping *PDFTOOLS_CALL	PdfToolsPdf2ImageProfiles_Viewing_GetImageSectionMapping (TPdfToolsPdf2ImageProfiles_Viewing *pViewing)
	The image section mapping.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2ImageProfiles_Viewing_SetImageSectionMapping (TPdfToolsPdf2ImageProfiles_Viewing *pViewing, TPdfToolsPdf2Image_ImageSectionMapping *pImageSectionMapping)
	The image section mapping.

Macro Definition Documentation

PDFTOOLS_CALL

#define PDFTOOLS_CALL

Function Documentation

PdfToolsPdf2ImageProfiles_Archive_GetImageOptions()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_ImageOptions *PDFTOOLS_CALL PdfToolsPdf2ImageProfiles_Archive_GetImageOptions

(

TPdfToolsPdf2ImageProfiles_Archive *

pArchive

)

The settings for the output TIFF.

Defines the compression algorithm of the TIFF output image.

Supported types are:

• TPdfToolsPdf2Image_TiffJpegImageOptions
• TPdfToolsPdf2Image_TiffLzwImageOptions
• TPdfToolsPdf2Image_TiffFlateImageOptions

Default: TPdfToolsPdf2Image_TiffLzwImageOptions

Parameters

[in,out]

pArchive

Acts as a handle to the native object of type TPdfToolsPdf2ImageProfiles_Archive.

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. Possible error codes:

• ePdfTools_Error_IllegalArgument The given object has the wrong type.

PdfToolsPdf2ImageProfiles_Archive_GetImageSectionMapping()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_RenderPageAtResolution *PDFTOOLS_CALL PdfToolsPdf2ImageProfiles_Archive_GetImageSectionMapping

(

TPdfToolsPdf2ImageProfiles_Archive *

pArchive

)

The image section mapping.

This property defines the resolution of the output images.

Default: 300 DPI.

Parameters

[in,out]

pArchive

Acts as a handle to the native object of type TPdfToolsPdf2ImageProfiles_Archive.

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.

PdfToolsPdf2ImageProfiles_Archive_New()

PDFTOOLS_EXPORT TPdfToolsPdf2ImageProfiles_Archive *PDFTOOLS_CALL PdfToolsPdf2ImageProfiles_Archive_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.

PdfToolsPdf2ImageProfiles_Archive_SetImageOptions()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2ImageProfiles_Archive_SetImageOptions	(	TPdfToolsPdf2ImageProfiles_Archive *	pArchive,
		TPdfToolsPdf2Image_ImageOptions *	pImageOptions )

The settings for the output TIFF.

Defines the compression algorithm of the TIFF output image.

Supported types are:

• TPdfToolsPdf2Image_TiffJpegImageOptions
• TPdfToolsPdf2Image_TiffLzwImageOptions
• TPdfToolsPdf2Image_TiffFlateImageOptions

Default: TPdfToolsPdf2Image_TiffLzwImageOptions

Parameters

[in,out]	pArchive	Acts as a handle to the native object of type TPdfToolsPdf2ImageProfiles_Archive.
[in,out]	pImageOptions	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 given object has the wrong type.

PdfToolsPdf2ImageProfiles_Fax_GetImageOptions()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_FaxImageOptions *PDFTOOLS_CALL PdfToolsPdf2ImageProfiles_Fax_GetImageOptions

(

TPdfToolsPdf2ImageProfiles_Fax *

pFax

)

The settings for the output image.

Parameters

[in,out]

pFax

Acts as a handle to the native object of type TPdfToolsPdf2ImageProfiles_Fax.

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.

PdfToolsPdf2ImageProfiles_Fax_GetImageSectionMapping()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_RenderPageAsFax *PDFTOOLS_CALL PdfToolsPdf2ImageProfiles_Fax_GetImageSectionMapping

(

TPdfToolsPdf2ImageProfiles_Fax *

pFax

)

The image section mapping This property specifies how a PDF page is placed onto the target image.

Parameters

[in,out]

pFax

Acts as a handle to the native object of type TPdfToolsPdf2ImageProfiles_Fax.

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.

PdfToolsPdf2ImageProfiles_Fax_New()

PDFTOOLS_EXPORT TPdfToolsPdf2ImageProfiles_Fax *PDFTOOLS_CALL PdfToolsPdf2ImageProfiles_Fax_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.

PdfToolsPdf2ImageProfiles_Profile_GetContentOptions()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_ContentOptions *PDFTOOLS_CALL PdfToolsPdf2ImageProfiles_Profile_GetContentOptions

(

TPdfToolsPdf2ImageProfiles_Profile *

pProfile

)

The parameters how to render PDF content elements.

Parameters

[in,out]

pProfile

Acts as a handle to the native object of type TPdfToolsPdf2ImageProfiles_Profile.

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.

PdfToolsPdf2ImageProfiles_Profile_GetType()

PDFTOOLS_EXPORT TPdfToolsPdf2ImageProfiles_ProfileType PDFTOOLS_CALL PdfToolsPdf2ImageProfiles_Profile_GetType

(

TPdfToolsPdf2ImageProfiles_Profile *

pProfile

)

Get actual derived type of base type TPdfToolsPdf2ImageProfiles_Profile.

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

Parameters

[in,out]

pProfile

Acts as a handle to a native object.

Returns

The item of the enumeration TPdfToolsPdf2ImageProfiles_ProfileType 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.

PdfToolsPdf2ImageProfiles_Viewing_GetImageOptions()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_ImageOptions *PDFTOOLS_CALL PdfToolsPdf2ImageProfiles_Viewing_GetImageOptions

(

TPdfToolsPdf2ImageProfiles_Viewing *

pViewing

)

The settings for the output image.

Supported types are:

• TPdfToolsPdf2Image_PngImageOptions to create PNG images
• TPdfToolsPdf2Image_JpegImageOptions to create JPEG images

Default: TPdfToolsPdf2Image_PngImageOptions

Parameters

[in,out]

pViewing

Acts as a handle to the native object of type TPdfToolsPdf2ImageProfiles_Viewing.

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. Possible error codes:

• ePdfTools_Error_IllegalArgument The given object has the wrong type.

PdfToolsPdf2ImageProfiles_Viewing_GetImageSectionMapping()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_ImageSectionMapping *PDFTOOLS_CALL PdfToolsPdf2ImageProfiles_Viewing_GetImageSectionMapping

(

TPdfToolsPdf2ImageProfiles_Viewing *

pViewing

)

The image section mapping.

This property specifies how a PDF page is placed onto the target image.

Supported types are:

• TPdfToolsPdf2Image_RenderPageAtResolution to define the resolution of the output images.
• TPdfToolsPdf2Image_RenderPageToMaxImageSize to define the maximum image size of the output images.

Default: TPdfToolsPdf2Image_RenderPageAtResolution with 150 DPI.

Parameters

[in,out]

pViewing

Acts as a handle to the native object of type TPdfToolsPdf2ImageProfiles_Viewing.

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. Possible error codes:

• ePdfTools_Error_IllegalArgument The given object has the wrong type.

PdfToolsPdf2ImageProfiles_Viewing_New()

PDFTOOLS_EXPORT TPdfToolsPdf2ImageProfiles_Viewing *PDFTOOLS_CALL PdfToolsPdf2ImageProfiles_Viewing_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.

PdfToolsPdf2ImageProfiles_Viewing_SetImageOptions()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2ImageProfiles_Viewing_SetImageOptions	(	TPdfToolsPdf2ImageProfiles_Viewing *	pViewing,
		TPdfToolsPdf2Image_ImageOptions *	pImageOptions )

The settings for the output image.

Supported types are:

• TPdfToolsPdf2Image_PngImageOptions to create PNG images
• TPdfToolsPdf2Image_JpegImageOptions to create JPEG images

Default: TPdfToolsPdf2Image_PngImageOptions

Parameters

[in,out]	pViewing	Acts as a handle to the native object of type TPdfToolsPdf2ImageProfiles_Viewing.
[in,out]	pImageOptions	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 given object has the wrong type.

PdfToolsPdf2ImageProfiles_Viewing_SetImageSectionMapping()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2ImageProfiles_Viewing_SetImageSectionMapping	(	TPdfToolsPdf2ImageProfiles_Viewing *	pViewing,
		TPdfToolsPdf2Image_ImageSectionMapping *	pImageSectionMapping )

The image section mapping.

This property specifies how a PDF page is placed onto the target image.

Supported types are:

• TPdfToolsPdf2Image_RenderPageAtResolution to define the resolution of the output images.
• TPdfToolsPdf2Image_RenderPageToMaxImageSize to define the maximum image size of the output images.

Default: TPdfToolsPdf2Image_RenderPageAtResolution with 150 DPI.

Parameters

[in,out]	pViewing	Acts as a handle to the native object of type TPdfToolsPdf2ImageProfiles_Viewing.
[in,out]	pImageSectionMapping	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 given object has the wrong type.