GetCacheUrl Method

Summary

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

Syntax

C++

Java

public Uri GetCacheUrl( 
   string key, 
   string regionName 
)

Public Function GetCacheUrl( 
   ByVal key As String, 
   ByVal regionName As String 
) As System.Uri

public:  
   System::Uri^ GetCacheUrl( 
      String^ key, 
      String^ regionName 
   )

public String getCacheUrl(String key, String regionName)

Parameters

key

Unique item identifier.

regionName

Optional region (sub-directory) name.

Return Value

The URI to the file holding the data for the specified item.

Remarks

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

GetCacheUrl returns a URI to any item currently stored in the cache. CacheVirtualDirectory must be setup to use this method. Obtaining a URI to a cache item can be useful in a Web application if the client code is JavaScript for example.

LEADTOOLS Document Web Service 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