GetDocumentCacheInfo(ObjectCache,Uri) Method

Summary

Retrieves information for a document in the cache using its URI.

Syntax

C++

public static DocumentCacheInfo GetDocumentCacheInfo( 
   ObjectCache cache, 
   Uri uri 
)

Public Shared Function GetDocumentCacheInfo( 
   ByVal cache As ObjectCache, 
   ByVal uri As Uri 
) As DocumentCacheInfo

public:  
   static DocumentCacheInfo^ GetDocumentCacheInfo( 
      ObjectCache^ cache, 
      Uri^ uri 
   )

Parameters

cache

The cache object to use. This value cannot be null.

uri

The URI to the document. This can be the temporary URI for the uploaded document. This value cannot be null.

Return Value

DocumentCacheInfo object that contains the information of the document referenced by uri such as its name, mime type, page count if the document was found in the cache; otherwise, null if no document with the ID specified by uri was found in the cache.

Remarks

Use GetDocumentCacheInfo to quickly obtain information on a document in the cache without loading it. This includes whether the document is in the cache, its name and mime type, the number of pages and whether it was loaded by the user.

Example

For an example, refer to GetDocumentCacheInfo(ObjectCache,string).

Requirements

Target Platforms