DeleteFromCache(string) Method

Summary

Deletes a document from the global cache.

Syntax

C++

Java

public static bool DeleteFromCache( 
   string documentId 
)

Public Shared Function DeleteFromCache( 
   ByVal documentId As String 
) As Boolean

public:  
   static bool DeleteFromCache( 
      String^ documentId 
   )

public static boolean deleteFromCache(String documentId)

Parameters

documentId

The document identifier. This value cannot be null.

Return Value

true if the document was purged successfully from the cache; otherwise, false if the document was not found in the cache.

Remarks

Note: This method will be deprecated in the next version of LEADTOOLS. Use DeleteFromCache(LoadFromCacheOptions) instead.

This method is the equivalent of calling DeleteFromCache(DocumentFactory.Cache, documentId) and therefore will throw an exception if Cache was not set up.

Use this method to delete a document previously stored in the cache with SaveToCache.

This method may return false if the document has expired and was purged from the cache in another way.

This method works by calling LoadFromCache first. If this succeeds, it will set the value of LEADDocument.AutoDeleteFromCache to true and dispose the document. The document will then remove itself from the cache as usual.

Requirements

Target Platforms