DataCache.GetObjectsByTag Method

  • Article

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

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

Namespace: Microsoft.Data.Caching
Assembly: ClientLibrary (in clientlibrary.dll)

Syntax

'Declaration
Public Function GetObjectsByTag ( _
    tag As DataCacheTag, _
    region As String _
) As IEnumerable(Of KeyValuePair(Of String, Object))
'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)

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.

See Also

Reference

DataCache Class
DataCache Members
Microsoft.Data.Caching Namespace