|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE GetObjectIDString |
|---|
| extern SE_Return_Code | |||||
| SE_GetObjectIDString | |||||
| ( | |||||
| SE_Object | object_in, | (notes) | |||
| SE_Store | store_in, | (notes) | |||
| const | char | * | * | id_string | (notes) |
| ); | |||||
Given an object, provides an id string managed by the store passed in which is 1) unique within the transmittal the object resides in and 2) the same over separate SE_Open and SE_Close sessions.
| SE_RET_CODE_SUCCESS | and the requested id string is returned. |
| 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_OUTPUT_OBJECT | set if object_in is unresolved. |
| SE_STAT_CODE_INACTIONABLE_FAILURE | set if the call fails for any other reason. |
the object for which an id string is requested.
the store that will manage the string memory
pointer to the id string
Prev: SE_GetObjectFromIDString.
Next: SE_GetObjectReferenceCount.
Up:Index.
|