BuildCacheKey(String,Dictionary<String,Object>) Method

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

'Declaration
 
Public Overloads Function BuildCacheKey( _
   ByVal baseName As System.String, _
   ByVal parms As System.Collections.Generic.Dictionary(Of String,Object) _
) As System.String

'Usage
 
Dim instance As SmartCache
Dim baseName As System.String
Dim parms As System.Collections.Generic.Dictionary(Of String,Object)
Dim value As System.String
 
value = instance.BuildCacheKey(baseName, parms)

public System.string BuildCacheKey( 
   System.string baseName,
   System.Collections.Generic.Dictionary<string,object> parms
)

public: System.string* BuildCacheKey( 
   System.string* baseName,
   System.Collections.Generic.Dictionary<string*,Object*>* parms
)

public:
System.String^ BuildCacheKey( 
   System.String^ baseName,
   System.Collections.Generic.Dictionary<String^,Object^>^ parms
)

Parameters

baseName: Name of the base.
parms: The parameters.

Return Value

System.String.

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
Dictionary<string, object> parms = new Dictionary<string, object>()
{
    {"Month", month },
    {"Year", year }
};
string cacheKey = cache.BuildCacheKey("MonthlySalesReport", parms);
 
//Attempt to load the report from the cache
List<ReportDetail> report = cache.Get<List<ReportDetail>>(cacheKey);
 
//Not found in the cache
if (report == null)
{
    //Load the report from the database
    report = ReportLogic.MonthlySalesReport(month, year);
 
    //Save to the cache using the default expiration of 20 minutes for the memory cache and 24 hours for the file cache
    cache.Set<List<ReportDetail>>(cacheKey, report);
}

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 parms As New Dictionary(Of String, Object)() From {
    {"Month", month },
    {"Year", year }
}
Dim cacheKey As String = cache.BuildCacheKey("MonthlySalesReport", parms)
 
'Attempt to load the report from the cache
Dim report As List(Of ReportDetail) = cache.Get(Of List(Of ReportDetail))(cacheKey)
 
'Not found in the cache
If report Is Nothing Then
    'Load the report from the database
    report = ReportLogic.MonthlySalesReport(month, year)
 
    'Save to the cache using the default expiration of 20 minutes for the memory cache and 24 hours for the file cache
    cache.Set(Of List(Of ReportDetail))(cacheKey, report)
End If

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
Overload List