TipcPropertiesSet

Name

TipcPropertiesSet — set the specified name and value in the properties table

Synopsis

T_BOOL TipcPropertiesSet(props, name, value) 
T_IPC_PROPERTIES props; 
T_STR name; 
T_STR value; 

Arguments

props — properties table

name — property name

value — value of name

Return Values

TRUE on success, FALSE otherwise.

Diagnostics

If TipcPropertiesSet fails, it returns FALSE and sets the global SmartSockets error code to:

Description

TipcPropertiesSet associates a value with a property name. If value is null then this property is deleted from the table. This effectively disables the property.

Caution

None

See Also

TipcPropertiesCreate, TipcPropertiesGet

Examples

This example sets the values in a property table:

T_IPC_PROPERTIES props; 
T_BOOL status; 
 
status = TipcPropertiesSet(props, "prop1", "val1"); 
if (!status) { 
  return;  /* error */ 
}