SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE InitializeAggregateIterator |
---|
extern SE_Return_Code | |||
SE_InitializeAggregateIterator | |||
( | |||
SE_Object | start_object, | (notes) | |
SE_Search_Filter | filter, | (notes) | |
SE_ITR_Behaviour | itr_traversal, | (notes) | |
SE_Iterator | * | iterator_out_ptr | (notes) |
); |
Creates an iterator to (traverse over the list of)/(return pointers to)
aggregate objects that meet the following conditions:
To get the next object from an iterator, call SE_GetNextObject().
To find out the remaining length of an iterator (the number of objects remaining inside the iterator), call SE_GetIterationLengthRemaining().
When finished with an iterator, free it with a call to the SE_FreeIterator() function. Iterators can be freed at any time (they can be freed before all of their objects have been returned, that is, before their remaining length == 0, if the user so desires).
SE_RET_CODE_SUCCESS | and the iterator is initialized. |
SE_RET_CODE_FAILURE | and the status code is set appropriately if the call failed. |
SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:
SE_STAT_CODE_SUCCESS | set if valid parameters were passed in and all operations succeeded. |
SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:
SE_STAT_CODE_UNRESOLVED_INPUT_OBJECT | set if start_object is currently unresolved. |
SE_STAT_CODE_INACTIONABLE_FAILURE | set if
|
the component object for which the user wants a list of the aggregate objects that contain this component object.
a search filter that will be used to filter the output of this iterator.
the user must choose how the iterator will behave when it encounters an Inter-Transmittal Reference (ITR). The iterator could automatically resolve such references and continue the search within the new transmittal; report all ITR references without resolving them; or just ignore them completely and continue to search within the current transmittal.
a pointer to the freshly created iterator that will iterate over the aggregate objects that (1) contain the given component start_object via a 2-way aggregation and (2) pass the criteria defined in the search filter (if one was was provided).
Prev: SE_GetUserData.
Next: SE_InitializeAssociateIterator.
Up:Index.
|