RAD function: set.display.value

A RAD function that sets the display value for a specified field of a file variable. The display value can then be retrieved by using the get.display.value($file,$fieldname) syntax.

Function

set.display.value

Format

set.display.value($file,$fieldname,$dispvalue,[index])

Parameters

The following parameters are valid for this function.

Parameter

Description

$file

The file variable for which the display value is set

$fieldname

The field name in the file

$dispvalue

The display value to be set

 [index]

This parameter is optional.

If the field specified in $fieldname is of the array type, the index is the position number of an element in the array where the element is located; if the index is not specified or is -1, $dispvalue must be an array type value as well.

Factors

This function sets the display value in an internal display value cache associated with the $file variable. If an internal display value cache does not already exist, this function creates a cache.

Return values

Null or the old display value, which can be an array of strings or a string.

Example

See RAD function: get.display.value