VAPIM_ANNOTATE

Adds and deletes annotations, and determines whether annotations exist.

Syntax

#include <kvvapi.h>
SendMessage(hWndVAPI,
            VAPIM_ANNOTATE,
           (WPARAM) wControl,
           (LPARAM) (TPVAPIAnnotation*) lpAnnotation );

Arguments

Argument Description
hWndVAPI The handle of the VAPI window.
wControl

KV_DEL_ANNOTATION (0) – delete annotation

KV_ADD_ANNOTATION (1) – add annotation

KV_ANNOTATION_EXISTS (2) – query annotation

lpAnnotation A pointer to a TPVAPIAnnotation structure that defines the annotation.

Returns

  • For KV_DEL_ANNOTATION, SendMessage() returns TRUE if successful; FALSE if the annotation did not exist.

  • For KV_ADD_ANNOTATION, SendMessage() returns 0 if successful; 1 if out of memory; 2 if the annotation could not be added because it would cause an overlap with an existing annotation; and 3 if the logical address was invalid.

  • For KV_ANNOTATION_EXISTS, SendMessage() returns TRUE if the annotation exists; FALSE otherwise.

Discussion

The size of the bitmap is not relevant.