File Content Extraction 25.1
Viewing SDK Programming Guide

# VAPIMWP_VIEW_GETASPECTRATIO

Gets the aspect ratio of a document. This is a parameter of the `VAPIM_VIEW` message.

## Syntax

    #include <kvvapi.h>
    SendMessage(hWndVAPI, VAPIM_VIEW, VAPIMWP_VIEW_GETASPECTRATIO,
               (LPARAM) (int*) lpnAspectRatio );

## Arguments

Argument | Description
--- | ---
`hWndVAPI` | The handle of the VAPI window.
`lpnAspectRatio` | A pointer to an integer that returns the aspect ratio: `0` - None `1` - Based on document `2` - Normal (use scanlines) `3` - Letter (times 2)

## Returns

- `SendMessage()` returns `TRUE` if the call succeeds, in which case `lpnAspectRatio` returns the aspect ratio.
- `SendMessage()` returns `FALSE` if the call fails (for example, if there are invalid arguments or if no document is open), in which case `lpnAspectRatio` is undefined.

## Discussion

Use this message to set the state of an Aspect Ratio menu item or toolbar button.

Copyright 2016-2024 Open Text
Version 25.1 | Last updated January 2025

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: File Content Extraction 25.1

Topic Title: VAPIMWP_VIEW_GETASPECTRATIO