DataCache.GetObjectsByAnyTag Method

Article
08/26/2011

Gets an enumerable list of all cached objects in the specified region that have any of the same tags in common.

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

Usage

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

returnValue = instance.GetObjectsByAnyTag(tags, region)

Syntax

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

public IEnumerable<KeyValuePair<string,Object>> GetObjectsByAnyTag (
    IEnumerable<DataCacheTag> tags,
    string region
)

public:
IEnumerable<KeyValuePair<String^, Object^>>^ GetObjectsByAnyTag (
    IEnumerable<DataCacheTag^>^ tags, 
    String^ region
)

public IEnumerable<KeyValuePair<String,Object>> GetObjectsByAnyTag (
    IEnumerable<DataCacheTag> tags, 
    String region
)

public function GetObjectsByAnyTag (
    tags : IEnumerable<DataCacheTag>, 
    region : String
) : IEnumerable<KeyValuePair<String,Object>>

Parameters

tags
A list of tags 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 any of the same tags in common. Null is returned if no objects in the specified region have any of the tags specified.

Remarks

Cached objects returned in the enumerator may only have some of the tags listed in the tags array parameter. If you want an enumerator to list only objects that have all the tags listed in the tags array parameter, use the GetObjectsByAllTags method.

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