SE GetPublishedObjectList

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

extern SE_Status_Code
SE_GetPublishedObjectList
(
SE_Transmittal			transmittal_in,	(notes)
SE_Store			store_in,	(notes)
SE_Object	*	*	published_object_array_ptr,	(notes)
SE_Integer_Unsigned		*	published_obj_count_out_ptr	(notes)
);

Definition

Given a handle to a transmittal, returns an array of objects published by that transmittal for possible reference using ITR.

Returns

SE_STAT_CODE_SUCCESS if valid parameters were passed in and the published object array was successfully returned.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and the output parameters are left unchanged, if published_object_array_ptr or published_obj_count_out_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL and *published_object_array_ptr is set to NULL, and *published_obj_count_out_ptr is set to 0 (zero), if transmittal_in is not a handle to a valid transmittal.

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

SE_STAT_CODE_OUT_OF_MEMORY and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL, if dynamic memory allocation failed.

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

Parameters Notes

transmittal_in

 a handle to the transmittal for which the list shall be
    returned.

store_in

 the store within which the array of SE_Objects should be
    allocated for storing the returned list.

published_object_array_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 transmittal.

published_obj_count_out_ptr

 a pointer to SE_Integer_Unsigned variable from the
    caller into which the number of published objects is stored.  This
    number is the length of the array of SE_Objects returned in the
    published_object_array_ptr parameter.

SE_STAT_CODE_SUCCESS	if valid parameters were passed in and the published object array was successfully returned.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and the output parameters are left unchanged, if published_object_array_ptr or published_obj_count_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL	and published_object_array_ptr is set to NULL, and published_obj_count_out_ptr is set to 0 (zero), if transmittal_in is not a handle to a valid transmittal.
SE_STAT_CODE_INVALID_OR_NULL_STORE	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL, if store_in is not a handle to a valid SE_Store created by SE_CreateStore().
SE_STAT_CODE_OUT_OF_MEMORY	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL, if dynamic memory allocation failed.
SE_STAT_CODE_FAILURE	and the output parameters are set as for SE_STAT_CODE_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.