GetRecord

The GetRecord method retrieves from the cache a record associated with the specified key.

Method Synopsis

GetRecord($recordKey)

Parameters

$recordKey
Specifies the key associated with the record to be retrieved from the cache. This key was returned in a previous call to the CacheRecord method after it successfully inserted the record into the cache.

Description

The GetRecord method retrieves from the cache a record associated with the key specified in the $recordKey parameter. You specified the name of the cache in a previous call to the RIV::RecordCache constructor.

Example Usage

The following example illustrates a typical call to the GetRecord method, where the method returns to $record a hash from a previously specified cache that contains several records:

my $record = $cache->GetRecord();

Returns

Upon completion, the GetRecord method returns:

  • %record — Specifies a hash that represents one of the records residing in the cache.

See Also