PdfTools_PdfToolsPdf2Image.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_AnnotationOptions PDFTOOLS_CALL	PdfToolsPdf2Image_ContentOptions_GetAnnotations (TPdfToolsPdf2Image_ContentOptions *pContentOptions)
	The render strategy for annotations.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_ContentOptions_SetAnnotations (TPdfToolsPdf2Image_ContentOptions *pContentOptions, TPdfToolsPdf2Image_AnnotationOptions iAnnotations)
	The render strategy for annotations.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_ImageOptionsType PDFTOOLS_CALL	PdfToolsPdf2Image_ImageOptions_GetType (TPdfToolsPdf2Image_ImageOptions *pImageOptions)
	Get actual derived type of base type TPdfToolsPdf2Image_ImageOptions.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_FaxVerticalResolution PDFTOOLS_CALL	PdfToolsPdf2Image_FaxImageOptions_GetVerticalResolution (TPdfToolsPdf2Image_FaxImageOptions *pFaxImageOptions)
	The vertical image resolution.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_FaxImageOptions_SetVerticalResolution (TPdfToolsPdf2Image_FaxImageOptions *pFaxImageOptions, TPdfToolsPdf2Image_FaxVerticalResolution iVerticalResolution)
	The vertical image resolution.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_TiffBitonalCompressionType PDFTOOLS_CALL	PdfToolsPdf2Image_FaxImageOptions_GetCompression (TPdfToolsPdf2Image_FaxImageOptions *pFaxImageOptions)
	The Fax compression algorithm.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_FaxImageOptions_SetCompression (TPdfToolsPdf2Image_FaxImageOptions *pFaxImageOptions, TPdfToolsPdf2Image_TiffBitonalCompressionType iCompression)
	The Fax compression algorithm.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_TiffJpegImageOptions *PDFTOOLS_CALL	PdfToolsPdf2Image_TiffJpegImageOptions_New (void)
PDFTOOLS_EXPORT int PDFTOOLS_CALL	PdfToolsPdf2Image_TiffJpegImageOptions_GetJpegQuality (TPdfToolsPdf2Image_TiffJpegImageOptions *pTiffJpegImageOptions)
	The JPEG quality factor.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_TiffJpegImageOptions_SetJpegQuality (TPdfToolsPdf2Image_TiffJpegImageOptions *pTiffJpegImageOptions, int iJpegQuality)
	The JPEG quality factor.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_TiffJpegImageOptions_GetColorSpace (TPdfToolsPdf2Image_TiffJpegImageOptions *pTiffJpegImageOptions, TPdfToolsPdf2Image_JpegColorSpace *pColorSpace)
	The color space of the output image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_TiffJpegImageOptions_SetColorSpace (TPdfToolsPdf2Image_TiffJpegImageOptions *pTiffJpegImageOptions, const TPdfToolsPdf2Image_JpegColorSpace *pColorSpace)
	The color space of the output image.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_TiffLzwImageOptions *PDFTOOLS_CALL	PdfToolsPdf2Image_TiffLzwImageOptions_New (void)
PDFTOOLS_EXPORT TPdfToolsPdf2Image_BackgroundType PDFTOOLS_CALL	PdfToolsPdf2Image_TiffLzwImageOptions_GetBackground (TPdfToolsPdf2Image_TiffLzwImageOptions *pTiffLzwImageOptions)
	Combine a background with the image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_TiffLzwImageOptions_SetBackground (TPdfToolsPdf2Image_TiffLzwImageOptions *pTiffLzwImageOptions, TPdfToolsPdf2Image_BackgroundType iBackground)
	Combine a background with the image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_TiffLzwImageOptions_GetColorSpace (TPdfToolsPdf2Image_TiffLzwImageOptions *pTiffLzwImageOptions, TPdfToolsPdf2Image_ColorSpace *pColorSpace)
	The color space of the output image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_TiffLzwImageOptions_SetColorSpace (TPdfToolsPdf2Image_TiffLzwImageOptions *pTiffLzwImageOptions, const TPdfToolsPdf2Image_ColorSpace *pColorSpace)
	The color space of the output image.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_TiffFlateImageOptions *PDFTOOLS_CALL	PdfToolsPdf2Image_TiffFlateImageOptions_New (void)
PDFTOOLS_EXPORT TPdfToolsPdf2Image_BackgroundType PDFTOOLS_CALL	PdfToolsPdf2Image_TiffFlateImageOptions_GetBackground (TPdfToolsPdf2Image_TiffFlateImageOptions *pTiffFlateImageOptions)
	Combine a background with the image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_TiffFlateImageOptions_SetBackground (TPdfToolsPdf2Image_TiffFlateImageOptions *pTiffFlateImageOptions, TPdfToolsPdf2Image_BackgroundType iBackground)
	Combine a background with the image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_TiffFlateImageOptions_GetColorSpace (TPdfToolsPdf2Image_TiffFlateImageOptions *pTiffFlateImageOptions, TPdfToolsPdf2Image_ColorSpace *pColorSpace)
	The color space of the output image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_TiffFlateImageOptions_SetColorSpace (TPdfToolsPdf2Image_TiffFlateImageOptions *pTiffFlateImageOptions, const TPdfToolsPdf2Image_ColorSpace *pColorSpace)
	The color space of the output image.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_PngImageOptions *PDFTOOLS_CALL	PdfToolsPdf2Image_PngImageOptions_New (void)
PDFTOOLS_EXPORT TPdfToolsPdf2Image_BackgroundType PDFTOOLS_CALL	PdfToolsPdf2Image_PngImageOptions_GetBackground (TPdfToolsPdf2Image_PngImageOptions *pPngImageOptions)
	Combine a background with the image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_PngImageOptions_SetBackground (TPdfToolsPdf2Image_PngImageOptions *pPngImageOptions, TPdfToolsPdf2Image_BackgroundType iBackground)
	Combine a background with the image.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_PngColorSpace PDFTOOLS_CALL	PdfToolsPdf2Image_PngImageOptions_GetColorSpace (TPdfToolsPdf2Image_PngImageOptions *pPngImageOptions)
	The color space of the output image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_PngImageOptions_SetColorSpace (TPdfToolsPdf2Image_PngImageOptions *pPngImageOptions, TPdfToolsPdf2Image_PngColorSpace iColorSpace)
	The color space of the output image.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_JpegImageOptions *PDFTOOLS_CALL	PdfToolsPdf2Image_JpegImageOptions_New (void)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_JpegImageOptions_GetColorSpace (TPdfToolsPdf2Image_JpegImageOptions *pJpegImageOptions, TPdfToolsPdf2Image_JpegColorSpace *pColorSpace)
	The color space of the output image.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_JpegImageOptions_SetColorSpace (TPdfToolsPdf2Image_JpegImageOptions *pJpegImageOptions, const TPdfToolsPdf2Image_JpegColorSpace *pColorSpace)
	The color space of the output image.
PDFTOOLS_EXPORT int PDFTOOLS_CALL	PdfToolsPdf2Image_JpegImageOptions_GetJpegQuality (TPdfToolsPdf2Image_JpegImageOptions *pJpegImageOptions)
	The JPEG quality factor.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_JpegImageOptions_SetJpegQuality (TPdfToolsPdf2Image_JpegImageOptions *pJpegImageOptions, int iJpegQuality)
	The JPEG quality factor.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_ImageSectionMappingType PDFTOOLS_CALL	PdfToolsPdf2Image_ImageSectionMapping_GetType (TPdfToolsPdf2Image_ImageSectionMapping *pImageSectionMapping)
	Get actual derived type of base type TPdfToolsPdf2Image_ImageSectionMapping.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_RenderPageAtResolution *PDFTOOLS_CALL	PdfToolsPdf2Image_RenderPageAtResolution_New (const TPdfToolsGeomUnits_Resolution *pResolution)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_RenderPageAtResolution_GetResolution (TPdfToolsPdf2Image_RenderPageAtResolution *pRenderPageAtResolution, TPdfToolsGeomUnits_Resolution *pResolution)
	The resolution of the output image Valid values are 0.0, 10000.0 or in between.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_RenderPageAtResolution_SetResolution (TPdfToolsPdf2Image_RenderPageAtResolution *pRenderPageAtResolution, const TPdfToolsGeomUnits_Resolution *pResolution)
	The resolution of the output image Valid values are 0.0, 10000.0 or in between.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_RenderPageToMaxImageSize *PDFTOOLS_CALL	PdfToolsPdf2Image_RenderPageToMaxImageSize_New (const TPdfToolsGeomInt_Size *pSize)
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_RenderPageToMaxImageSize_GetSize (TPdfToolsPdf2Image_RenderPageToMaxImageSize *pRenderPageToMaxImageSize, TPdfToolsGeomInt_Size *pSize)
	The maximum size of the image in pixels.
PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL	PdfToolsPdf2Image_RenderPageToMaxImageSize_SetSize (TPdfToolsPdf2Image_RenderPageToMaxImageSize *pRenderPageToMaxImageSize, const TPdfToolsGeomInt_Size *pSize)
	The maximum size of the image in pixels.
PDFTOOLS_EXPORT TPdfToolsPdf2Image_Converter *PDFTOOLS_CALL	PdfToolsPdf2Image_Converter_New (void)
PDFTOOLS_EXPORT TPdfToolsImage_MultiPageDocument *PDFTOOLS_CALL	PdfToolsPdf2Image_Converter_ConvertDocument (TPdfToolsPdf2Image_Converter *pConverter, TPdfToolsPdf_Document *pInDoc, const TPdfToolsSys_StreamDescriptor *pOutStreamDesc, TPdfToolsPdf2ImageProfiles_Profile *pProfile)
	Convert all pages of a PDF document to a rasterized image.
PDFTOOLS_EXPORT TPdfToolsImage_Document *PDFTOOLS_CALL	PdfToolsPdf2Image_Converter_ConvertPage (TPdfToolsPdf2Image_Converter *pConverter, TPdfToolsPdf_Document *pInDoc, const TPdfToolsSys_StreamDescriptor *pOutStreamDesc, TPdfToolsPdf2ImageProfiles_Profile *pProfile, int iPageNumber)
	Convert a single page of a PDF document to a rasterized image.

Macro Definition Documentation

PDFTOOLS_CALL

#define PDFTOOLS_CALL

Function Documentation

PdfToolsPdf2Image_ContentOptions_GetAnnotations()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_AnnotationOptions PDFTOOLS_CALL PdfToolsPdf2Image_ContentOptions_GetAnnotations

(

TPdfToolsPdf2Image_ContentOptions *

pContentOptions

)

The render strategy for annotations.

Defines whether to render annotation popups. For details, see TPdfToolsPdf2Image_AnnotationOptions.

Default: ePdfToolsPdf2Image_AnnotationOptions_ShowAnnotations

Parameters

[in,out]

pContentOptions

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

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

PdfToolsPdf2Image_ContentOptions_SetAnnotations()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_ContentOptions_SetAnnotations	(	TPdfToolsPdf2Image_ContentOptions *	pContentOptions,
		TPdfToolsPdf2Image_AnnotationOptions	iAnnotations )

The render strategy for annotations.

Defines whether to render annotation popups. For details, see TPdfToolsPdf2Image_AnnotationOptions.

Default: ePdfToolsPdf2Image_AnnotationOptions_ShowAnnotations

Parameters

[in,out]	pContentOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_ContentOptions.
[in]	iAnnotations	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.

PdfToolsPdf2Image_Converter_ConvertDocument()

PDFTOOLS_EXPORT TPdfToolsImage_MultiPageDocument *PDFTOOLS_CALL PdfToolsPdf2Image_Converter_ConvertDocument	(	TPdfToolsPdf2Image_Converter *	pConverter,
		TPdfToolsPdf_Document *	pInDoc,
		const TPdfToolsSys_StreamDescriptor *	pOutStreamDesc,
		TPdfToolsPdf2ImageProfiles_Profile *	pProfile )

Convert all pages of a PDF document to a rasterized image.

Parameters

[in,out]	pConverter	Acts as a handle to the native object of type TPdfToolsPdf2Image_Converter.
[in,out]	pInDoc	The input PDF document
[in,out]	pOutStreamDesc	The stream to which the rasterized image is written.
[in,out]	pProfile	The profile defines how the PDF pages are rendered and what type of output image is used. Note that the profile's image options must support multi-page images (TIFF). For other profiles, the method PdfToolsPdf2Image_Converter_ConvertPage should be used. For details, see TPdfToolsPdf2ImageProfiles_Profile.

Returns

The output image document. The object can be used as 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 image failed.
• ePdfTools_Error_UnsupportedFeature The input PDF is a PDF collection (Portfolio) that has no cover pages.
• ePdfTools_Error_UnsupportedFeature The input PDF contains unrendered XFA form fields. See PdfToolsPdf_Document_GetXfa for more information on how to detect and handle XFA documents.
• ePdfTools_Error_Generic An unexpected failure occurred.
• ePdfTools_Error_IllegalArgument The pProfile does not support multi-page output.
• ePdfTools_Error_Processing The processing has failed.
• ePdfTools_Error_IllegalState Internal error has occured.

PdfToolsPdf2Image_Converter_ConvertPage()

PDFTOOLS_EXPORT TPdfToolsImage_Document *PDFTOOLS_CALL PdfToolsPdf2Image_Converter_ConvertPage	(	TPdfToolsPdf2Image_Converter *	pConverter,
		TPdfToolsPdf_Document *	pInDoc,
		const TPdfToolsSys_StreamDescriptor *	pOutStreamDesc,
		TPdfToolsPdf2ImageProfiles_Profile *	pProfile,
		int	iPageNumber )

Convert a single page of a PDF document to a rasterized image.

Parameters

[in,out]	pConverter	Acts as a handle to the native object of type TPdfToolsPdf2Image_Converter.
[in,out]	pInDoc	The input PDF document
[in,out]	pOutStreamDesc	The stream to which the rasterized image is written.
[in,out]	pProfile	The profile defines how the PDF page is rendered and what type of output image is used. For details, see TPdfToolsPdf2ImageProfiles_Profile.
[in]	iPageNumber	The PDF page number to be converted. The number must be in the range of 1 (first page) to PdfToolsPdf_Document_GetPageCount (last page).

Returns

The image object allowing to open and read the output image and treat it 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_IllegalArgument The iPageNumber is not in the allowed range.
• ePdfTools_Error_IO Writing to the output image failed.
• ePdfTools_Error_UnsupportedFeature The input PDF is a collection that has no cover pages.
• ePdfTools_Error_UnsupportedFeature The input PDF contains unrendered XFA form fields. See PdfToolsPdf_Document_GetXfa for more information on how to detect and handle XFA documents.
• ePdfTools_Error_Generic An unexpected failure occurred.
• ePdfTools_Error_Processing The processing has failed.

PdfToolsPdf2Image_Converter_New()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_Converter *PDFTOOLS_CALL PdfToolsPdf2Image_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.

PdfToolsPdf2Image_FaxImageOptions_GetCompression()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_TiffBitonalCompressionType PDFTOOLS_CALL PdfToolsPdf2Image_FaxImageOptions_GetCompression

(

TPdfToolsPdf2Image_FaxImageOptions *

pFaxImageOptions

)

The Fax compression algorithm.

This property allows a choice of which compression type to use. For details, see TPdfToolsPdf2Image_TiffBitonalCompressionType.

Default: ePdfToolsPdf2Image_TiffBitonalCompressionType_G3

Parameters

[in,out]

pFaxImageOptions

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

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

PdfToolsPdf2Image_FaxImageOptions_GetVerticalResolution()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_FaxVerticalResolution PDFTOOLS_CALL PdfToolsPdf2Image_FaxImageOptions_GetVerticalResolution

(

TPdfToolsPdf2Image_FaxImageOptions *

pFaxImageOptions

)

The vertical image resolution.

This property allows a choice of which vertical resolution to use. For details, see TPdfToolsPdf2Image_FaxVerticalResolution.

Note that the horizontal resolution is fixed at 204 DPI by the Fax standard.

Default: ePdfToolsPdf2Image_FaxVerticalResolution_Standard

Parameters

[in,out]

pFaxImageOptions

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

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

PdfToolsPdf2Image_FaxImageOptions_SetCompression()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_FaxImageOptions_SetCompression	(	TPdfToolsPdf2Image_FaxImageOptions *	pFaxImageOptions,
		TPdfToolsPdf2Image_TiffBitonalCompressionType	iCompression )

The Fax compression algorithm.

This property allows a choice of which compression type to use. For details, see TPdfToolsPdf2Image_TiffBitonalCompressionType.

Default: ePdfToolsPdf2Image_TiffBitonalCompressionType_G3

Parameters

[in,out]	pFaxImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_FaxImageOptions.
[in]	iCompression	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.

PdfToolsPdf2Image_FaxImageOptions_SetVerticalResolution()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_FaxImageOptions_SetVerticalResolution	(	TPdfToolsPdf2Image_FaxImageOptions *	pFaxImageOptions,
		TPdfToolsPdf2Image_FaxVerticalResolution	iVerticalResolution )

The vertical image resolution.

This property allows a choice of which vertical resolution to use. For details, see TPdfToolsPdf2Image_FaxVerticalResolution.

Note that the horizontal resolution is fixed at 204 DPI by the Fax standard.

Default: ePdfToolsPdf2Image_FaxVerticalResolution_Standard

Parameters

[in,out]	pFaxImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_FaxImageOptions.
[in]	iVerticalResolution	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.

PdfToolsPdf2Image_ImageOptions_GetType()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_ImageOptionsType PDFTOOLS_CALL PdfToolsPdf2Image_ImageOptions_GetType

(

TPdfToolsPdf2Image_ImageOptions *

pImageOptions

)

Get actual derived type of base type TPdfToolsPdf2Image_ImageOptions.

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

Parameters

[in,out]

pImageOptions

Acts as a handle to a native object.

Returns

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

PdfToolsPdf2Image_ImageSectionMapping_GetType()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_ImageSectionMappingType PDFTOOLS_CALL PdfToolsPdf2Image_ImageSectionMapping_GetType

(

TPdfToolsPdf2Image_ImageSectionMapping *

pImageSectionMapping

)

Get actual derived type of base type TPdfToolsPdf2Image_ImageSectionMapping.

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

Parameters

[in,out]

pImageSectionMapping

Acts as a handle to a native object.

Returns

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

PdfToolsPdf2Image_JpegImageOptions_GetColorSpace()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_JpegImageOptions_GetColorSpace	(	TPdfToolsPdf2Image_JpegImageOptions *	pJpegImageOptions,
		TPdfToolsPdf2Image_JpegColorSpace *	pColorSpace )

The color space of the output image.

Get or set the color space of the image. If NULL, the blending color space of the page is used.

Default: ePdfToolsPdf2Image_JpegColorSpace_Rgb

Parameters

[in,out]	pJpegImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_JpegImageOptions.
[out]	pColorSpace	Retrieved value.

Returns

FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when FALSE was returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. Get the error message with PdfTools_GetLastErrorMessage.

PdfToolsPdf2Image_JpegImageOptions_GetJpegQuality()

PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsPdf2Image_JpegImageOptions_GetJpegQuality

(

TPdfToolsPdf2Image_JpegImageOptions *

pJpegImageOptions

)

The JPEG quality factor.

Get or set the JPEG compression quality. Valid values are 1, or 100, or in between.

Default: 85

Parameters

[in,out]

pJpegImageOptions

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

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 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 value is smaller than 1 or greater than 100.

PdfToolsPdf2Image_JpegImageOptions_New()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_JpegImageOptions *PDFTOOLS_CALL PdfToolsPdf2Image_JpegImageOptions_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.

PdfToolsPdf2Image_JpegImageOptions_SetColorSpace()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_JpegImageOptions_SetColorSpace	(	TPdfToolsPdf2Image_JpegImageOptions *	pJpegImageOptions,
		const TPdfToolsPdf2Image_JpegColorSpace *	pColorSpace )

The color space of the output image.

Get or set the color space of the image. If NULL, the blending color space of the page is used.

Default: ePdfToolsPdf2Image_JpegColorSpace_Rgb

Parameters

[in,out]	pJpegImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_JpegImageOptions.
[in]	pColorSpace	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.

PdfToolsPdf2Image_JpegImageOptions_SetJpegQuality()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_JpegImageOptions_SetJpegQuality	(	TPdfToolsPdf2Image_JpegImageOptions *	pJpegImageOptions,
		int	iJpegQuality )

The JPEG quality factor.

Get or set the JPEG compression quality. Valid values are 1, or 100, or in between.

Default: 85

Parameters

[in,out]	pJpegImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_JpegImageOptions.
[in]	iJpegQuality	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 value is smaller than 1 or greater than 100.

PdfToolsPdf2Image_PngImageOptions_GetBackground()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_BackgroundType PDFTOOLS_CALL PdfToolsPdf2Image_PngImageOptions_GetBackground

(

TPdfToolsPdf2Image_PngImageOptions *

pPngImageOptions

)

Combine a background with the image.

This property allows a choice of which background to combine with the image.

Default: ePdfToolsPdf2Image_BackgroundType_White

Parameters

[in,out]

pPngImageOptions

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

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

PdfToolsPdf2Image_PngImageOptions_GetColorSpace()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_PngColorSpace PDFTOOLS_CALL PdfToolsPdf2Image_PngImageOptions_GetColorSpace

(

TPdfToolsPdf2Image_PngImageOptions *

pPngImageOptions

)

The color space of the output image.

Get or set the color space.

Default: ePdfToolsPdf2Image_PngColorSpace_Rgb

Parameters

[in,out]

pPngImageOptions

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

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

PdfToolsPdf2Image_PngImageOptions_New()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_PngImageOptions *PDFTOOLS_CALL PdfToolsPdf2Image_PngImageOptions_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.

PdfToolsPdf2Image_PngImageOptions_SetBackground()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_PngImageOptions_SetBackground	(	TPdfToolsPdf2Image_PngImageOptions *	pPngImageOptions,
		TPdfToolsPdf2Image_BackgroundType	iBackground )

Combine a background with the image.

This property allows a choice of which background to combine with the image.

Default: ePdfToolsPdf2Image_BackgroundType_White

Parameters

[in,out]	pPngImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_PngImageOptions.
[in]	iBackground	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.

PdfToolsPdf2Image_PngImageOptions_SetColorSpace()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_PngImageOptions_SetColorSpace	(	TPdfToolsPdf2Image_PngImageOptions *	pPngImageOptions,
		TPdfToolsPdf2Image_PngColorSpace	iColorSpace )

The color space of the output image.

Get or set the color space.

Default: ePdfToolsPdf2Image_PngColorSpace_Rgb

Parameters

[in,out]	pPngImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_PngImageOptions.
[in]	iColorSpace	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.

PdfToolsPdf2Image_RenderPageAtResolution_GetResolution()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_RenderPageAtResolution_GetResolution	(	TPdfToolsPdf2Image_RenderPageAtResolution *	pRenderPageAtResolution,
		TPdfToolsGeomUnits_Resolution *	pResolution )

The resolution of the output image Valid values are 0.0, 10000.0 or in between.

Parameters

[in,out]	pRenderPageAtResolution	Acts as a handle to the native object of type TPdfToolsPdf2Image_RenderPageAtResolution.
[out]	pResolution	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.

PdfToolsPdf2Image_RenderPageAtResolution_New()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_RenderPageAtResolution *PDFTOOLS_CALL PdfToolsPdf2Image_RenderPageAtResolution_New

(

const TPdfToolsGeomUnits_Resolution *

pResolution

)

Parameters

[in]

pResolution

The resolution of the output image.

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

• ePdfTools_Error_IllegalArgument The resolution is smaller than 0.0 or greater than 10000.0.

PdfToolsPdf2Image_RenderPageAtResolution_SetResolution()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_RenderPageAtResolution_SetResolution	(	TPdfToolsPdf2Image_RenderPageAtResolution *	pRenderPageAtResolution,
		const TPdfToolsGeomUnits_Resolution *	pResolution )

The resolution of the output image Valid values are 0.0, 10000.0 or in between.

Parameters

[in,out]	pRenderPageAtResolution	Acts as a handle to the native object of type TPdfToolsPdf2Image_RenderPageAtResolution.
[in]	pResolution	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.

PdfToolsPdf2Image_RenderPageToMaxImageSize_GetSize()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_RenderPageToMaxImageSize_GetSize	(	TPdfToolsPdf2Image_RenderPageToMaxImageSize *	pRenderPageToMaxImageSize,
		TPdfToolsGeomInt_Size *	pSize )

The maximum size of the image in pixels.

Set or get the image size.

The dimensions of size must be 1 or greater.

Parameters

[in,out]	pRenderPageToMaxImageSize	Acts as a handle to the native object of type TPdfToolsPdf2Image_RenderPageToMaxImageSize.
[out]	pSize	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 dimensions of size are smaller than 1.

PdfToolsPdf2Image_RenderPageToMaxImageSize_New()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_RenderPageToMaxImageSize *PDFTOOLS_CALL PdfToolsPdf2Image_RenderPageToMaxImageSize_New

(

const TPdfToolsGeomInt_Size *

pSize

)

Parameters

[in]

pSize

The maximum size of the image in pixels.

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

• ePdfTools_Error_IllegalArgument The dimensions of size are smaller than 1.

PdfToolsPdf2Image_RenderPageToMaxImageSize_SetSize()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_RenderPageToMaxImageSize_SetSize	(	TPdfToolsPdf2Image_RenderPageToMaxImageSize *	pRenderPageToMaxImageSize,
		const TPdfToolsGeomInt_Size *	pSize )

The maximum size of the image in pixels.

Set or get the image size.

The dimensions of size must be 1 or greater.

Parameters

[in,out]	pRenderPageToMaxImageSize	Acts as a handle to the native object of type TPdfToolsPdf2Image_RenderPageToMaxImageSize.
[in]	pSize	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 dimensions of size are smaller than 1.

PdfToolsPdf2Image_TiffFlateImageOptions_GetBackground()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_BackgroundType PDFTOOLS_CALL PdfToolsPdf2Image_TiffFlateImageOptions_GetBackground

(

TPdfToolsPdf2Image_TiffFlateImageOptions *

pTiffFlateImageOptions

)

Combine a background with the image.

This property allows a choice of which background to combine with the image.

Default: ePdfToolsPdf2Image_BackgroundType_White

Parameters

[in,out]

pTiffFlateImageOptions

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

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

PdfToolsPdf2Image_TiffFlateImageOptions_GetColorSpace()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffFlateImageOptions_GetColorSpace	(	TPdfToolsPdf2Image_TiffFlateImageOptions *	pTiffFlateImageOptions,
		TPdfToolsPdf2Image_ColorSpace *	pColorSpace )

The color space of the output image.

If NULL, the blending color space of the page is used.

Default: ePdfToolsPdf2Image_ColorSpace_Rgb

Parameters

[in,out]	pTiffFlateImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_TiffFlateImageOptions.
[out]	pColorSpace	Retrieved value.

Returns

FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when FALSE was returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. Get the error message with PdfTools_GetLastErrorMessage.

PdfToolsPdf2Image_TiffFlateImageOptions_New()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_TiffFlateImageOptions *PDFTOOLS_CALL PdfToolsPdf2Image_TiffFlateImageOptions_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.

PdfToolsPdf2Image_TiffFlateImageOptions_SetBackground()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffFlateImageOptions_SetBackground	(	TPdfToolsPdf2Image_TiffFlateImageOptions *	pTiffFlateImageOptions,
		TPdfToolsPdf2Image_BackgroundType	iBackground )

Combine a background with the image.

This property allows a choice of which background to combine with the image.

Default: ePdfToolsPdf2Image_BackgroundType_White

Parameters

[in,out]	pTiffFlateImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_TiffFlateImageOptions.
[in]	iBackground	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.

PdfToolsPdf2Image_TiffFlateImageOptions_SetColorSpace()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffFlateImageOptions_SetColorSpace	(	TPdfToolsPdf2Image_TiffFlateImageOptions *	pTiffFlateImageOptions,
		const TPdfToolsPdf2Image_ColorSpace *	pColorSpace )

The color space of the output image.

If NULL, the blending color space of the page is used.

Default: ePdfToolsPdf2Image_ColorSpace_Rgb

Parameters

[in,out]	pTiffFlateImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_TiffFlateImageOptions.
[in]	pColorSpace	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.

PdfToolsPdf2Image_TiffJpegImageOptions_GetColorSpace()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffJpegImageOptions_GetColorSpace	(	TPdfToolsPdf2Image_TiffJpegImageOptions *	pTiffJpegImageOptions,
		TPdfToolsPdf2Image_JpegColorSpace *	pColorSpace )

The color space of the output image.

Get or set the color space. If null, the blending color space of the page is used.

Default: ePdfToolsPdf2Image_JpegColorSpace_Rgb

Parameters

[in,out]	pTiffJpegImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_TiffJpegImageOptions.
[out]	pColorSpace	Retrieved value.

Returns

FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when FALSE was returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. Get the error message with PdfTools_GetLastErrorMessage.

PdfToolsPdf2Image_TiffJpegImageOptions_GetJpegQuality()

PDFTOOLS_EXPORT int PDFTOOLS_CALL PdfToolsPdf2Image_TiffJpegImageOptions_GetJpegQuality

(

TPdfToolsPdf2Image_TiffJpegImageOptions *

pTiffJpegImageOptions

)

The JPEG quality factor.

Get or set the JPEG compression quality. Valid values are 1, or 100, or in between.

Default: 85

Parameters

[in,out]

pTiffJpegImageOptions

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

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 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 value is smaller than 1 or greater than 100.

PdfToolsPdf2Image_TiffJpegImageOptions_New()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_TiffJpegImageOptions *PDFTOOLS_CALL PdfToolsPdf2Image_TiffJpegImageOptions_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.

PdfToolsPdf2Image_TiffJpegImageOptions_SetColorSpace()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffJpegImageOptions_SetColorSpace	(	TPdfToolsPdf2Image_TiffJpegImageOptions *	pTiffJpegImageOptions,
		const TPdfToolsPdf2Image_JpegColorSpace *	pColorSpace )

The color space of the output image.

Get or set the color space. If null, the blending color space of the page is used.

Default: ePdfToolsPdf2Image_JpegColorSpace_Rgb

Parameters

[in,out]	pTiffJpegImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_TiffJpegImageOptions.
[in]	pColorSpace	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.

PdfToolsPdf2Image_TiffJpegImageOptions_SetJpegQuality()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffJpegImageOptions_SetJpegQuality	(	TPdfToolsPdf2Image_TiffJpegImageOptions *	pTiffJpegImageOptions,
		int	iJpegQuality )

The JPEG quality factor.

Get or set the JPEG compression quality. Valid values are 1, or 100, or in between.

Default: 85

Parameters

[in,out]	pTiffJpegImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_TiffJpegImageOptions.
[in]	iJpegQuality	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 value is smaller than 1 or greater than 100.

PdfToolsPdf2Image_TiffLzwImageOptions_GetBackground()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_BackgroundType PDFTOOLS_CALL PdfToolsPdf2Image_TiffLzwImageOptions_GetBackground

(

TPdfToolsPdf2Image_TiffLzwImageOptions *

pTiffLzwImageOptions

)

Combine a background with the image.

This property allows a choice of which background to combine with the image.

Default: ePdfToolsPdf2Image_BackgroundType_White

Parameters

[in,out]

pTiffLzwImageOptions

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

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling PdfTools_GetLastError. Get the error message with PdfTools_GetLastErrorMessage.

PdfToolsPdf2Image_TiffLzwImageOptions_GetColorSpace()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffLzwImageOptions_GetColorSpace	(	TPdfToolsPdf2Image_TiffLzwImageOptions *	pTiffLzwImageOptions,
		TPdfToolsPdf2Image_ColorSpace *	pColorSpace )

The color space of the output image.

Get or set the color space. If null, the blending color space of the page is used.

Default: ePdfToolsPdf2Image_ColorSpace_Rgb

Parameters

[in,out]	pTiffLzwImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_TiffLzwImageOptions.
[out]	pColorSpace	Retrieved value.

Returns

FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when FALSE was returned and the error code returned by PdfTools_GetLastError is different from ePdfTools_Error_Success. Get the error message with PdfTools_GetLastErrorMessage.

PdfToolsPdf2Image_TiffLzwImageOptions_New()

PDFTOOLS_EXPORT TPdfToolsPdf2Image_TiffLzwImageOptions *PDFTOOLS_CALL PdfToolsPdf2Image_TiffLzwImageOptions_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.

PdfToolsPdf2Image_TiffLzwImageOptions_SetBackground()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffLzwImageOptions_SetBackground	(	TPdfToolsPdf2Image_TiffLzwImageOptions *	pTiffLzwImageOptions,
		TPdfToolsPdf2Image_BackgroundType	iBackground )

Combine a background with the image.

This property allows a choice of which background to combine with the image.

Default: ePdfToolsPdf2Image_BackgroundType_White

Parameters

[in,out]	pTiffLzwImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_TiffLzwImageOptions.
[in]	iBackground	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.

PdfToolsPdf2Image_TiffLzwImageOptions_SetColorSpace()

PDFTOOLS_EXPORT BOOL PDFTOOLS_CALL PdfToolsPdf2Image_TiffLzwImageOptions_SetColorSpace	(	TPdfToolsPdf2Image_TiffLzwImageOptions *	pTiffLzwImageOptions,
		const TPdfToolsPdf2Image_ColorSpace *	pColorSpace )

The color space of the output image.

Get or set the color space. If null, the blending color space of the page is used.

Default: ePdfToolsPdf2Image_ColorSpace_Rgb

Parameters

[in,out]	pTiffLzwImageOptions	Acts as a handle to the native object of type TPdfToolsPdf2Image_TiffLzwImageOptions.
[in]	pColorSpace	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.