Change a property value

ss_prop_set is a function defined in ssprop.c.

Synopsis:

herr_t ss_prop_set(ss_prop_t *prop, const char *name, hid_t type, const void *value)

Formal Arguments:

  • prop: property list to be modified
  • name: optional name of property to be modified
  • type: optional datatype for supplied value
  • value: optional new property value

Description: A property’s value can be modified by supplying a new value with this function. If type is specified then the value will be of this type, which must be conversion-compatible with the type declared when the property was added to the list. Otherwise, when no type is specified the value should be of the type originally specified to ss_prop_add. If name is null then type and value refer to the entire property list rather than a single property. The value is copied into the property list, and if value is a null pointer then the property (or entire property list if name is null) is reset to zero.

Return Value: Returns non-negative on success; negative on failure. The property list must be marked as “modifiable” in order to change a property value. If the specified type is not conversion compatible with the stored type then the property is not modified.

Parallel Notes: Indepdnent

See Also: