DataCache.GetObjectsByTag Method

Article
08/26/2011

Gets an enumerable list of all cached objects in the specified region that have the specified tag.

Namespace: Microsoft.ApplicationServer.Caching
Assembly: Microsoft.ApplicationServer.Caching.Client (in microsoft.applicationserver.caching.client.dll)

Usage

'Usage
Dim instance As DataCache
Dim tag As DataCacheTag
Dim region As String
Dim returnValue As IEnumerable(Of KeyValuePair(Of String, Object))

returnValue = instance.GetObjectsByTag(tag, region)

Syntax

'Declaration
Public Function GetObjectsByTag ( _
    tag As DataCacheTag, _
    region As String _
) As IEnumerable(Of KeyValuePair(Of String, Object))

public IEnumerable<KeyValuePair<string,Object>> GetObjectsByTag (
    DataCacheTag tag,
    string region
)

public:
IEnumerable<KeyValuePair<String^, Object^>>^ GetObjectsByTag (
    DataCacheTag^ tag, 
    String^ region
)

public IEnumerable<KeyValuePair<String,Object>> GetObjectsByTag (
    DataCacheTag tag, 
    String region
)

public function GetObjectsByTag (
    tag : DataCacheTag, 
    region : String
) : IEnumerable<KeyValuePair<String,Object>>

Parameters

tag
The tag for which to search.

region
The name of the region to search. Tags are not supported outside regions. Therefore, a region name is required.

Return Value

An enumerable list of all cached objects in the specified region that have the specified tag. Null is returned if no objects in the specified region have the tag specified.

Remarks

Tags are supported only for objects stored in regions.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Visual Studio 2010 and later, .NET Framework 4

Target Platforms

Windows 7; Windows Server 2008 R2; Windows Server 2008 Service Pack 2; Windows Vista Service Pack 2