|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE GetObjectFromIDString |
|---|
| extern SE_Return_Code | ||||
| SE_GetObjectFromIDString | ||||
| ( | ||||
| SE_Transmittal | transmittal, | (notes) | ||
| const | char | * | id_string, | (notes) |
| SE_Object | * | object_out_ptr | (notes) | |
| ); | ||||
Given an id string and a transmittal handle, will return the object in the transmittal corresponding to the id string.
| SE_RET_CODE_SUCCESS | and the requested object 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 an id string was passed in and all operations succeeded. |
SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:
| SE_STAT_CODE_DELETED_OBJECT | set if the object corresponding to id_string has been removed from the transmittal. |
| SE_STAT_CODE_INACTIONABLE_FAILURE | set if the call fails for any other reason. |
the transmittal to which the object belongs.
the string corresponding to the object being retrieved
pointer to the SE_Object corresponding to id_string
Prev: SE_GetNumberOfPathsToTransmittalRoot.
Next: SE_GetObjectIDString.
Up:Index.
|