Remove<T> Method (SmartCache)

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function Remove(Of T)( _
   ByVal key As System.String, _
   Optional ByVal regionName As System.String _
) As T

'Usage
 
Dim instance As SmartCache
Dim key As System.String
Dim regionName As System.String
Dim value As T
 
value = instance.Remove(Of T)(key, regionName)

public T Remove<T>( 
   System.string key,
   System.string regionName
)

public: T* Remove<T>( 
   System.string* key,
   System.string* regionName
)

public:
T^ Removegeneric<typename T>
( 
   System.String^ key,
   System.String^ regionName
)

Parameters

key: The key of the item
regionName: The name of the region

Type Parameters

T

C#

//Create a Primary Memory Cache with a backing File Cache
string directory = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "KellermanSoftware", "NetCachingLibrary", "Tests");
SmartConfig config = new SmartConfig(new MemoryCacheProvider(), new FileCacheProvider(directory));
            
//Specify UserName and LicenseKey for Licensed Mode
//config.UserName = "my user name";
//config.LicenseKey = "my license key";
            
//Instantiate the cache
SmartCache cache = new SmartCache(config);
            
//Build parameters for the report
int month = DateTime.Now.Month;
int year = DateTime.Now.Year;
            
//Get the cache key based on the report parameters
string cacheKey = cache.BuildCacheKey("MonthlySalesReport", month, year);
            
//Get a long running report
List<ReportDetail> report = ReportLogic.MonthlySalesReport(month, year);
            
//Save to the cache
cache.Set< List<ReportDetail>>(cacheKey, report);
            
//Remove it from the cache
var result = cache.Remove<List<ReportDetail>>(cacheKey);
            
bool found = cache.Contains(cacheKey);
            
//This will be false
Console.WriteLine(found);

VB.NET

'Create a Primary Memory Cache with a backing File Cache
Dim directory As String = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "KellermanSoftware", "NetCachingLibrary", "Tests")
Dim config As New SmartConfig(New MemoryCacheProvider(), New FileCacheProvider(directory))
            
'Specify UserName and LicenseKey for Licensed Mode
'config.UserName = "my user name";
'config.LicenseKey = "my license key";
            
'Instantiate the cache
Dim cache As New SmartCache(config)
            
'Build parameters for the report
Dim month As Integer = Date.Now.Month
Dim year As Integer = Date.Now.Year
            
'Get the cache key based on the report parameters
Dim cacheKey As String = cache.BuildCacheKey("MonthlySalesReport", month, year)
            
'Get a long running report
Dim report As List(Of ReportDetail) = ReportLogic.MonthlySalesReport(month, year)
            
'Save to the cache
cache.Set(Of List(Of ReportDetail))(cacheKey, report)
            
'Remove it from the cache
Dim result = cache.Remove(Of List(Of ReportDetail))(cacheKey)
            
Dim found As Boolean = cache.Contains(cacheKey)
            
'This will be false
Console.WriteLine(found)

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

SmartCache Class
SmartCache Members