SEDRIS Reference Manual
APPENDIX B - LEVEL 1 READ and WRITE API
Functions
SE ModelNameFromFMI
extern SE_Status_Code
SE_ModelNameFromFMI
(
SE_Object object_in, (notes)
SE_Store store_in, (notes)
constSE_String **result_out_ptr (notes)
);

Definition

Given a <Feature Model Instance>, retrieves the name of the <Model> that contains the <Feature Model> being instanced.


Returns

SE_STAT_CODE_SUCCESS and the output parameters are set appropriately, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER and no changes were made, if result_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT and result_out_ptr is set to NULL, if object_in is not a handle to a valid, active (i.e., unfreed) <Feature Model Instance>.
SE_STAT_CODE_INVALID_OR_NULL_STORE and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if store_in is not a handle to a valid, active (i.e., unfreed) store.
SE_STAT_CODE_UNRESOLVED_START_OBJECT and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if object_in is unresolved.
SE_STAT_CODE_NO_OBJECT and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if
  1. object_in isn't associated to a <Feature Model> instance, or
  2. the <Feature Model> isn't a component of a <Model> instance.
SE_STAT_CODE_UNRESOLVED_OBJECT and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if any unresolved intermediate object encountered that cannot be resolved.
SE_STAT_CODE_OUT_OF_MEMORY and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if memory allocation fails.
SE_STAT_CODE_FAILURE and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if the fields of the <Model> cannot be retrieved.


Parameters Notes


object_in

 <Feature Model Instance> whose <Model> we're identifying

store_in

 store to manage the memory being retrieved

result_out_ptr

 pointer to a handle to the name being retrieved


Prev: SE_ImageNameFromImageMappingFunction. Next: SE_ModelNameFromGMI. Up:Index.

Last updated: May 15, 2003 Copyright © 2003 SEDRIS™