SE GetTransmittalFromObject

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE GetTransmittalFromObject

extern SE_Status_Code
SE_GetTransmittalFromObject
(
SE_Object		object_in,	(notes)
SE_Transmittal	*	transmittal_out_ptr	(notes)
);

Definition

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.

Returns

SE_STAT_CODE_SUCCESS and a handle to the SEDRIS transmittal containing object_in is copied into *transmittal_out_ptr, if valid parameters were passed in and all operations succeeded.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *transmittal_out_ptr is unaffected, if transmittal_out_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and *transmittal_out_ptr is set to NULL, if object_in is not a handle to a valid, active (i.e., unfreed) SEDRIS object from an open transmittal.

SE_STAT_CODE_UNRESOLVED_START_OBJECT and *transmittal_out_ptr is set to NULL, if object_in is unresolved.

SE_STAT_CODE_OUT_OF_MEMORY and *transmittal_out_ptr is set to NULL, if *transmittal_out_ptr could not be allocated.

SE_STAT_CODE_FAILURE and *transmittal_out_ptr is set to NULL, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

object_in

 the object for which the transmittal is being queried.

transmittal_out_ptr

 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.

SE_STAT_CODE_SUCCESS	and a handle to the SEDRIS transmittal containing object_in is copied into *transmittal_out_ptr, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *transmittal_out_ptr is unaffected, if transmittal_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and *transmittal_out_ptr is set to NULL, if object_in is not a handle to a valid, active (i.e., unfreed) SEDRIS object from an open transmittal.
SE_STAT_CODE_UNRESOLVED_START_OBJECT	and *transmittal_out_ptr is set to NULL, if object_in is unresolved.
SE_STAT_CODE_OUT_OF_MEMORY	and transmittal_out_ptr is set to NULL, if transmittal_out_ptr could not be allocated.
SE_STAT_CODE_FAILURE	and *transmittal_out_ptr is set to NULL, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.