PDF SDK Documentation

Comprehensive Guide for Developers: Features, Integration, and API Reference

Loading...
Searching...
No Matches
PDFConvertToImageParams Struct Reference

Contains conversion-related parameters such as the system output folder, desired image type, desired file name, a flag indicating conversion success status, a custom callback procedure along with it's buffer and an image quality parameter. More...

#include <pdfsdk/convert/pdf2image.h>

Public Attributes

const wchar_t * outputFolder
 
const wchar_t * extension
 
const wchar_t * filenamePrefix
 
bool * saveToOutputSuccess
 
PDFReplaceFileQuestionProc replaceFileQuestion
 
void * replaceFileQuestionData
 
int targetDpi
 

Detailed Description

Contains conversion-related parameters such as the system output folder, desired image type, desired file name, a flag indicating conversion success status, a custom callback procedure along with it's buffer and an image quality parameter.

Member Data Documentation

◆ extension

const wchar_t* PDFConvertToImageParams::extension

A pointer to the file extention of the image file in wide character string format (i.e. L".png")

◆ filenamePrefix

const wchar_t* PDFConvertToImageParams::filenamePrefix

A pointer to the new file name that will be created for each image in wide character string format (i.e. L"imageFromPdf" will result in 'imageFromPdf_Page1.png' after converting the first page from a PDF file, with '_Page#' appended to filenamePrefix - 'imageFromPdf_Page5.png' for page 5.

◆ outputFolder

const wchar_t* PDFConvertToImageParams::outputFolder

A pointer to the output folder to store the image files in wide character string format (i.e. L"path/to/folder";)

◆ replaceFileQuestion

PDFReplaceFileQuestionProc PDFConvertToImageParams::replaceFileQuestion

A custom callback procedure. It may be null.

◆ replaceFileQuestionData

void* PDFConvertToImageParams::replaceFileQuestionData

Buffer for the callback routine above. It may be null.

◆ saveToOutputSuccess

bool* PDFConvertToImageParams::saveToOutputSuccess

Will be set to 'true' if at least one page from a PDF document is converted into an image file. It may be null.

◆ targetDpi

int PDFConvertToImageParams::targetDpi

The image quality dots per inch (DPI) of the image file to create.


The documentation for this struct was generated from the following file: