DeleteDocumentsFromCache Method

Description

This method deletes the documents you specify from the cache.

Syntax

Visual Basic
Public Function DeleteDocumentsFromCache( _ ByRef NumberOFDocumentsToBeDeletedFromCache As Long, _ ByVal ListOfDocumentsToBeDeletedFromCache As Variant, _ ByRef NumberOfNotDeletedDocuments As Long, _ ByRef ListOfNotDeletedDocuments As Variant _ ) As Long

Visual Basic

Public Function DeleteDocumentsFromCache( _
   ByRef NumberOFDocumentsToBeDeletedFromCache As Long, _
   ByVal ListOfDocumentsToBeDeletedFromCache As Variant, _
   ByRef NumberOfNotDeletedDocuments As Long, _
   ByRef ListOfNotDeletedDocuments As Variant _
) As Long

Parameters

NumberOFDocumentsToBeDeletedFromCache: Specifies the number of documents to delete from the cache.
ListOfDocumentsToBeDeletedFromCache: Specifies the documents to delete from the cache. This is the path of the local cache on the user's machine.
NumberOfNotDeletedDocuments: Specifies the number of documents that remain in the cache.
ListOfNotDeletedDocuments: Specifies the documents that remain in the cache. Gives the list of documents not deleted from the input list.

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 NumberOfNotDeletedDocuments As Long
        Dim aListOfNotDeletedDocuments As Object

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

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

            aFilesToDelete(0) = "D:\InsightCache\Insight\solidvm\Engineering\PreReleased\PreReleasedDocLib\Summit.par"

            objInsight.DeleteDocumentsFromCache(aFilesToDelete.Length, aFilesToDelete, NumberOfNotDeletedDocuments, aListOfNotDeletedDocuments)
        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