ExportDocumentsFromServer Method

Description

This method exports the specified documents from the server to an unmanaged location you specify.

Syntax

Visual Basic
Public Function ExportDocumentsFromServer( _ ByVal NumberOfDocumentsToExport As Long, _ ByVal ListOfDocumentsToExport As Variant, _ ByVal ExportToLocation As String, _ ByVal SetDocToReadOnly As Boolean, _ ByVal OverWriteOption As OverWriteFilesOption _ ) As Long

Visual Basic

Public Function ExportDocumentsFromServer( _
   ByVal NumberOfDocumentsToExport As Long, _
   ByVal ListOfDocumentsToExport As Variant, _
   ByVal ExportToLocation As String, _
   ByVal SetDocToReadOnly As Boolean, _
   ByVal OverWriteOption As OverWriteFilesOption _
) As Long

Parameters

NumberOfDocumentsToExport

Specifies the number of documents to export.

ListOfDocumentsToExport

Specifies URL paths of the documents to export.

ExportToLocation

Specifies where to export the specified documents.

SetDocToReadOnly

Specifies whether to make the specified documents read-only.

OverWriteOption

Value	Description
NoToAll
YesToAll

Member of the OverWriteFilesOption constant set that specifies whether or not to overwrite documents in the unmanaged export location.

Example

Example (VB.NET)

Imports RevisionManager
Imports System.Runtime.InteropServices

Module Example

    Sub Main()
        Dim objApplication As RevisionManager.Application = Nothing
        Dim objInsight As RevisionManager.Insight = Nothing
        Dim aListOfDocumentsToExport(1) As Object
        Dim ExportToLocation As String
        Dim SetDocToReadOnly As Boolean
        Dim OverWriteOption As Boolean

        Try
            ' Start Revision Manager.
            objApplication = New RevisionManager.Application

            ' Get reference to Insight object.
            objInsight = objApplication.Insight

            aListOfDocumentsToExport(0) = "http://solidvm/Engineering/PreReleased/PreReleasedDocLib/Summit.par"
            aListOfDocumentsToExport(1) = "http://solidvm/Engineering/PreReleased/PreReleasedDocLib/CDPlayer/CDPlayer.asm"
            ExportToLocation = "D:\Temp\ExportFromInsight"
            SetDocToReadOnly = True
            OverWriteOption = RevisionManager.OverWriteFilesOption.NoToAll

            objInsight.ExportDocumentsFromServer(aListOfDocumentsToExport.Length, aListOfDocumentsToExport, ExportToLocation, SetDocToReadOnly, OverWriteOption)
        Catch ex As Exception
            ' Write any errors to console.
            Console.WriteLine(ex.Message)
        Finally
            ' Release COM Objects.
            If Not (objInsight Is Nothing) Then
                Marshal.ReleaseComObject(objInsight)
                objInsight = Nothing
            End If

            If Not (objApplication Is Nothing) Then
                objApplication.Quit()
                Marshal.ReleaseComObject(objApplication)
                objApplication = Nothing
            End If
        End Try
    End Sub

End Module