|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE GetReferencedTransmittalList |
|---|
| extern SE_Return_Code | ||||
| SE_GetReferencedTransmittalList | ||||
| ( | ||||
| SE_Transmittal | transmittal, | 1 | ||
| SE_Store | store, | 2 | ||
| SE_Integer_Unsigned | * | transmittal_name_count, | 3 | |
| SE_URN | * | * | transmittal_name_list | 4 |
| ); | ||||
Given the transmittal specified by transmittal, this function returns in the output parameters the list of other transmittals that are referenced by this transmittal. The names returned are formal transmittal names used to create the ITR references. If this transmittal contains no ITR references, an empty list is returned. The number of transmittal names being returned in transmittal_name_list is returned in transmittal_name_count.
| SE_RETCOD_SUCCESS | and the referenced transmittal list is returned. |
| SE_RETCOD_FAILURE | and the status code is set appropriately if the call failed. |
SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:
| SE_STATCODE_SUCCESS | set if valid parameters were passed in and all operations succeeded. |
SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:
| SE_STATCODE_C_STORE_INVALID | set if store is not a handle to a valid SE_Store. |
| SE_STATCODE_INACTIONABLE_FAILURE | set if the call fails for any other reason. |
1 the SE_Transmittal for which referenced transmittal list should be returned.
2 the store within which the array of strings should be allocated for storing the returned list.
3 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 parameter.
4 a pointer to an array of SE_URNs. Upon success, this parameter will be set to point to the array of SE_URNs that hold the names of the referenced transmittals.
Prev: SE_GetPublishedObjectList.
Next: SE_GetRelationCounts.
Up:Index.
|