Reserved attribute name keysΒΆ

SAF_ATT is a collection of related C preprocessor symbols defined in saf.h.

Synopsis:

SAF_ATT_NAMES: If the client passes SAF__ATT_NAMES for the NAME arg in a call to saf_get_attribute, SAF will return a TYPE of string (if the TYPE return value is requested), a COUNT equal to the number of attributes (if the COUNT return value was requested), and a VALUE array containing the names of all attributes defined for the object.

SAF_ATT_COUNT: If the client passes SAF__ATT_COUNT for the NAME arg in a SAF call to saf_get_attribute, SAF will return the count of number of attributes defined for the given object in the COUNT. It is an error to request a count with SAF__ATT_COUNT, but pass NULL for the COUNT argument in a call to get attributes.

SAF_ATT_FIRST: If the client passes SAF__ATT_FIRST, for the NAME argument in a SAF call to saf_get_attribute, SAF will return the first attribute that was ever defined for the object. Thereafter, any call with SAF__ATT_NEXT will iterate through the list of attributes defined for the object.

SAF_ATT_NEXT: This reserved attribute name works in conjunction with SAF__ATT_FIRST, to allow the client to iterate through all attributes defined for a given object. It is an error to pass SAF__ATT_NEXT without at least one prior call with SAF__ATT_FIRST.

Description: There are some reserved attribute names. These reserved attribute names may be passed as the NAME argument in any calls to get attributes (see saf_get_attribute). The SAF__ATT_NAMES / SAF__ATT_COUNT pair of reserved names provide a mechanism to the client to determine the count of attributes defined for a given object and their names. Or, alternatively, the SAF__ATT_FIRST / SAF__ATT_NEXT provide a mechanism for the client to make repetitive calls to iterate through the attributes for a given object.

See Also: