Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

IDSSReportCacheInfo Interface Reference

Inherited by IDSSReportCacheInfo1.

List of all members.

Detailed Description

This interface provides information about a report cache entry in report server.

A report cache entry records the result of an evaluation of a single report in a certain context. The context of the report's execution contains anything that could modify the result of the execution, which includes prompt answers selected, the versions of the objects in the report, the security filter (if any) used for execution and some other factors.

Report cache information is divided into 2 parts to accommodate both fast browsing and in-depth detailed info. Application calls the GetAllCacheInfos, GetCacheInfo and GetCacheInfos methods on IDSSReportCacheAdmin with the option to get browsing info and/or detail info. All the properties on the interface are read only from IDSSReportCacheInfo.


Public Member Functions

HRESULT CacheFileName ([out, retval] BSTR *pCacheFileName)
 The file name used when writing this cache entry to disk.
HRESULT CacheID ([out, retval] BSTR *pCacheID)
 A unique identifier assigned to this specific cache entry.
HRESULT CacheLifeTime ([out, retval] Int32 *pCacheLifeTime)
 The time span a cache is valid since created or last updated.
HRESULT CacheSize ([out, retval] Int32 *pCacheSize)
 The size of memory the cache consumed (in K bytes).
HRESULT CacheStatus ([out, retval] Int32 *pCacheStatus)
 The status of the cache.
HRESULT CacheType ([out, retval] Int32 *pCacheType)
 The type of the cache entry: A matching cache or result set or both.
HRESULT CreateTime ([out, retval] VARIANT *pCreateTime)
 The time that this cache is created.
HRESULT ExpireTime ([out, retval] VARIANT *pExpireTime)
 The time that this cache was or will be expired.
HRESULT FilterID ([out, retval] BSTR *pFilterID)
 GUID for the filter object of the cache.
HRESULT FilterVersionID ([out, retval] BSTR *pFilterVersionID)
 GUID for the version of the filter object of the cache.
HRESULT GetWaitingJob ([in] Int32 Index,[out, retval] Int32 *pWaitingJob)
 Get the job ID of a waiting job by index in the waiting job list.
HRESULT GetWaitingJobsCount ([out, retval] Int32 *pWaitingJobsCount)
 The number of jobs, that are waiting for this cache to be ready (for report caching on server side).
HRESULT HistoricCheck ([out, retval] Int32 *pHistoricCheck)
 The number of times that a cache is checked (for report caching) so far in history.
HRESULT HistoricHitCount ([out, retval] Int32 *pHistoricHitCount)
 The number of times that a cache was hit (for report caching) so far in history.
HRESULT HistoricUpdate ([out, retval] Int32 *pHistoricUpdate)
 The number of times that a cache is updated/created (for report caching) so far in history.
HRESULT InboxRefCount ([out, retval] Int32 *pInboxRefCount)
 The number of inbox messages referring on this cache.
HRESULT LastHitTime ([out, retval] VARIANT *pLastHitTime)
 The last time that the cache was hit.
HRESULT LastLoadTime ([out, retval] VARIANT *pLastLoadTime)
 The last time that this cache was loaded.
HRESULT LastUpdateTime ([out, retval] VARIANT *pLastUpdateTime)
 The last time that the cache was updated/created.
HRESULT LoadCheck ([out, retval] Int32 *pLoadCheck)
 The number of times that a cache is checked since this loading.
HRESULT LoadHitCount ([out, retval] Int32 *pLoadHitCount)
 The number of times that a cache is hit since this loading.
HRESULT LoadUpdate ([out, retval] Int32 *pLoadUpdate)
 The number of times that a cache is updated/created since this loading (for report caching).
HRESULT ReportID ([out, retval] BSTR *pReportID)
 The ID of the report definition object that was executed to generate this cache entry.
HRESULT ReportName ([out, retval] BSTR *pReportName)
 The Name of the report for the cache.
HRESULT ResultUpdateTime ([out, retval] VARIANT *pResultUpdateTime)
 The time the SQL is executed.
HRESULT TemplateID ([out, retval] BSTR *pTemplateID)
 GUID for the template object of the cache.
HRESULT TemplateVersionID ([out, retval] BSTR *pTemplateVersionID)
 GUID for the version of the template object of the cache.
HRESULT Version ([out, retval] BSTR *pVersion)
 The VersionID of the report definition object that was current when this cache was created.

Member Function Documentation

HRESULT IDSSReportCacheInfo::CacheFileName (  [out, retval] BSTR *  pCacheFileName  ) 
 

The file name used when writing this cache entry to disk.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::CacheID (  [out, retval] BSTR *  pCacheID  ) 
 

A unique identifier assigned to this specific cache entry.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::CacheLifeTime (  [out, retval] Int32 *  pCacheLifeTime  ) 
 

The time span a cache is valid since created or last updated.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::CacheSize (  [out, retval] Int32 *  pCacheSize  ) 
 

The size of memory the cache consumed (in K bytes).

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::CacheStatus (  [out, retval] Int32 *  pCacheStatus  ) 
 

The status of the cache.

Possible values are: Ready/Processing/Invalid/Expired/Loaded/Dirty/ResultDirty.

Parameters:
pCacheStatus A value from the EnumDSSCachedReportStates enumeration.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::CacheType (  [out, retval] Int32 *  pCacheType  ) 
 

The type of the cache entry: A matching cache or result set or both.

Parameters:
pCacheType A value from the EnumDSSCacheTypes enumeration.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::CreateTime (  [out, retval] VARIANT *  pCreateTime  ) 
 

The time that this cache is created.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::ExpireTime (  [out, retval] VARIANT *  pExpireTime  ) 
 

The time that this cache was or will be expired.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::FilterID (  [out, retval] BSTR *  pFilterID  ) 
 

GUID for the filter object of the cache.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::FilterVersionID (  [out, retval] BSTR *  pFilterVersionID  ) 
 

GUID for the version of the filter object of the cache.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::GetWaitingJob (  [in] Int32  Index,
[out, retval] Int32 *  pWaitingJob
) 
 

Get the job ID of a waiting job by index in the waiting job list.

Parameters:
Index The index number.
pWaitingJob The ID of the job.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::GetWaitingJobsCount (  [out, retval] Int32 *  pWaitingJobsCount  ) 
 

The number of jobs, that are waiting for this cache to be ready (for report caching on server side).

Parameters:
pWaitingJobsCount The number of jobs waiting for this cache to be ready.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::HistoricCheck (  [out, retval] Int32 *  pHistoricCheck  ) 
 

The number of times that a cache is checked (for report caching) so far in history.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::HistoricHitCount (  [out, retval] Int32 *  pHistoricHitCount  ) 
 

The number of times that a cache was hit (for report caching) so far in history.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::HistoricUpdate (  [out, retval] Int32 *  pHistoricUpdate  ) 
 

The number of times that a cache is updated/created (for report caching) so far in history.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::InboxRefCount (  [out, retval] Int32 *  pInboxRefCount  ) 
 

The number of inbox messages referring on this cache.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::LastHitTime (  [out, retval] VARIANT *  pLastHitTime  ) 
 

The last time that the cache was hit.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::LastLoadTime (  [out, retval] VARIANT *  pLastLoadTime  ) 
 

The last time that this cache was loaded.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::LastUpdateTime (  [out, retval] VARIANT *  pLastUpdateTime  ) 
 

The last time that the cache was updated/created.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::LoadCheck (  [out, retval] Int32 *  pLoadCheck  ) 
 

The number of times that a cache is checked since this loading.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::LoadHitCount (  [out, retval] Int32 *  pLoadHitCount  ) 
 

The number of times that a cache is hit since this loading.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::LoadUpdate (  [out, retval] Int32 *  pLoadUpdate  ) 
 

The number of times that a cache is updated/created since this loading (for report caching).

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::ReportID (  [out, retval] BSTR *  pReportID  ) 
 

The ID of the report definition object that was executed to generate this cache entry.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::ReportName (  [out, retval] BSTR *  pReportName  ) 
 

The Name of the report for the cache.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::ResultUpdateTime (  [out, retval] VARIANT *  pResultUpdateTime  ) 
 

The time the SQL is executed.

It is not meaningful if the SQL was not executed. If hit cache, it is the time the SQL is executed to get the cached result.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::TemplateID (  [out, retval] BSTR *  pTemplateID  ) 
 

GUID for the template object of the cache.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::TemplateVersionID (  [out, retval] BSTR *  pTemplateVersionID  ) 
 

GUID for the version of the template object of the cache.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSReportCacheInfo::Version (  [out, retval] BSTR *  pVersion  ) 
 

The VersionID of the report definition object that was current when this cache was created.

Returns:
Usual COM result code:
  • S_OK

Copyright © 1996-2018 MicroStrategy Inc. All Rights Reserved.