Protect Function

Format

i = protect(symbol, protect_property);

Description

The protect function modifies the protected property of the field symbol. If symbol is a block, group, form, or dictionary, the function will try to apply the protected property to all fields belonging to that symbol. The numeric expression protect_property turns the protected property off (if zero) or on (if nonzero).

Return Value

The function returns the number of items whose protected property was successfully changed.

Example

PROC RELATIONSHIP

onfocus

// automatically set the first person to be the head of the household
// and protect the field so that it is not shown to the enumerator
if curocc() = 1 then
RELATIONSHIP = 1;
protect(RELATIONSHIP, true);
else
protect(RELATIONSHIP, false);
endif;

See also: SetProperty Function