VAPIMWP_OPTIONS_GETOPTIONS_EX

Description

Gets the document options. Document options control display elements such as window size, zoom settings, margin size, scaling, and revision tracking information. Options are defined for each file type category (for example, spreadsheets, multimedia, and word processing). This is a parameter of the VAPIM_OPTIONS message. See Change Document Options.

Syntax

#include <kvvapi.h>
#include <kwoption.h>
SendMessage(hWndVAPI, VAPIM_OPTIONS,
            VAPIMWP_OPTIONS_GETOPTIONS_EX,
           (LPARAM) (ALL_OPTIONS_EX*) lpAllOptions );

Arguments

Argument

Description

hWndVAPI

The handle of the VAPI window.

lpAllOptions

A pointer to an ALL_OPTIONS_EX structure that returns the document options.

Returns

SendMessage() returns TRUE if the call succeeds, in which case lpAllOptions returns the options.

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

Discussion

Use this message to get the options for the document. Only the options for the current document type are returned, not those for all document types.


_HP_HTML5_bannerTitle.htm