←Select platform

DeleteFromCache(ObjectCache,string) Method (DocumentFactory)

Summary

Deletes a document from the specified cache.

Syntax

Java

C++

public static bool DeleteFromCache( 
   ObjectCache cache, 
   string documentId 
)

Public Shared Function DeleteFromCache( 
   ByVal cache As ObjectCache, 
   ByVal documentId As String 
) As Boolean

public:  
   static bool DeleteFromCache( 
      ObjectCache^ cache, 
      String^ documentId 
   )

public static boolean deleteFromCache(ObjectCache cache, String documentId)

Parameters

cache

The cache object to use. This value cannot be null.

documentId

The document identifier. This value cannot be null.

Return Value

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

Remarks

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

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

This method works by calling LoadFromCache first. If this succeeds, it will set the value of Document.AutoDeleteFromCache to true and disposes the document. The document will then removes it self from the cache as usual.

Requirements

Target Platforms

See Also

Reference

DocumentFactory Class

DocumentFactory Members

Leadtools.Documents Namespace