UF_ATTR_iterator_s (view source)
 
Defined in: uf_attr_types.h
 
Also known as:
 
Overview
UF_ATTR_iterator_t

Iterator struct for querying and modifying user attributes

This struct is used to identify attributes to be read, edited or deleted


Data Members

category
char *
Restricts search to attributes with this category (if 'check_category' is set to 'true')

check_category
logical
If set to 'true', restricts searches to attributes with the category specified by 'category'.
(setting this to 'true' with 'category' = NULL allows searching for attributes that have no category)

title
char *
Restricts search to attributes with this title (if not NULL)

type
int
Restricts search to attributes with this type (if not set to UF_ATTR_any)
Valid values:
UF_ATTR_bool
UF_ATTR_integer
UF_ATTR_real
UF_ATTR_time
UF_ATTR_null
UF_ATTR_string
UF_ATTR_any
(NOTE: The UF_ATTR_reference is not supported in the functions that use this struct)

index
int
Restricts search to attributes with a particular array element index, as follows:
For all operations except deleting and locking/unlocking attributes:
If set to a non-negative number, the iterator will restrict search to array elements with the given index.
If set to UF_ATTR_ANY_ATTRIBUTE (default), the iterator will not restrict search to array elements.
For delete operations:
If set to a non-negative number that is not equal to the last index of the array, the function will return an error.
If set to UF_ATTR_ANY_ATTRIBUTE (default), the iterator will not restrict search to array elements.
If set to UF_ATTR_LAST_ELEMENT, the iterator will delete the last element of an array.
For locking/unlocking operations:
If set to UF_ATTR_ANY_ATTRBUTE (default), the iterator wil not restrict search to array elements.
For arrays, locks are always set/unset on all the elements.
For all operations:
If set to anything other than specified above, the function will return an error

include_also_unset
logical
Expands search to the object's unset associated user attribute templates (if values are returned for these, they are the default values)

include_only_unset
logical
Restricts search to the object's unset associated user attribute templates (if values are returned for these, they are the default values)

include_only_pdm_based
logical
Restricts search to DM-based attributes (attributes that are synchronized with Teamcenter)

__initialized
void *
Mark used to determine if this struct has been initialized and/or reset.
(For internal use only - do not set/modify this member)