DownloadDocumentFromServer Method

Description

This method downloads the document you specify from the server to the local cache.

Syntax

Visual Basic
Public Sub DownloadDocumentFromServer( _ ByVal DocumentToDownLoadFromServer As String, _ ByVal DocumentAccessMode As DocumentAccess, _ ByRef LocalPath As String, _ Optional ByVal GetLatestDocuments As Variant, _ Optional ByVal ProcessIndirectDocuments As Variant, _ Optional ByVal RevisionRuleOption As Variant, _ Optional ByVal StopFileOpenIfRevisionRuleNotApplicable As Variant _ )

Visual Basic

Public Sub DownloadDocumentFromServer( _
   ByVal DocumentToDownLoadFromServer As String, _
   ByVal DocumentAccessMode As DocumentAccess, _
   ByRef LocalPath As String, _
   Optional ByVal GetLatestDocuments As Variant, _
   Optional ByVal ProcessIndirectDocuments As Variant, _
   Optional ByVal RevisionRuleOption As Variant, _
   Optional ByVal StopFileOpenIfRevisionRuleNotApplicable As Variant _
)

Parameters

DocumentToDownLoadFromServer

Specifies the URL path of the document to download from the server.

DocumentAccessMode

Value	Description
igReadExclusive	Document has exclusive read access
igReadOnly	Document has read-only access
igReadWrite	Document has read-write access

Member of the DocumentAccess constant set that specifies the file access mode.

LocalPath

Specifies the path of the local cache on the user's machine where the specified document will be downloaded.

GetLatestDocuments

Specifies whether to get latest documents when you download the specified document. Specify TRUE to get the latest version of the document from the server. Specify FALSE to use the existing version of the document from the local cache.

ProcessIndirectDocuments

Specifies whether to process indirect documents (documents that the specified document links to, for example) when downloading the specified document. Specify TRUE or omit this parameter to get all of the indirect files linked to the document. Specify FALSE to omit indirect files.

RevisionRuleOption

Member of the RevisionRuleType constant set that specifies a revision rule for the operation.

StopFileOpenIfRevisionRuleNotApplicable

Specifies whether to stop the Open operation if the rule specified by RevisionRuleOption is not applicable. When set to true, the operation stops.