|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE GetPublishedLabels |
|---|
| extern SE_Return_Code | ||||
| SE_GetPublishedLabels | ||||
| ( | ||||
| SE_Object | object, | 1 | ||
| SE_Store | store, | 2 | ||
| SE_Integer_Unsigned | * | label_count, | 3 | |
| SE_String | * | * | label_list | 4 |
| ); | ||||
Given an SE_Object, return labels under which the object was published.
| SE_RETCOD_SUCCESS | and the published labels are 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_UNRESOLVED_OUTPUT_OBJECT | set if object is not a resolved object. |
| SE_STATCODE_UNPUBLISHED_OBJECT | set if object is not a published object. |
| 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_Object that is being queried.
2 the store within which the label list should be allocated.
3 a pointer to an SE_Integer_Unsigned into which the number of labels is returned.
4 a pointer to an array of SE_String from the caller in which the list of label strings will be stored.
Prev: SE_GetPackedHierarchy.
Next: SE_GetPublishedObjectList.
Up:Index.
|