|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE GetReferencedTransmittalList |
|---|
| extern SE_Return_Code | ||||||
| SE_GetReferencedTransmittalList | ||||||
| ( | ||||||
| SE_Transmittal | transmittal_in, | (notes) | ||||
| SE_Store | store_in, | (notes) | ||||
| const | char | * | * | * | transmittal_name_list_out_ptr, | (notes) |
| SE_Integer_Unsigned | * | transmittal_name_count_out_ptr | (notes) | |||
| ); | ||||||
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.
| SE_RET_CODE_SUCCESS | and the referenced transmittal list 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_INACTIONABLE_FAILURE | set if the call fails for any reason. |
the SE_Transmittal for which referenced transmittal list
should be returned.
the store within which the array of strings should be allocated
for storing the returned list.
a pointer to a pointer to a char*.
Upon success, this parameter will be set to point to the array of
character arrays that hold the names of the referenced transmittals.
a pointer to an SE_Integer_Unsigned 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.
Prev: SE_GetPublishedObjectList.
Next: SE_GetRelationCounts.
Up:Index.
|