|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE GetPublishedLabels |
|---|
| extern SE_Return_Code | ||||||
| SE_GetPublishedLabels | ||||||
| ( | ||||||
| SE_Object | object_in, | (notes) | ||||
| SE_Store | store_in, | (notes) | ||||
| const | char | * | * | * | label_array_out_ptr, | (notes) |
| SE_Integer_Unsigned | * | label_count_out_ptr | (notes) | |||
| ); | ||||||
Given an SE_Object, return labels under which the object was published.
| SE_RET_CODE_SUCCESS | and the published labels are 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_UNRESOLVED_OUTPUT_OBJECT | set if object_in is not a resolved object. |
| SE_STAT_CODE_UNPUBLISHED_OBJECT | set if object_in is not a published object. |
| SE_STAT_CODE_INACTIONABLE_FAILURE | set if the call fails for any other reason. |
the SE_Object that is being queried.
the store within which the label list should be allocated.
a pointer to a pointer to a char* variable from the
caller into which the list of label strings will be stored.
a pointer to an SE_Integer_Unsigned into which the number of
labels is returned.
Prev: SE_GetPackedHierarchy.
Next: SE_GetPublishedObjectList.
Up:Index.
|