←Select platform

DeleteFromCache(string) Method

Summary

Deletes a document from the global cache.

Syntax

Java

C++

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 successfuly from the cache; otherwise, false if the document was not found in the cache.

Remarks

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

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

Reference

DocumentFactory Class

DocumentFactory Members

Leadtools.Documents Namespace

Document Toolkit and Caching

Help Version 19.0.2017.10.27