AnnotateDoc method

The AnnotateDoc method is used to create annotations.

Method

short AnnotateDoc(

long Index,

char * pText,

long page,

boolean Public,

boolean CanBeCopied )

Parameters

Index: Specifies the zero-based index of a document within the document list of the active folder. If this value is less than zero, the annotation is associated with the open document.
pText: Points to a null-terminated character string containing the text of the annotation. If the text contains more than 32,700 characters, it is truncated.
page: Specifies the page number to be associated with the annotation.
Public: Indicates whether the annotation is public.
CanBeCopied: Indicates whether the annotation can be copied to other servers.

Description

An annotation is created in the database and associated with the specified document.

Return Value

Refer to return codes.

Also see

OpenDoc method

C/C + +

 CArsOle * pArsCtrl;
 short rc;

   .
   .

  rc = pArsCtrl->AnnotateDoc( 3, "This is the text.", 5, TRUE, FALSE );
  if ( rc != ARS_OLE_RC_SUCCESS )
    ERROR;

   .
   .

Visual Basic

Dim rc As Integer

 .
 .
 .

rc = ArsOle.AnnotateDoc(3, "This is the text.", 5, True, False)
If rc <> ARS_OLE_RC_SUCCESS Then
   MsgBox "ERROR"
   End
End If

 .
 .
 .