BeginAdd Method

Summary

Begins adding a new cache item.

Syntax

C++/CLI

Java

public virtual string BeginAdd( 
   string key, 
   string regionName 
)

public:  
   virtual String^ BeginAdd( 
      String^ key, 
      String^ regionName 
   )

public String beginAdd(String key, String regionName)

Parameters

key

Unique item identifier.

regionName

Optional region (sub-directory) name.

Return Value

Returns the path to the physical file that will hold the data for the item on disk.

Remarks

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

LEADTOOLS Document 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, EndAdd must be called to either commit this item into the cache or discard it.

Requirements

Target Platforms

Reference

FileCache Class

FileCache Members

Leadtools.Caching Namespace

Download our FREE evaluation

Help Version 22.0.2023.5.14