←Select platform

BeginAddExternalResource Method (FileCache)

Summary

Begins adding a new cache item.

Syntax

Java

C++

public override System.Uri BeginAddExternalResource( 
   string key, 
   string regionName, 
   bool readWrite 
)

Public Overrides Function BeginAddExternalResource( 
   ByVal key As String, 
   ByVal regionName As String, 
   ByVal readWrite As Boolean 
) As System.Uri

public:  
   virtual System::Uri^ BeginAddExternalResource( 
      String^ key, 
      String^ regionName, 
      bool readWrite 
   ) override

public URI beginAddExternalResource(String key, String regionName, boolean readWrite)

Parameters

key

Unique item identifier.

regionName

Optional region name.

readWrite

true if the read and write access to the URI is requested; otherwise, false if only read access is requested.

Return Value

Returns URI to the path holding the data for the item.

Remarks

Cache consumers should call this method only if DefaultCacheCapabilities.ExternalResources is supported by this cache (by checking the DefaultCacheCapabilities property.

The LEADTOOLS Documents classes uses this method to quickly add items. It speeds up access and updating the data if the value contain large amount of data such as an image file.

After this method returns, EndAddExternalResource<T> must be called to either commit this item into the cache or discard it.

Requirements

Target Platforms

See Also