CheckInDocumentsToServer Method

Description

This method checks the documents you specify in to the server.

Syntax

Visual Basic
Public Function CheckInDocumentsToServer( _ ByVal NumberOfDocumentsToCheckInToServer As Long, _ ByVal ListOfDocumentsToCheckInFromServer As Variant, _ Optional ByVal FailIfDocumentsOpenInSolidEdge As Variant _ ) As Long

Visual Basic

Public Function CheckInDocumentsToServer( _
   ByVal NumberOfDocumentsToCheckInToServer As Long, _
   ByVal ListOfDocumentsToCheckInFromServer As Variant, _
   Optional ByVal FailIfDocumentsOpenInSolidEdge As Variant _
) As Long

Parameters

NumberOfDocumentsToCheckInToServer: Specifies the number of documents to check in.
ListOfDocumentsToCheckInFromServer: Specifies the documents to check in. This a list of URL file references on the Sharepoint server.
FailIfDocumentsOpenInSolidEdge: Determines whether the check-in fails if any of the documents in ListOfDocumentsToCheckInFromServer are open in Solid Edge. (This flag is unused. The documents will not be checked in if they are open in Solid Edge while calling this method.)

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(1) 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"

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