SEDRIS Reference Manual
APPENDIX B - LEVEL 1 READ and WRITE API Functions SE ImageNameFromImageMappingFunction |
---|
extern SE_Status_Code | |||||
SE_ImageNameFromImageMappingFunction | |||||
( | |||||
SE_Object | object_in, | (notes) | |||
SE_Store | store_in, | (notes) | |||
const | SE_String | * | * | result_out_ptr | (notes) |
); |
Given an <Image Mapping Function> object, retrieve the name of the associated <Image> object.
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) <Image Mapping Function>. |
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 object_in isn't associated to an <Image> instance. |
SE_STAT_CODE_UNRESOLVED_OBJECT | and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if object_in's associated <Image> instance is unresolved and could not 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 cannot be allocated for an intermediate operation. |
SE_STAT_CODE_FAILURE | and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if the fields of the <Image> cannot be retrieved, or if the underlying API implementation does not provide one or more of the required level 0 functions for this function. |
<Image Mapping Function> whose <Image> we're identifying
store to manage the memory being retrieved
pointer to a handle to the name being retrieved
Prev: SE_GetSizeOfPackedDataTableData.
Next: SE_ModelNameFromFMI.
Up:Index.
|