KeyView 24.4
KeyView Viewing SDK Programming Guide

# TPVAPIDrawFileInfo

This structure defines the parameters used by the VAPIMWP_DRAW_DRAWTOFILE message to draw a page to a graphic file.

## Syntax

    #include <kvvapi.h>
    typedef struct tag_TPVAPIDrawFileInfo
    {
        LPSTR      lpszTarget;
        LPSTR      lpszGfxOutput;
        UINT       uPageNumber;
        int        iWidth;
        int        iHeight;
        int        iPicXRes;
        int        iPicYRes;
        int        iCompressionQuality;
    }
    TPVAPIDrawFileInfo;

## Members

`lpszTarget` | The target path and file name to which the page is written. The file should use one of the following four extensions: `.bmp` `.jpg` `.png` `.tif`
`lpszGfxOutput` | The output graphics format. The following options are available: `KVGFX_OUTPUT_BMP` `KVGFX_OUTPUT_JPEG` `KVGFX_OUTPUT_PNG` `KVGFX_OUTPUT_TIFF` (uncompressed TIFFs)
`uPageNumber` | The number of the page to be rasterized into a thumbnail. Page numbers start at 0. For example, set `uPageNumber` to `0` to draw page 1, and to `1` to draw page 2. For word processing documents, pages must be drawn sequentially. For example, to draw page 3, you must first draw pages 0 and 1. If the `bWait` member of `TPVAPIOpenDocumentInfo` is set to `FALSE`, you can draw any page. See TPVAPIOpenDocumentInfo. If the page you request is beyond the last page, a `VAPI_RETURN_NO_PAGE` error is returned.
`iWidth` | The maximum picture width (in TWIPS).
`iHeight` | The maximum picture height (in TWIPS).
`iPicXRes` | The desired horizontal resolution (`0` for default).
`iPicYRes` | The desired vertical resolution (`0` for default).
`iCompressionQuality` | This parameter controls the output quality of graphics that support compression quality (for example, JPEG). The valid range is `0` to `100`. A value of `0` means default quality (85 compression); `1` is the lowest quality (highest compression and therefore the smallest file size); `100` is the highest quality (no compression and therefore the largest file size). The default is `0`.

Copyright 2016-2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL KeyView 24.4

Topic Title: TPVAPIDrawFileInfo