CheckOutDocumentsFromServer Method

Description

This method checks the documents you specify out from the server.

Syntax

Visual Basic
Public Function CheckOutDocumentsFromServer( _ ByVal NumberOfDocumentsToCheckOutFromServer As Long, _ ByVal ListOfDocumentsToCheckOutFromServer As Variant _ ) As Long

Parameters

NumberOfDocumentsToCheckOutFromServer: Specifies the number of documents to check out from the server.
ListOfDocumentsToCheckOutFromServer: Specifies the documents to check out from the server.

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 aListOfDocumentsToCheckInToServer(2) As Object

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

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

            aListOfDocumentsToCheckInToServer(0) = "D:\InsightCache\Insight\solidvm\Engineering\PreReleased\PreReleasedDocLib\Summit.par"
            aListOfDocumentsToCheckInToServer(1) = "D:\InsightCache\Insight\solidvm\Engineering\PreReleased\PreReleasedDocLib\CDPLayer\CDPlayer.asm"

            objInsight.CheckOutDocumentsFromServer(aListOfDocumentsToCheckInToServer.Length, aListOfDocumentsToCheckInToServer)
        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