Assembly: Alachisoft.NCache.Web (in Alachisoft.NCache.Web.dll) Version: 4.1.0.0 (4.1.0.0)
Syntax
C# |
---|
public static Cache InitializeCache( string cacheId ) |
Visual Basic |
---|
Public Shared Function InitializeCache ( _ cacheId As String _ ) As Cache |
Visual C++ |
---|
public: static Cache^ InitializeCache( String^ cacheId ) |
Parameters
- cacheId
- Type: System..::..String
The identifier for the Cache item to initialize.
Remarks
As this overload does not take SecurityParams, internally it tries to load this information from "client.ncconf" file. For more details see NCache Help Collection.
Calling this method twice with the same cacheId increments the reference count of the cache. The number of InitializeCache(String) calls must be balanced by a corresponding same number of Dispose()()()() calls.
Multiple cache instances can be inititalized within the same application domain. If multiple cache instances are initialized, Cache refers to the first instance of the cache.
Note: When starting a Cache as outproc, this method attempts to start NCache service on the local machine if it is not already running. However it does not start the cache automatically.
Examples
public override void Init() { // A cache with id 'myCache' is already registered. try { Alachisoft.NCache.Web.Caching.Cache theCache = NCache.InitializeCache("myCache"); } catch(Exception e) { // Cache is not available. } }
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | cacheId is a null reference (Nothing in Visual Basic). |