DeleteDocumentsFromServer Method

Description

This method deletes the documents you specify from the server.

Syntax

Visual Basic
Public Function DeleteDocumentsFromServer( _ ByVal NumberOfDocumentsToBeDeleted As Long, _ ByVal ListOfDocumentsToBeDeleted As Variant, _ ByRef NumberOfSuccessfullyDeletedDocuments As Long, _ ByRef SuccessfullyDeletedDocuments As Variant _ ) As Long

Visual Basic

Public Function DeleteDocumentsFromServer( _
   ByVal NumberOfDocumentsToBeDeleted As Long, _
   ByVal ListOfDocumentsToBeDeleted As Variant, _
   ByRef NumberOfSuccessfullyDeletedDocuments As Long, _
   ByRef SuccessfullyDeletedDocuments As Variant _
) As Long

Parameters

NumberOfDocumentsToBeDeleted: Specifies the number of documents to delete from the server.
ListOfDocumentsToBeDeleted: Specifies the documents to delete from the server. This is the URL path of the documents on the Sharepoint server.
NumberOfSuccessfullyDeletedDocuments: Specifies the number of documents successfully deleted from the server.
SuccessfullyDeletedDocuments: Specifies the documents successfully deleted 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 aFilesToDelete(0) As String
        Dim NumberOfSuccessfullyDeletedDocuments As Long
        Dim aSuccessfullyDeletedDocuments As Object

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

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

            aFilesToDelete(0) = "http://solidvm/Engineering/PreReleased/PreReleasedDocLib/Summit.par"

            objInsight.DeleteDocumentsFromServer(aFilesToDelete.Length, aFilesToDelete, NumberOfSuccessfullyDeletedDocuments, aSuccessfullyDeletedDocuments)
        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