DataCache.BulkGet Method (IEnumerable<String>)

Gets all of the objects associated with the specified keys across all system regions. This method does not search user-defined regions.

Namespace:   Microsoft.ApplicationServer.Caching
Assembly:  Microsoft.ApplicationServer.Caching.Client (in Microsoft.ApplicationServer.Caching.Client.dll)

Syntax

public IEnumerable<KeyValuePair<string, object>> BulkGet(
    IEnumerable<string> keys
)

public:
IEnumerable<KeyValuePair<String^, Object^>>^ BulkGet(
    IEnumerable<String^>^ keys
)

member BulkGet : 
        keys:IEnumerable<string> -> IEnumerable<KeyValuePair<string, Object>>

Public Function BulkGet (
    keys As IEnumerable(Of String)
) As IEnumerable(Of KeyValuePair(Of String, Object))

Parameters

• keys
  Type: System.Collections.Generic.IEnumerable<String>

  List of keys for the objects to retrieve, cannot be null.

Return Value

Type: System.Collections.Generic.IEnumerable<KeyValuePair<String, Object>>

Returns an IEnumerable<T> object with a list of key and value pairs.

Remarks

Parameter validation behavior:

• If a key is not present in the region, the object returned by the enumerator for the key will be null. For example, the key/value pair returned would be <key,null>.

Performance considerations - BulkGet improves performance when used with small objects, for example, when retrieving many objects of 1 - 5KB or less in size. When using BulkGet to retrieve large objects, for example objects larger than 64 KB, BulkGet will not significantly improve performance and in fact may adversely impact performance. This reduced performance can occur because large bulk get responses are split into multiple single object responses to avoid large object heap usage.

See Also

BulkGet Overload
DataCache Class
Microsoft.ApplicationServer.Caching Namespace

Return to top