|
SEDRIS Reference Manual
APPENDIX B - Transmittal Access Level 1 API Functions SE SimpleCreateComponentIterator |
|---|
| extern SE_Status_Code | |||
| SE_SimpleCreateComponentIterator | |||
| ( | |||
| SE_Object | start_object, | 1 | |
| SE_DRM_Class | drm_class, | 2 | |
| SE_ITR_Behaviour | itr_traversal, | 3 | |
| SE_Iterator | * | iterator_out_ptr | 4 |
| ); | |||
Creates a simplified component iterator that retrieves component objects meeting the user-specified conditions. This iterator starts at start_object, the 'root' or 'top' of an 'aggregation tree'. All components below the start_object will be searched to a depth of 1. The iterator returns all components that match the DRM class specified by 'drm_class'.
If 'drm_class' is SE_CLS_DRM_NULL, then the iterator returns all components, regardless of DRM class.
Inherited components will not be inherited, locations will not be transformed, model instances will not be followed, static control links will not be evaluated. Breadth-first traversal is used.
| SE_STATCODE_SUCCESS | and an SE_Iterator for the newly created component iterator is copied into *iterator_out_ptr, if valid parameters were passed in and all operations succeeded. |
| SE_STATCODE_UNRESOLVED_INPUT_OBJECT | and *iterator_out_ptr is set to NULL, if start_object is currently unresolved. |
| SE_STATCODE_INACTIONABLE_FAILURE |
and *iterator_out_ptr is set
to NULL, if
|
1 the object whose components will be traversed.
2 specifies the DRM class of component being searched for; if SE_CLS_DRM_NULL, all DRM classes are returned
3 the user must choose how the function will behave when it encounters an Inter-Transmittal Reference (ITR).
4 a pointer to the freshly created component iterator that will iterate over the objects meeting the conditions described above.
Prev: SE_SetErrorHandlers.
Next: SE_SoundNameFromSoundInstance.
Up:Index.
|