dbReplaceEnumProp

dbReplaceEnumProp( 
g_object 
t_name 
t_value 
l_string 
) 
=> d_prop / nil 

Description

Replaces an enumerated property for an object.

This function is similar to dbCreateEnumProp except that if a property named t_name already exists on the specified object, it is replaced by the one specified as t_value and l_string. An enumerated property can only have values that are strings.

Arguments

g_object	The database object which can be a dbId, ddId, or dbBagId.
t_name	Name of the property.
t_value	Value of the property.
l_string	Array of strings enumerating the possible values of the property, one of which must equal t_value.

Value Returned

d_prop	An enumerated property belonging to the database object.
nil	The value is not in the enumerated property range or if d_object is not a hierarchical property.

Examples

dbReplaceEnumProp(dbId "prop" "grape" list("orange" "grape" "apricot"))

Related Topics

Property Creation and Modification Functions

Return to top