GetAnnotationForDoc method

This method is intended for use with Visual Basic.

Method

short GetAnnotationForDoc(

short Index,

BSTR * pText,

BSTR * puserId,

BSTR * pDateTime,

VARIANT * pPage,

VARIANT * pPublic,

VARIANT * pCanBeCopied )

Parameters

Index: Specifies the zero-based index of the annotation to be returned. It must be a number greater than or equal to zero and less than the value returned by GetNumDocAnnotations.
pText: Points to a BSTR to receive the text of the annotation.
pUserId: Points to a BSTR to receive the user ID for the annotation.
pDateTime: Points to a BSTR to receive the date and time for the annotation.
pPage: Points to a variable to receive the document page number for the annotation. On return, this variable is set to type VT_I4.
pPublic: Points to a variable to receive a Boolean flag indicating whether the annotation is public or private. On return, this variable is set to type VT_I2.
pCanBeCopied: Points to a variable to receive a Boolean flag indicating whether the annotation can be copied to another server. On return, this variable is set to type VT_I2.

Description

The annotation is retrieved.

Return Value

Refer to return codes.

See Also:

GetNumDocAnnotation and GetDocAnnotation

  Dim rc, j As Integer
  Dim num_notes, page, ispublic, canbecopied As Variant
  Dim text As String
  Dim userid As String
  Dim datetime As String

  rc = ArsOle.GetNumDocAnnotations( num_notes )
  if rc <> ARS_OLE_RC_SUCCESS Then
      MsgBox "ERROR"
      End
  End If

  For j = 0 To num_notes -1
      rc = ArsOle.GetAnnotationForDoc( j,            _
                                       text,         _
                                       userid,       _
                                       datetime,     _
                                       page,         _
                                       ispublic,     _
                                       canbecopied )
      if rc <> ARS_OLE_RC_SUCCESS Then
          MsgBox "ERROR"
          End
      End If
  Next j