Function Name: Get Referenced Transmittal List

Definition

Given an SE_TRANSMITTAL, returns the list of other transmittals that are referenced by this transmittal via Inter-Transmittal Referencing (ITR). The names returned are formal SEDRIS transmittal names used to create the ITR references. If this transmittal contains no ITR references, then a NULL list is returned.

Returns

SE_NULL_REQUIRED_PARAMETER - and the output parameters are left unaltered, if transmittal_name_list_out_ptr or transmittal_list_length_out_ptr is NULL.

SE_INVALID_OR_NULL_TRANSMITTAL - and *transmittal_name_list_out_ptr is set to NULL and *transmittal_list_length_out_ptr is set to zero (0), if transmittal_in is not a handle to a valid, active (i.e., open and unfreed) SEDRIS transmittal.

SE_OUT_OF_MEMORY - and the output parameters are set as for the SE_INVALID_OR_NULL_TRANSMITTAL case, if the API could not allocate the memory for the list or any dynamically allocate memory it should refer to (e.g. character arrays).

SE_FAILURE - and the output parameters are set as for SE_INVALID_OR_NULL_TRANSMITTAL, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Prototype

Parameters Notes

transmittal_in

 the SE_TRANSMITTAL for which referenced transmittal list
    should be returned.

store_in

 the store within which the array of strings should be allocated
    for storing the returned list.

transmittal_name_list_out_ptr

 a pointer to a pointer to a char*.
     Upon success, this parameter will be set point to the array of
     character arrays that hold the names of the referenced transmittals.

transmittal_list_length_out_ptr

 a pointer to an SE_UINT32 variable from
    the caller into which the list length is stored.  The magnitude of the
    value returned is the same as the number of char* pointers returned
    via the transmittal_name_list_out_ptr parameter.