IDSSReportCacheAdmin Interface Reference

Inherited by IDSSReportCacheAdmin1.

List of all members.

---

Detailed Description

IDSSReportCacheAdmin provides the API for user to administrate DSS report caching.

An application can setup and initialize DSS report caching mechanism using the properties and methods on IDSSReportCacheAdmin. An application can get detailed information on each cache item and control the secondary caches.

An application obtains an instance of this interface from a session (IDSSSession) to the Intelligence Server. From the session the IDSSSession::ServerAdmin property returns the server administrator object (IDSSServerAdmin) for the session.

Each project in the server had its own report cache administrator. So to obtain the administrator for a paraticular project you need to know its internal project ID. From the server admin object, use its IDSSServerAdmin::ProjectInstances property to get the collection of projects currently loaded in the server. Look through the collection to find the IDSSProjectInstance interface for the desired project. The IDSSProjectInstance::ID property on this interface returns the internal project ID for the project. This ID number used depends on which projects happen to be loaded in the server, and so may not be the same each time.

Returning to the server administrator object, the IDSSServerAdmin::CacheAdministrator method can be used to obtain a report cache manager for the desired project, passing in the internal project number of the project as a parameter to the method.

Public Member Functions
HRESULT	BackupAllCaches ()
	Back up all the dirty caches in the memory into files.
HRESULT	BackupCache ([in] BSTR ID,[in] EnumDSSCachingIDType IDType)
	Backup a specific cache or caches for a specific report if it is dirty.
HRESULT	BackupCachePool ()
	Backup the cache pool into a file.
HRESULT	BackupLKUPTable ()
	Backup the cache lookup table into a file.
HRESULT	CacheLifeTime ([out, retval] Int32 *pVal)
	Read Only.
HRESULT	CacheTableBucketCount ([out, retval] Int32 *pVal)
	The number of buckets in the cache lookup and cache pool hash table..
HRESULT	CacheTableBucketPerLock ([out, retval] Int32 *pVal)
	The number of buckets a lock locks.
HRESULT	CleanUpInvalidCaches ([in, optional, defaultvalue(3)] Int32 CacheDeleteOption)
	Delete all the caches with status expired and/or invalid and no inbox references from the cache lookup table.
HRESULT	CreateCache ([in] BSTR ReportID)
	Create cache for a specific report.
HRESULT	DeleteAllCaches ([in, optional, defaultvalue(3)] Int32 CacheTypeOption)
	Delete all the caches of the specified type from cache pool in memory.
HRESULT	DeleteCache ([in] BSTR ID,[in] EnumDSSCachingIDType IDType)
	Delete a specific cache or caches for a specific report from the cache pool.
HRESULT	ExpireAllCaches ([in, optional, defaultvalue(3)] Int32 CacheTypeOption)
	Mark all the caches in the cache lkuptable as expired/invalid and reset the lkuptable.
HRESULT	ExpireCache ([in] BSTR ID,[in] EnumDSSCachingIDType IDType)
	Mark a specific cache or caches for a specific report as expired.
HRESULT	FileCachePath ([out, retval] BSTR *pVal)
	The path where the cache files is stored.
HRESULT	GetAllCacheInfos ([in] EnumDSSReportCacheInfoOptions CacheInfoOption,[in, optional, defaultvalue(3)] Int32 CacheTypeOption,[in, optional, defaultvalue(1)] Int32 FromCacheNo,[in, optional, defaultvalue(-1)] Int32 ToCacheNo,[out, retval] IDSSReportCacheInfos ppCacheInfos)
	Get the report cache information for all the caches.
HRESULT	GetCacheInfo ([in] BSTR CacheID,[in] EnumDSSReportCacheInfoOptions CacheInfoOption,[in, optional] BSTR Version,[out, retval] IDSSReportCacheInfo ppCacheInfo)
	Get the report cache information for a specific cache.
HRESULT	GetCacheInfos ([in] BSTR ReportID,[in] EnumDSSReportCacheInfoOptions CacheInfoOption,[out, retval] IDSSReportCacheInfos ppCacheInfos)
	Get the report cache information for the caches of a specific report.
HRESULT	GetClusterCacheHitCounts ([in] BSTR iServerName,[out] Int32 *opSize,[out] SAFEARRAY(BSTR)*oppReportNames,[out] SAFEARRAY(BSTR)*oppCacheIDs,[out] SAFEARRAY(Int32)*oppHitCounts)
	Get a list of reportid, cacheid and non-zero hitcount for all caches in one cluster server.
HRESULT	GetGeneralCacheInfo ([out, retval] IDSSGeneralCacheInfo ppInfo)
	Get general monitoring information of caches.
HRESULT	InvalidateAllCaches ([in, optional, defaultvalue(3)] Int32 CacheTypeOption)
	Mark all the caches in the LKUPTable as Invalid and reset the LKUPTable.
HRESULT	InvalidateCache ([in] BSTR ID,[in] EnumDSSCachingIDType IDType)
	Mark a specific cache or caches for a specific report as Invalid.
HRESULT	LoadAllCaches ()
	Load all the caches into memory from files.
HRESULT	LoadCache ([in] BSTR ID,[in] EnumDSSCachingIDType IDType)
	Load a specific cache or caches for a specific report into memory.
HRESULT	MaxCacheCount ([out, retval] Int32 *pVal)
	The maximum number of caches allowed (in memory or on disk) in the cache pool hash table.
HRESULT	MaxMemoryConsumption ([out, retval] Int32 *pVal)
	The maximum size of memory can be allocated for in-memory caches.
HRESULT	SwapPolicy ([out, retval] EnumDSSCacheSwapPolicy *pVal)
	When the total size of in-memory caches reaches the MaxMemoryConsumption limit, and a new cache needs to be added or a cache needs to be loaded into memory from disk, we use the policy to decide which existing caches to be swapped out of memory in the case of report caching..
HRESULT	UnloadAllCaches ()
	Back up all the dirty caches in the memory into files.
HRESULT	UnloadCache ([in] BSTR ID,[in] EnumDSSCachingIDType IDType)
	Backup a specific cache or caches for a specific report if it is dirty and remove it from memory.
HRESULT	UpdateAllCaches ([in, optional, defaultvalue(3)] Int32 CacheTypeOption)
	Re-execute and update all the caches of specified type.
HRESULT	UpdateCache ([in] BSTR ID,[in] EnumDSSCachingIDType IDType)
	Re-execute and update a specified cache or caches for a specific report.

---

Member Function Documentation

HRESULT IDSSReportCacheAdmin::BackupAllCaches (   )

Back up all the dirty caches in the memory into files. (Dirty means that the cache has been updated/created, or the cacheinfo has been changed since last back up.) The Dirty flags are cleared but the caches are still kept in memory.. Back up all the dirty caches in the memory into files. (Dirty means that the cache has been updated/created, or the cacheinfo has been changed since last back up.) The Dirty flags are cleared but the caches are still kept in memory. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_E_RCM_CORRUPTED_CACHE_ENTRY The cache pool or the cache lookup hash table is corrupted RPTSVR_E_RCM_CREATE_CACHE_FILE The Report Cache Manager could not create a cache file, including cachepool, cache lookup table index file and cache info, cached report instance result files. RPTSVR_E_RCM_SAVE_VERSION The Report Cache Manager could not save the version information to the cachefile RPTSVR_E_RCM_SAVE_CACHE The Report Cache Manager could not save the cache lookup hash table(or the cachepool hash table, or the cacheinfo, cached report instance result) RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::BackupCache (  [in] BSTR  ID, [in] EnumDSSCachingIDType  IDType )

Backup a specific cache or caches for a specific report if it is dirty. (Dirty means that the cache has been updated/created, or the cacheinfo has been changed since last back up.) The Dirty flags are cleared but the cache is still kept in memory.. Backup a specific cache or caches for a specific report if it is dirty. (Dirty means that the cache has been updated/created, or the cacheinfo has been changed since last back up.) The Dirty flags are cleared but the cache is still kept in memory. Parameters: ID  Cache ID. IDType  DssCachingReportID, DssCachingCacheID Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_CACHE_NOT_FOUND Could not find the cache in the cache pool. RPTSVR_E_RCM_INVALID_CACHE_IDTYPE The cache type passed in is invalid. Should be either cache id or ID RPTSVR_E_RCM_CREATE_CACHE_FILE The Report Cache Manager could not create a cache file, including cachepool, cache lookup table index file and cache info, cached report instance result files. RPTSVR_E_RCM_SAVE_VERSION The Report Cache Manager could not save the version information to the cachefile RPTSVR_E_RCM_SAVE_CACHE The Report Cache Manager could not save the cache lookup hash table(or the cachepool hash table, or the cacheinfo, cached report instance result) RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::BackupCachePool (   )

Backup the cache pool into a file. Returns: Usual COM result code: S_OK RPTSVR_E_RCM_CREATE_CACHE_FILE The Report Cache Manager could not create a cache file, including cachepool, cache lookup table index file and cache info, cached report instance result files. RPTSVR_E_RCM_SAVE_VERSION The Report Cache Manager could not save the version information to the cachefile RPTSVR_E_RCM_SAVE_CACHE The Report Cache Manager could not save the cache lookup hash table(or the cachepool hash table, or the cacheinfo, cached report instance result) RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::BackupLKUPTable (   )

Backup the cache lookup table into a file. Returns: Usual COM result code: S_OK RPTSVR_E_RCM_CREATE_CACHE_FILE The Report Cache Manager could not create a cache file, including cachepool, cache lookup table index file and cache info, cached report instance result files. RPTSVR_E_RCM_SAVE_VERSION The Report Cache Manager could not save the version information to the cachefile RPTSVR_E_RCM_SAVE_CACHE The Report Cache Manager could not save the cache lookup hash table(or the cachepool hash table, or the cacheinfo, cached report instance result) RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::CacheLifeTime (  [out, retval] Int32 *  pVal  )

Read Only. The lifetime of caches. Caches are marked as Expired and cannot be hit by later executions.. Get the cache life time. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::CacheTableBucketCount (  [out, retval] Int32 *  pVal  )

The number of buckets in the cache lookup and cache pool hash table.. The number of buckets in the cache lookup and cache pool hash table. This is a read-only property. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager has not been initialized. RPTSVR_CACHING_DISABLED Caching is disabled from the project level.

HRESULT IDSSReportCacheAdmin::CacheTableBucketPerLock (  [out, retval] Int32 *  pVal  )

The number of buckets a lock locks. (Not implemented yet.). This is a read-only property. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager has not been initialized. RPTSVR_CACHING_DISABLED Caching is disabled from the project level.

HRESULT IDSSReportCacheAdmin::CleanUpInvalidCaches (  [in, optional, defaultvalue(3)] Int32  CacheDeleteOption  )

Delete all the caches with status expired and/or invalid and no inbox references from the cache lookup table. Delete all the related cache files. The option parameter is used as a flag to decide if caches with non-matching versioned objects are to be deleted also.. Delete all the caches with status expired and/or invalid and no inbox references from the cache lookup table. Delete all the related cache files. The option parameter is used as a flag to decide if caches with non-matching versioned objects are to be deleted also. Parameters: CacheDeleteOption  As a flag to decide if caches with non-matching versioned objects are to be deleted. Should be renamed. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_E_RCM_CORRUPTED_CACHE_ENTRY The cache pool or the cache lookup hash table is corrupted RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::CreateCache (  [in] BSTR  ReportID  )

Create cache for a specific report. Not implemented yet. Returns: Usual COM result code: S_OK

HRESULT IDSSReportCacheAdmin::DeleteAllCaches (  [in, optional, defaultvalue(3)] Int32  CacheTypeOption  )

Delete all the caches of the specified type from cache pool in memory. And delete all the related cache files. Reset LKUPTable if the type option is for all matching caches.. Delete all the caches of the specified type from cache pool in memory. And delete all the related cache files. Reset LKUPTable if the type option is for all matching caches. Parameters: CacheTypeOption  DssCacheTypeMatchingCache, DssCacheTypeResultCache, or both Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_E_RCM_CORRUPTED_CACHE_ENTRY The cache pool or the cache lookup hash table is corrupted RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::DeleteCache (  [in] BSTR  ID, [in] EnumDSSCachingIDType  IDType )

Delete a specific cache or caches for a specific report from the cache pool. Delete the cache files if exit.. Delete a specific cache or caches for a specific report from the cache pool. Delete the cache files if exit. Parameters: ID  Cache ID. IDType  DssCachingReportID, DssCachingCacheID Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_CACHE_NOT_FOUND Could not find the cache in the cache pool. RPTSVR_E_RCM_INVALID_CACHE_IDTYPE The cache type passed in is invalid. Should be either cache id or report id RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::ExpireAllCaches (  [in, optional, defaultvalue(3)] Int32  CacheTypeOption  )

Mark all the caches in the cache lkuptable as expired/invalid and reset the lkuptable. Delete those caches with no inbox references.. Mark all the caches in the cache lkuptable as expired/invalid and reset the lkuptable. Delete those caches with no inbox references. Parameters: CacheTypeOption  Useless parameter, should be removed Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::ExpireCache (  [in] BSTR  ID, [in] EnumDSSCachingIDType  IDType )

Mark a specific cache or caches for a specific report as expired. Delete it if it has no inbox references.. Mark a specific cache or caches for a specific report as expired. Delete it if it has no inbox references. Parameters: ID  Cache ID. IDType  DssCachingReportID, DssCachingCacheID Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_CACHE_NOT_FOUND Could not find the cache in the cache pool. RPTSVR_E_RCM_INVALID_CACHE_IDTYPE The cache type passed in is invalid. Should be either cache id or report id RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::FileCachePath (  [out, retval] BSTR *  pVal  )

The path where the cache files is stored. If the user did not specify it (leave empty), the default is the working directory of the DSSServer.. The path where cache files are stored. User can specify this path in Project Reference. This setting then comes to Data Source for ReportCacheManager to pickup. If it is not specified, the path of the parent data source is used. /Caches is used if there is not any still. This is a read-only property. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::GetAllCacheInfos (  [in] EnumDSSReportCacheInfoOptions  CacheInfoOption, [in, optional, defaultvalue(3)] Int32  CacheTypeOption, [in, optional, defaultvalue(1)] Int32  FromCacheNo, [in, optional, defaultvalue(-1)] Int32  ToCacheNo, [out, retval] IDSSReportCacheInfos   ppCacheInfos )

Get the report cache information for all the caches. Take two options for CacheInfoOption (Detail/Browse) and CacheTypeOption (Matching cache or Result set or both). It also takes 2 other parameters specifying the start and end caches to enable incremental fetch. Parameters: CacheInfoOption  DssCacheInfoBrowsing, DssCacheInfoDetail CacheTypeOption  DssCacheTypeMatchingCache, DssCacheTypeResultCache, or both FromCacheNo  Index number from which we start retrieving caches. Must be >= 1 ToCacheNo  Index number of last cache retrieved. Use -1 to get all caches. ppCacheInfos  The collection of all cache information. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager has not been initialized. RPTSVR_E_RCM_CORRUPTED_CACHE_ENTRY The cache pool or the cache lookup hash table is corrupted. RPTSVR_CACHING_DISABLED Caching is disabled from the project level.

HRESULT IDSSReportCacheAdmin::GetCacheInfo (  [in] BSTR  CacheID, [in] EnumDSSReportCacheInfoOptions  CacheInfoOption, [in, optional] BSTR  Version, [out, retval] IDSSReportCacheInfo   ppCacheInfo )

Get the report cache information for a specific cache. Take an option for Cache Info Option (Detail/Browse). Parameters: CacheID  Identify the report whose information is desired. CacheInfoOption  DssCacheInfoBrowsing DssCacheInfoDetail Version  ppCacheInfo  Interface exposing the information. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_CACHE_NOT_FOUND Could not find the cache in the cache pool RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::GetCacheInfos (  [in] BSTR  ReportID, [in] EnumDSSReportCacheInfoOptions  CacheInfoOption, [out, retval] IDSSReportCacheInfos   ppCacheInfos )

Get the report cache information for the caches of a specific report. Take an option for Cache Info Option (Detail/Browse). Parameters: ReportID  Identify the report whose information is desired. CacheInfoOption  DssCacheInfoBrowsing DssCacheInfoDetail ppCacheInfos  Collection containing the report cache information. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_CACHE_NOT_FOUND Could not find the cache in the cache pool. RPTSVR_E_RCM_CORRUPTED_CACHE_ENTRY The cache pool or the cache lookup hash table is corrupted. RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::GetClusterCacheHitCounts (  [in] BSTR  iServerName, [out] Int32 *  opSize, [out] SAFEARRAY(BSTR)*  oppReportNames, [out] SAFEARRAY(BSTR)*  oppCacheIDs, [out] SAFEARRAY(Int32)*  oppHitCounts )

Get a list of reportid, cacheid and non-zero hitcount for all caches in one cluster server. This method is for IDSSReportCacheAdmin interface only. Parameters: iServerName  Identify the server whose data is needed. opSize  The number of caches in the cluster server which have non-zero hitcounts oppReportNames  Safearray of Report Name in BSTR oppCacheIDs  Safearray of CacheID in BSTR oppHitCounts  Safearray of HitCounts in long Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_CACHING_DISABLED Caching is disabled from the project level RPTSVR_E_RCM_CORRUPTED_CACHE_ENTRY The cache pool or the cache lookup hash table is corrupted

HRESULT IDSSReportCacheAdmin::GetGeneralCacheInfo (  [out, retval] IDSSGeneralCacheInfo   ppInfo  )

Get general monitoring information of caches. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::InvalidateAllCaches (  [in, optional, defaultvalue(3)] Int32  CacheTypeOption  )

Mark all the caches in the LKUPTable as Invalid and reset the LKUPTable. Delete those caches with no inbox references from disk and cachepool also. Parameters: CacheTypeOption  Useless parameter, should be removed Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_E_RCM_CORRUPTED_CACHE_ENTRY The cache pool or the cache lookup hash table is corrupted RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::InvalidateCache (  [in] BSTR  ID, [in] EnumDSSCachingIDType  IDType )

Mark a specific cache or caches for a specific report as Invalid. Delete it if it has no inbox references.. Mark a specific cache or caches for a specific report as Invalid. Delete it if it has no inbox references. Parameters: ID  Cache ID. IDType  DssCachingReportID, DssCachingCacheID Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_CACHE_NOT_FOUND Could not find the cache in the cache pool. RPTSVR_E_RCM_INVALID_CACHE_IDTYPE The cache type passed in is invalid. Should be either cache id or report id RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::LoadAllCaches (   )

Load all the caches into memory from files. Limited by MaxMemoryConsumption.. Load all the caches into memory from files. Limited by MaxMemoryConsumption. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_OUTOF_CACHE_MEMORY The MaxCacheMemoryConsumption was reached. Cannot load any more caches into memory. RPTSVR_E_RCM_CORRUPTED_CACHE_ENTRY The cache pool or the cache lookup hash table is corrupted RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::LoadCache (  [in] BSTR  ID, [in] EnumDSSCachingIDType  IDType )

Load a specific cache or caches for a specific report into memory. Apply swap policy if cache memory is running out.. Load a specific cache or caches for a specific report into memory. Apply swap policy if cache memory is running out. Parameters: ID  Cache ID. IDType  DssCachingReportID, DssCachingCacheID Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_CACHE_NOT_FOUND Could not find the cache in the cache pool. RPTSVR_E_RCM_INVALID_CACHE_IDTYPE The cache type passed in is invalid. Should be either cache id or report ID RPTSVR_CACHE_EXPIRED The cache is already expired. RPTSVR_OUTOF_CACHE_MEMORY The MaxCacheMemoryConsumption has been reached. Cannot load any more caches into memory. RPTSVR_E_RCM_INVALID_CACHE_FILE_NAME There is no valid cache file name in the cacheinfo. RPTSVR_CACHE_FILE_NOT_FOUND The Report Cache Manager could not open the cache file to read. RPTSVR_E_RCM_LOAD_VERSION The Report Cache Manager could not load the version information from the cache file. RPTSVR_E_RCM_WRONG_VERSION The version in the cache file is not consistent with the module version of the Report Cache Manager. RPTSVR_CACHE_INVALID The cache is invalid. RPTSVR_E_RCM_UPDATE_MEMORY_SIZE Error occurs when the Report Cache Manager tries to update the total cache memory size. RPTSVR_E_RCM_LOAD_CACHE_FILE The Report Cache Manager could not read the cache file successfully. RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::MaxCacheCount (  [out, retval] Int32 *  pVal  )

The maximum number of caches allowed (in memory or on disk) in the cache pool hash table. This is a read-only property. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager has not been initialized. RPTSVR_CACHING_DISABLED Caching is disabled from the project level.

HRESULT IDSSReportCacheAdmin::MaxMemoryConsumption (  [out, retval] Int32 *  pVal  )

The maximum size of memory can be allocated for in-memory caches. It is an estimate in K bytes. This is a read-only property. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager has not been initialized. RPTSVR_CACHING_DISABLED Caching is disabled from the project level.

HRESULT IDSSReportCacheAdmin::SwapPolicy (  [out, retval] EnumDSSCacheSwapPolicy *  pVal  )

When the total size of in-memory caches reaches the MaxMemoryConsumption limit, and a new cache needs to be added or a cache needs to be loaded into memory from disk, we use the policy to decide which existing caches to be swapped out of memory in the case of report caching.. Read only. When the total size of in-memory caches reaches the MaxMemoryConsumption limit and a new cache need to be added or a cache needs to be loaded into memory from disk, we use the policy to decide which existing caches to be swapped out of memory in the case of report caching. EnumDSSCacheRplcPolicy have following value: DssCacheSwapPolicyLRU - LRU swap policy. DssCacheSwapPolicyLHC - Least hit count cache is replaced. This is a read-only property. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager has not been initialized. RPTSVR_CACHING_DISABLED Caching is disabled from the project level.

HRESULT IDSSReportCacheAdmin::UnloadAllCaches (   )

Back up all the dirty caches in the memory into files. (Dirty means that the cache has been updated/created since last back up.) All the caches are removed from memory.. Back up all the dirty caches in the memory into files. (Dirty means that the cache has been updated/created since last back up.) All the caches are removed from memory. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_E_RCM_CORRUPTED_CACHE_ENTRY The cache pool or the cache lookup hash table is corrupted RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::UnloadCache (  [in] BSTR  ID, [in] EnumDSSCachingIDType  IDType )

Backup a specific cache or caches for a specific report if it is dirty and remove it from memory. (Dirty means that the cache has been updated/created, or the cacheinfo has been changed since last back up.). Backup a specific cache or caches for a specific report if it is dirty and remove it from memory. (Dirty means that the cache has been updated/created, or the cacheinfo was changed since last back up.) Parameters: ID  GUID string IDType  DssCachingReportID, DssCachingCacheID Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_CACHE_NOT_FOUND Could not find the cache in the cache pool. RPTSVR_E_RCM_INVALID_CACHE_IDTYPE The cache type passed in is invalid. Should be either cache id or report id RPTSVR_E_RCM_UPDATE_MEMORY_SIZE Error occurs when the Report Cache Manager tries to update the total cache memory size. RPTSVR_E_RCM_CREATE_CACHE_FILE The Report Cache Manager could not create a cache file, including cachepool, cache lookup table index file and cache info, cached report instance result files. RPTSVR_E_RCM_SAVE_VERSION The Report Cache Manager could not save the version information to the cachefile RPTSVR_E_RCM_SAVE_CACHE The Report Cache Manager could not save the cache lookup hash table(or the cachepool hash table, or the cacheinfo, cached report instance result) RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::UpdateAllCaches (  [in, optional, defaultvalue(3)] Int32  CacheTypeOption  )

Re-execute and update all the caches of specified type. (Not implemented.). Re-execute and update all the caches of the specifed type. Not implemented yet. Returns: Usual COM result code: S_OK RPTSVR_E_CACHE_ADMIN_NOT_INITIALIZED Report Cache Manager was not initialized. RPTSVR_CACHING_DISABLED Caching is disabled from the project level

HRESULT IDSSReportCacheAdmin::UpdateCache (  [in] BSTR  ID, [in] EnumDSSCachingIDType  IDType )

Re-execute and update a specified cache or caches for a specific report. (for now 12/10/1999, same as BackupCache). Re-execute and update a specified cache or caches for a specific report.(for now 12/10/1999, same as BackupCache) Parameters: ID  Cache ID. IDType  DssCachingReportID, DssCachingCacheID Returns: Usual COM result code: S_OK See BackUpCache

---