VAPIMWP_VIEW_GETPREVIEWPANE

Determines whether the preview pane is being used. The preview pane is only used to display a subfile in a container file. When it is enabled, the viewing area is divided into two panes: one pane displays the contents of the container file, the other displays the contents of the selected subfile. For more information, see VAPIMWP_VIEW_SETPREVIEWPANE . This is a parameter of the VAPIM_VIEW message.

Syntax

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

Arguments

Argument Description
hWndVAPI The handle of the VAPI window.
lpbPreviewPane A pointer to a flag that returns TRUE or FALSE, depending on whether the preview pane was returned. Only container files use the preview pane.

Returns

  • SendMessage() returns TRUE if the call succeeds, in which case lpbPreviewPane 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 lpbPreviewPane is undefined.