File Content Extraction 25.1
Viewing SDK Programming Guide

# VAPIMWP_VIEW_CANPREVIEWPANE

Determines whether a file can be viewed in a preview pane. The message indicates `TRUE` only when container formats such as ZIP, TAR, or PST files are viewed.

To determine whether the preview pane is being used, use the `VAPIMWP_VIEW_GETPREVIEWPANE` message.

To specify if the preview pane should be used, use the `VAPIMWP_VIEW_SETPREVIEWPANE` message.

This is a parameter of the `VAPIM_VIEW` message.

## Syntax

    #include <kvvapi.h>
    SendMessage(hWndVAPI, VAPIM_VIEW, VAPIMWP_VIEW_CANPREVIEWPANE,
               (LPARAM) (BOOL*) lpbCanPreviewPane );

## Arguments

Argument | Description
--- | ---
`hWndVAPI` | The handle of the VAPI window.
`lpbCanPreviewPane` | A pointer to a flag that returns `TRUE` or `FALSE`, depending on whether the document can be viewed in a preview pane. Only container files use the preview pane.

## Returns

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

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_CANPREVIEWPANE