Namespace: Consultingwerk.Framework
Class 
DatasetCacheService Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.DatasetCacheService

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Framework.IDatasetCacheService


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
ClearCache () Removes all datasets from the cache
LOGICAL ContainsDataset (character) Returns if a dataset with the given cache key is in the cache
LOGICAL RemoveDataset (character) Removes the dataset with the given cache key from the cache
INTEGER RemoveExpiredDatasets () Removes all expired datasets from the cache
LOGICAL RetrieveDataset (character, dataset-handle) Retrieves a dataset from the cache
LOGICAL RetrieveDataset (character, dataset-handle, Object) Retrieves a dataset and its tag from the cache
StoreDataset (character, dataset-handle, integer) Stores a copy of the dataset in the cache
StoreDataset (character, dataset-handle, integer, Object) Stores a copy of the dataset together with a tag object in the cache

Top Property Summary
Options Name Purpose
INTEGER Count


Method Detail
Top

ClearCache ()
Purpose: Removes all datasets from the cache
Notes: Deletes the cached dataset copies

Top

LOGICAL ContainsDataset (character)
Purpose: Returns if a dataset with the given cache key is in the cache
Notes: Expired datasets are removed from the cache before the lookup

Parameters:
pcCacheKey CHARACTER
The key of the dataset
Returns LOGICAL
Logical value indicating if a (non expired) dataset is in the cache
Top

LOGICAL RemoveDataset (character)
Purpose: Removes the dataset with the given cache key from the cache
Notes: Deletes the cached dataset copy

Parameters:
pcCacheKey CHARACTER
The key of the dataset
Returns LOGICAL
Logical value indicating if a dataset was removed
Top

INTEGER RemoveExpiredDatasets ()
Purpose: Removes all expired datasets from the cache
Notes: A dataset is expired when its expiry time is before or equal to the
current time. Datasets stored with a cache age of 0 never expire

Returns INTEGER
The number of datasets that have been removed
Top

LOGICAL RetrieveDataset (character, dataset-handle)
Purpose: Retrieves a dataset from the cache
Notes: Expired datasets are removed from the cache before the lookup.
The cached data is copied into the passed dataset (which is
emptied first). The dataset should be passed BY-REFERENCE

Parameters:
pcCacheKey CHARACTER
The key of the dataset
phDataset DATASET-HANDLE
The dataset to copy the cached data into
Returns LOGICAL
Logical value indicating if the dataset was found in the cache
Top

LOGICAL RetrieveDataset (character, dataset-handle, Object)
Purpose: Retrieves a dataset and its tag from the cache
Notes: Expired datasets are removed from the cache before the lookup.
The cached data is copied into the passed dataset (which is
emptied first). The dataset should be passed BY-REFERENCE

Parameters:
pcCacheKey CHARACTER
The key of the dataset
phDataset DATASET-HANDLE
The dataset to copy the cached data into
poTag Progress.Lang.Object
OUTPUT The tag object stored with the dataset (may be unknown)
Returns LOGICAL
Logical value indicating if the dataset was found in the cache
Top

StoreDataset (character, dataset-handle, integer)
Purpose: Stores a copy of the dataset in the cache
Notes: An existing entry with the same cache key is replaced. The
dataset should be passed BY-REFERENCE

Parameters:
pcCacheKey CHARACTER
The key of the dataset
phDataset DATASET-HANDLE
The dataset to store
piCacheAge INTEGER
The number of seconds after which the dataset expires, 0 = never expires
Top

StoreDataset (character, dataset-handle, integer, Object)
Purpose: Stores a copy of the dataset together with a tag object in the cache
Notes: An existing entry with the same cache key is replaced. The
dataset should be passed BY-REFERENCE

Parameters:
pcCacheKey CHARACTER
The key of the dataset
phDataset DATASET-HANDLE
The dataset to store
piCacheAge INTEGER
The number of seconds after which the dataset expires, 0 = never expires
poTag Progress.Lang.Object
The tag object to store with the dataset (may be unknown)


Property Detail
Top

INTEGER Count

Returns INTEGER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:07:24