Developing WebSpeed Applications

set-user-field

This function sets the value of a user-specified field. The new value can replace or be appended to the existing value. The function returns TRUE if the field was added and returns FALSE otherwise.

Location

web\method\cgiutils.i

Parameters

INPUT p_name AS CHARACTER

The name of a user field to set. Almost any alphanumeric name can be used.

INPUT p_value AS CHARACTER

A character string with the value to which the field should be set.

Returns

LOGICAL

Notes

If a field is set with a name that is the same as form input in the current Web request, certain functions will use the value of the user field instead of form input.

The function queues a message if adding the field fails.

Using set-user-field, one Web object can make data available to other Web objects. A Web object can access that information with the get-user-field or get-value functions.

User fields are cleared with each new Web request.

Examples

cEmail = user-name + "@":U + login-company + ".com":U
set-user-field("email-address",cEmail)