DownloadAnnotations(DownloadDocumentOptions) Method

Summary

Downloads the annotations of the specified document.

Syntax

C++

public static long DownloadAnnotations( 
   DownloadDocumentOptions options 
)

Public Shared Function DownloadAnnotations( 
   ByVal options As DownloadDocumentOptions 
) As Long

public:  
   static Int64 DownloadAnnotations( 
      DownloadDocumentOptions^ options 
   )

Parameters

options

Options containing the document properties and download options to use. This value must not be null.

Return Value

The total number of bytes read into DownloadDocumentOptions.Data or DownloadDocumentOptions.Stream. This can be less than the number of bytes requested by DownloadDocumentOptions.Length, if that many bytes are not currently available; or zero (0) if the end of the data has been reached.

Remarks

Similar to UploadDocument, data can be downloaded in chunks or all at once. Refer to Uploading Using the Document Library for detailed information on how to use these methods and the various options used.

To determine if a document is in the cache and to get its information, call GetDocumentCacheInfo.

To download the data of a document, call DownloadDocument.

Example

For an example, refer to DocumentFactory.DownloadDocument.

Requirements

Target Platforms