GetCacheFilePath Method

Summary

Path to the physical file holding the data for the specified item.

Syntax

C++

Java

public string GetCacheFilePath( 
   string key, 
   string regionName 
)

Public Function GetCacheFilePath( 
   ByVal key As String, 
   ByVal regionName As String 
) As String

public:  
   String^ GetCacheFilePath( 
      String^ key, 
      String^ regionName 
   )

public String getCacheFilePath(String key, String regionName)

Parameters

key

Unique item identifier.

regionName

Optional region (sub-directory) name.

Return Value

The physical file holding the data for the specified item.

Remarks

This method calls GetItemExternalResource and will be removed from the next version of LEADTOOLS.

GetCacheFilePath returns the physical path of any item currently stored in the cache. This gives the user the ability to read the data of the item directly or pass the file to another part of the system that may require a physical file on disk.

LEADTOOLS Document classes use this method to quickly access the data of an item from the disk file. It speeds up access and updating the data if the value contain large amount of data such as an image file.

Requirements

Target Platforms