|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE GetComponent |
|---|
| extern SE_Return_Code | |||
| SE_GetComponent | |||
| ( | |||
| SE_Object | aggregate_object, | 1 | |
| SE_DRM_Class | drm_class, | 2 | |
| SE_Boolean | directly_attach_table_components, | 3 | |
| SE_Boolean | process_inheritance, | 4 | |
| SE_ITR_Behaviour | itr_traversal, | 5 | |
| SE_Object | * | component_object, | 6 |
| SE_Object | * | link_object | 7 |
| ); | |||
Retrieves a component object of a specified DRM class or of any DRM class (if not specified with drm_class) for the given DRM object (aggregate_object). For example, if SE_GetComponent() is called with a <Vertex> instance then a handle to the <Location> component will be returned at *component_object.
| SE_RETCOD_SUCCESS | and the requested object is returned, if valid parameters were passed in and all operations succeeded. |
| SE_RETCOD_FAILURE | and the status code is set appropriately if the call failed. |
SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:
| SE_STATCODE_SUCCESS | set if valid parameters were passed in, only one object was found that satisfied the specified criteria, and no ITR references were involved. |
| SE_STATCODE_DIFFERENT_TRANSMITTAL | set if valid parameters were passed in, the user requested that the API automatically resolve inter-transmittal references (ITR), an ITR reference was encountered in searching for the component, and the iterator successfully resolved it and retrieved the component from the new, different transmittal. |
SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:
| SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT | set if valid parameters were passed in and only one object was found that satisfied the specified criteria, but the component object is unresolved. |
| SE_STATCODE_UNRESOLVED_INPUT_OBJECT | set if aggregate_object is unresolved. |
| SE_STATCODE_NO_OBJECT | set if no component of the desired DRM class could be found. |
| SE_STATCODE_C_ENUMERATION_VALUE_INVALID | set if drm_class or itr_traversal was not valid, |
| SE_STATCODE_INACTIONABLE_FAILURE | set if the call fails for any other reason. |
1 the object from which the user wants one component.
2 the type of component the user wants. This is a required parameter in this call. SE_CLS_DRM_NULL is not allowed. Asking for an object of an abstract type is allowed. In that case, the API will look for a concrete component that is a 'kind-of' (a subclass) of the given abstract type.
3 see SE_InitializeComponentIterator's comments on directly_attach_table_components.
4 if true, then inherited components will be considered as well as 'immediate' components. If SE_FALSE, then only 'immediate' components will be considered. For example, by setting this process_inheritance parameter to SE_TRUE, this allows a user to ask for the <Inline Colour> component of a <Polygon> without worrying about whether the <Inline Colour> component was an 'immediate' or 'inherited' component of the <Polygon>. An 'immediate' component will always take precedence over an 'inherited' component.
5 the user must choose how the function will behave when it encounters an Inter-Transmittal Reference (ITR). The function 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.
6 pointer to a variable in the user's memory space to which a handle the component will be copied, if there is a component.
7 if not NULL, then a handle to the link class object (a.k.a. association class object) traversed to reach the component will be copied to *link_object. If no link class object was attached to the link used to reach the component object, then *link_object will be set to NULL. If the user passes in NULL for link_object, then link class objects will be ignored (and *link_object will not be affected).
Prev: SE_GetColourModel.
Next: SE_GetContextTransformation.
Up:Index.
|