|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE GetPublishedObjectList |
|---|
| extern SE_Return_Code | ||||
| SE_GetPublishedObjectList | ||||
| ( | ||||
| SE_Transmittal | transmittal, | 1 | ||
| SE_Store | store, | 2 | ||
| SE_Integer_Unsigned | * | published_object_count, | 3 | |
| SE_Object | * | * | published_object_list | 4 |
| ); | ||||
Given a handle to a transmittal, returns an array of objects published by that transmittal for possible reference using ITR.
| SE_RETCOD_SUCCESS | and the published object 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 the published object array was successfully returned. |
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 a handle to the transmittal for which the list shall be returned.
2 the store within which the array of SE_Objects should be allocated for storing the returned list.
3 a pointer to SE_Integer_Unsigned variable from the caller into which the number of published objects is stored. This number is the length of the array of SE_Objects returned in the published_object_list parameter.
4 a pointer to a pointer to an SE_Object handle. The parameter is set to point to an array of SE_Object handles of objects published by the transmittal. This parameter is set to NULL if there are no published objects in the transmittal.
Prev: SE_GetPublishedLabels.
Next: SE_GetReferencedTransmittalList.
Up:Index.
|