SE InitializeInheritedComponentIterator

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE InitializeInheritedComponentIterator

extern SE_Status_Code
SE_InitializeInheritedComponentIterator
(
SE_Object		start_object,	(notes)
SE_Search_Filter		filter,	(notes)
SE_Boolean		directly_attach_table_components,	(notes)
SE_ITR_Behaviour		itr_traversal,	(notes)
SE_Iterator	*	iterator_out_ptr	(notes)
);

Definition

Creates an iterator to (traverse over the list of)/(return pointers to) component objects that were inherited.

If you just want the inherited components of an object, then use this function call.

If you just want the directly aggregated components of an object, then use the SE_InitializeComponentIterator() function with the process_inheritance parameter set to SE_FALSE.

If you want both the inherited components and the directly aggregated components of an object (and don't care to distinguish between the two sets) then use the SE_InitializeComponentIterator() function with the process_inheritance parameter set to SE_TRUE.

Returns

SE_STAT_CODE_SUCCESS and a handle for the newly created inherited component iterator is copied into *iterator_out_ptr, if valid parameters were passed in and all operations succeeded.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *iterator_out_ptr is left unaltered, if iterator_out_ptr was NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and *iterator_out_ptr is set to NULL, if start_object is not a handle to a valid, active (i.e., unfreed) SEDRIS object.

SE_STAT_CODE_UNRESOLVED_START_OBJECT and *iterator_out_ptr is set to NULL, start_object is currently unresolved (see SE_Object's comments for details on how this condition occurs).

SE_STAT_CODE_OUT_OF_MEMORY and *iterator_out_ptr is set to NULL, if memory allocation failed.

SE_STAT_CODE_FAILURE and *iterator_out_ptr is set to NULL, if

itr_traversal is invalid,

a search filter is provided, but is not a handle to a valid, active (i.e., unfreed) search filter,

the start_object and search filter came from different API implementations, or

the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

start_object

 object whose list of inherited components will be returned.

filter

 a search filter that will be used to filter
    the output of this iterator.

directly_attach_table_components

 see comments in
    SE_InitializeComponentIterator().

itr_traversal

 see comments in
    SE_InitializeComponentIterator().

iterator_out_ptr

 a pointer to the freshly created iterator that will
    iterate over the inherited components of the start_object.  If a
    search filter was provided, then only the inherited components that
    pass that search filter will be included in the list.

SE_STAT_CODE_SUCCESS	and a handle for the newly created inherited component iterator is copied into *iterator_out_ptr, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *iterator_out_ptr is left unaltered, if iterator_out_ptr was NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and *iterator_out_ptr is set to NULL, if start_object is not a handle to a valid, active (i.e., unfreed) SEDRIS object.
SE_STAT_CODE_UNRESOLVED_START_OBJECT	and *iterator_out_ptr is set to NULL, start_object is currently unresolved (see SE_Object's comments for details on how this condition occurs).
SE_STAT_CODE_OUT_OF_MEMORY	and *iterator_out_ptr is set to NULL, if memory allocation failed.
SE_STAT_CODE_FAILURE	and *iterator_out_ptr is set to NULL, if itr_traversal is invalid, a search filter is provided, but is not a handle to a valid, active (i.e., unfreed) search filter, the start_object and search filter came from different API implementations, or the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.