peoplecodeapi - GetRowsetCache

Syntax

GetRowsetCache([Rowset.]name, [language])

Description

Use GetRowsetCache to return the existing rowset cache with the given name.

Note: This function returns a RowsetCache object, not a rowset object. You must use the Get RowsetCache method in order to convert a RowsetCache object into a rowset object.

Every time you use the GetRowsetCache function, you should verify that the function executed successfully by testing for a null object. For example:

Local RowsetCache &RSC;

&RSC = GetRowsetCache(Rowset.MyRowset);

If All(&RSC) Then
		/* do processing */
Else
		/* call to populate rowset cache */
End-if;

Parameters

Field or Control	Definition
Record. `name`	Specify the name of a RowsetCache. If you just specify `name` , you must enclose the name in quotation marks.
`language`	Specify which language the rowset cache is retrieved from. Possible values are: %RowsetCache_SignonLang â Fetch the rowset cache for the sign-on language. If it doesn't exist then return failure. %RowsetCache_BaseLang â Fetch the rowset cache for the base language only. If it doesn't exist then return failure. %RowsetCache_SignonOrBaseLang â Fetch the rowset cache for the sign-on language. If the rowset cache for the sign-on language doesn't exist then fetch the base language rowset cache. If the base language rowset cache doesn't exist then return failure. This parameter is optional. The default is %RowsetCache_SignonLang

Field or Control

Definition

Record. name

Specify the name of a RowsetCache. If you just specify name , you must enclose the name in quotation marks.

language

Specify which language the rowset cache is retrieved from.

Possible values are:

%RowsetCache_SignonLang â Fetch the rowset cache for the sign-on language. If it doesn't exist then return failure.

%RowsetCache_BaseLang â Fetch the rowset cache for the base language only. If it doesn't exist then return failure.

%RowsetCache_SignonOrBaseLang â Fetch the rowset cache for the sign-on language. If the rowset cache for the sign-on language doesn't exist then fetch the base language rowset cache. If the base language rowset cache doesn't exist then return failure.

This parameter is optional.

The default is %RowsetCache_SignonLang

Returns

A RowsetCache object populated with the rowset cache instance specified.