SE InitializeInheritedComponentIterator

SEDRIS Reference Manual APPENDIX A - Transmittal Access Level 0 API Functions SE InitializeInheritedComponentIterator

extern SE_Return_Code
SE_InitializeInheritedComponentIterator
(
SE_Object		start_object,	¹
SE_Search_Filter		filter,	²
SE_Boolean		directly_attach_table_components,	³
SE_ITR_Behaviour		itr_traversal,	⁴
SE_Iterator	*	iterator_out_ptr	⁵
);

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_RETCOD_SUCCESS	and the iterator is initialized.
SE_RETCOD_FAILURE	and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS

set if valid parameters were passed in and all operations succeeded.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_UNRESOLVED_INPUT_OBJECT	set if start_object is currently unresolved (see SE_ObjectSE_Object's comments for details on how this condition occurs).
SE_STATCODE_C_ENUMERATION_VALUE_INVALID	set if itr_traversal is not a valid value.
SE_STATCODE_INACTIONABLE_FAILURE	set if 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 call fails for any other reason

Parameters Notes

¹ object whose list of inherited components will be returned.

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

³ see comments in SE_InitializeComponentIterator().

⁴ see comments in SE_InitializeComponentIterator().

⁵ 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.