|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE GetTransmittalFromObject |
|---|
| extern SE_Return_Code | |||
| SE_GetTransmittalFromObject | |||
| ( | |||
| SE_Object | object_in, | (notes) | |
| SE_Transmittal | * | transmittal_out_ptr | (notes) |
| ); | |||
Given an SE_Object, retrieve a handle to the transmittal in which the object is contained.
NOTE: The user is responsible for calling SE_FreeTransmittal() in order to release the memory associated with * transmittal_out_ptr when he or she is finished with it.
| SE_RET_CODE_SUCCESS | and the transmittal handle 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_INPUT_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 the transmittal is being queried.
a pointer to an SE_Transmittal variable, provided
by the user. A handle to the transmittal containing the object
corresponding to id will be copied into *transmittal_out_ptr
by this function.
Prev: SE_GetTransmittalFile.
Next: SE_GetTransmittalName.
Up:Index.
|