DataFormWebPart.DfwpCacheRead Method

Reads an item from the cache, based on a key.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
Protected Overridable Function DfwpCacheRead ( _
    storage As Storage, _
    key As String, _
    forceSharedAppCache As Boolean _
) As Object
'Usage
Dim storage As Storage
Dim key As String
Dim forceSharedAppCache As Boolean
Dim returnValue As Object

returnValue = Me.DfwpCacheRead(storage, _
    key, forceSharedAppCache)

protected virtual Object DfwpCacheRead(
    Storage storage,
    string key,
    bool forceSharedAppCache
)

Parameters

• storage
  Type: Microsoft.SharePoint.WebPartPages.Storage

  An enumeration that specifies how the property will be stored.

• key
  Type: System.String

  The identifier for the cache item to retrieve.

• forceSharedAppCache
  Type: System.Boolean

  true to causing the caching code to not generate a key scoped to the current page or Web Part state; otherwise, false.

Return Value

Type: System.Object
The identifier for the cache item to retrieve.

Remarks

This method computes a per-user key when non-shared storage is specified. The forceSharedAppCache parameter allows calling applications to cache items such as linked XSLs across pages.

Certain types of requests cannot use the Web Part cache.

See Also

Reference

DataFormWebPart Class

DataFormWebPart Members

Microsoft.SharePoint.WebPartPages Namespace