UGet()

<< Click to Display Table of Contents >>

Navigation:  Available Functions >

UGet()

Syntax

UGet( <StorageLocation> )

 

Purpose

To retrieve a user-stored value of any type.

 

Parameters

<StorageLocation> is the location of a specific value to retrieve. The <StorageLocation> is always an integer numeric value (1, 2, 3, 4, etc.).

 

Returns

The value which was stored to <StorageLocation> by the UPut() function (described later in this appendix).

 

Usage

The UGet() function is designed specifically to be used in conjunction with the UPut() function. The UPut()/UGet() pair of functions allow you to store and retrieve values of any type during a report or selection in DonorQuest. These are very advanced functions, mainly designed to be used with custom selections.

 

Very basically, the UPut()/UGet() functions allow you to store and retrieve temporary values, much like the memory function on a hand-held calculator allows you to temporarily store intermediate results with the memory key. Note that the values you store and retrieve with the UPut()/UGet() functions are temporary -- they will be gone when you exit DonorQuest.

 

Example

When defining Custom selections, you may occasionally need to create very complex conditions. These conditions can become very long -- especially if you make use of the SUM_IN() function. For such conditions, it is often easier to break a complex condition down into intermediate results which you would store via the UPut() function. Then, the results of the complex conditions would be readily available via the UGet() function.

 

The following examples begin to illustrate UPut() and UGet(). For more information, please refer to the UPut() function:

 

CALL

RESULT

UPut( "Memory Is Precious", 1 )

Memory Is Precious

UPut( 3.141592654, 2 )

3.141592654

UGet( 1 )

Memory Is Precious

UGet( 2 )

3.141592654