Function Name: Get Transmittal From ID

Definition

Given an SE_OBJECT_ID, retrieves a handle to the transmittal in which the corresponding 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_SUCCESS - if valid parameters were passed in. In this case, a handle to the transmittal containing id's object is placed in *transmittal_out_ptr.

SE_NULL_REQUIRED_PARAMETER - and *transmittal_out_ptr is left unaltered, if transmittal_out_ptr is NULL.

SE_INVALID_OR_NULL_OBJECT - and *transmittal_out_ptr is set to NULL, if the id is not a handle to a valid, active (i.e., unfreed) object ID.

SE_OUT_OF_MEMORY - and *transmittal_out_ptr is set to NULL, if *transmittal_out_ptr cannot be allocated.

SE_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.

Prototype


extern SE_STATUS_CODE_ENUM
SE_GetTransmittalFromID
(
SE_OBJECT_ID id, (notes)
SE_TRANSMITTAL *transmittal_out_ptr (notes)
);

Parameters Notes

id

 an SE_OBJECT_ID.

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.
Prev: Get Transmittal File. Next: Get Transmittal From Object. Up:Index.