Function Name: Get Published Object List

Definition

Given an SE_TRANSMITTAL, returns a list of objects published by that transmittal for possible reference using ITR.

Returns

SE_SUCCESS - if valid parameters were passed in and the published object list was successfully returned.

SE_NULL_REQUIRED_PARAMETER - if published_object_list_ptr or num_published_obj_out_ptr is NULL. In this case, *published_object_list_ptr and *num_published_obj_out_ptr are left unaltered.

SE_INVALID_OR_NULL_TRANSMITTAL - if transmittal_in is NULL. In this case, *published_object_list_ptr is set to NULL, and *num_published_obj_out_ptr is set to 0 (zero).

SE_INVALID_OR_NULL_STORE if store_in is not a handle to a valid SE_STORE created by SE_CreateStore(). In this case, the output parameters are set as for SE_INVALID_OR_NULL_TRANSMITTAL.

SE_OUT_OF_MEMORY - if the API could not allocate the memory for the list or any dynamically allocate memory it should refer to. In this case, the output parameters are set as for SE_INVALID_OR_NULL_TRANSMITTAL.

SE_FAILURE - and the output parameters are set as for SE_INVALID_OR_NULL_TRANSMITTAL, 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_GetPublishedObjectList
(
SE_TRANSMITTAL transmittal_in, (notes)
SE_STORE store_in, (notes)
SE_OBJECT **published_object_list_ptr, (notes)
SE_UINT32 *num_published_obj_out_ptr (notes)
);

Parameters Notes

transmittal_in

 the SE_TRANSMITTAL for which the list should be returned.

store_in

 the store within which the array of SE_OBJECT's should be
    allocated for storing the returned list.

published_object_list_ptr

 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 transtmittal.

num_published_obj_out_ptr

 a pointer to SE_UINT32 variable from the
    caller into which the number of published objects is stored.  This
    number is the length of the array of SE_OBJECT's returned in the
    published_object_list_ptr parameter.

Prev: Get Published Labels. Next: Get Reference Symbol. Up:Index.