KeyView 24.1

# VAPIMWP_DRAW_DRAWTOFILE

Draws a page of a document to a graphic file (thumbnail). This is a parameter of the `VAPIM_DRAW` message.

## Syntax

    #include <kvvapi.h>
    SendMessage(hWndVAPI,VAPIM_DRAW, VAPIMWP_DRAW_DRAWTOFILE,
               (LPARAM) (TPVAPIDrawFileInfo*) pDrawInfo );

## Arguments

Argument | Description
--- | ---
`hWndVAPI` | The handle of the VAPI window.
`pDrawInfo` | A pointer to a TPVAPIDrawFileInfo structure that contains information used for drawing a page to a file. To draw pages in any order, set the `bWait` parameter in the TPVAPIOpenDocumentInfo structure to `FALSE`.

## Returns

`SendMessage()` returns:

- `VAPI_RETURN_SUCCESS` if the call succeeds.

- `VAPI_RETURN_NOT_INITIALIZED` if the drawing routines have not been initialized.

- `VAPI_RETURN_NO_PAGE` if the requested page does not exist, or is being displayed before all previous pages have been displayed.

- `VAPI_RETURN_NOT_AVAILABLE` if the document does not support this feature (for example, ZIP files, video, audio).

- `VAPI_RETURN_ERROR` if an error has occurred.

## Discussion

- Before you send this message, initialize VAPI by sending the VAPIMWP_DRAW_INIT message, and then open the document by sending the VAPIMWP_INIT_OPEN_DOCUMENT message.

- Page numbers start at 0. For example, set `uPageNumbers` 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.

  To draw pages in any order, set the `bWait` parameter in the TPVAPIOpenDocumentInfo structure to `FALSE`.

Copyright 2016-2023 Open Text
Version 24.1 | Last updated December 2023

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.1

Topic Title: VAPIMWP_DRAW_DRAWTOFILE