LoadStreamFromCache Method

Summary

Loads a previously saved document stream data from the specified cache.

Syntax

C++/CLI

Python

public static Stream LoadStreamFromCache( 
   LoadFromCacheOptions options 
)

public:  
   static Stream^ LoadStreamFromCache( 
      LoadFromCacheOptions^ options 
   )

def LoadStreamFromCache(self,options):

Parameters

options

Options identifying the document to load.

Return Value

The document stream if found in the cache; otherwise, null.

Remarks

This method returns null if the data was in the cache but expired and was purged.

This method may also return null if the data was associated with a user token and the correct value was not passed in options . Refer to InvalidUserTokenException for more information.

Saving and loading from the cache is useful if the data is to be re-used between sessions in your application. The document identifier (_documentId_) is all that is needed to store in order to re-construct the document after saved to the cache and disposed. This ID can be stored in a database or passed to the client side as in the case of the LEADTOOLS Document Web Service.

Requirements

Target Platforms