SE GetPublishedLabels

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE GetPublishedLabels

Given an SE_Object, return labels under which the object was published.

SE_STAT_CODE_SUCCESS and the output parameters are set appropriately, if valid parameters were passed in and all operations succeeded.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and the output parameter values are left unaltered, if either label_array_out_ptr or label_count_out_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and *label_out_ptr is set to NULL and *label_count_out_ptr is set to zero (0), if object_in is not a handle to a valid SEDRIS object.

SE_STAT_CODE_INVALID_OR_NULL_STORE and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if store_in is not a handle to a valid SE_Store created by SE_CreateStore().

SE_STAT_CODE_UNRESOLVED_OBJECT and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if object_in is not a resolved object.

SE_STAT_CODE_UNPUBLISHED_OBJECT and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if object_in is not a published object.

SE_STAT_CODE_FAILURE and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

 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.

SE_STAT_CODE_SUCCESS	and the output parameters are set appropriately, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and the output parameter values are left unaltered, if either label_array_out_ptr or label_count_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and label_out_ptr is set to NULL and label_count_out_ptr is set to zero (0), if object_in is not a handle to a valid SEDRIS object.
SE_STAT_CODE_INVALID_OR_NULL_STORE	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if store_in is not a handle to a valid SE_Store created by SE_CreateStore().
SE_STAT_CODE_UNRESOLVED_OBJECT	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if object_in is not a resolved object.
SE_STAT_CODE_UNPUBLISHED_OBJECT	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if object_in is not a published object.
SE_STAT_CODE_FAILURE	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.