Function Name: Get Published Labels

Definition

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

Returns

SE_SUCCESS - if a valid, resolved and published object was passed in.

SE_NULL_REQUIRED_PARAMETER - and the output parameter values are left unaltered, if either label_list_out_ptr or num_labels_out_ptr is NULL.

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

SE_INVALID_OR_NULL_STORE - and the output parameters are set as for SE_INVALID_OR_NULL_OBJECT, if store_in is not a handle to a valid SE_STORE created by SE_CreateStore().

SE_UNRESOLVED_OBJECT - if object_in is not a resolved object. In this case, the output parameters are set as for SE_INVALID_OR_NULL_OBJECT.

SE_UNPUBLISHED_OBJECT - if object_in is not a published object. In this case, the output parameters are set as for SE_INVALID_OR_NULL_OBJECT.

SE_FAILURE - and the output parameters are set as for SE_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.

Prototype


extern SE_STATUS_CODE_ENUM
SE_GetPublishedLabels
(
SE_OBJECT object_in, (notes)
SE_STORE store_in, (notes)
char ***label_list_out_ptr, (notes)
SE_UINT32 *num_labels_out_ptr (notes)
);

Parameters Notes

object_in

 the SE_OBJECT that is being queried.

store_in

 the store within which the label list should be allocated.

label_list_out_ptr

 a pointer to a pointer to a char* variable from the
    caller into which the list of label strings will be stored.

num_labels_out_ptr

 a pointer to an SE_UINT32 into which the number of
     labels is returned.

Prev: Get Packed Hierarchy. Next: Get Published Object List. Up:Index.