VAPIMWP_VIEW_GETGRIDLINES

Gets the gridlines state of the document. This is a parameter of the VAPIM_VIEW message.

Syntax

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

Arguments

Argument Description
hWndVAPI The handle of the VAPI window.
lpbGridlines A pointer to a flag that returns TRUE or FALSE, depending on whether the document has gridlines set.

Returns

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

Discussion

Use this message to set the state of a Toggle Gridlines menu item or toolbar button.