SE HasAggregates

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

extern SE_Status_Code
SE_HasAggregates
(
SE_Object		object_in,	(notes)
SE_DRM_Class		drm_class,	(notes)
SE_ITR_Behaviour		itr_traversal,	(notes)
SE_Boolean	*	result_out_ptr	(notes)
);

Definition

Determines whether an object has aggregates that it can reach via a 2-way aggregation.

This function follows the same searching rules as SE_GetAggregate().

Returns

SE_STAT_CODE_SUCCESS and *result_out_ptr is set appropriately, if valid parameters were passed in and all operations succeeded.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *result_out_ptr is left unaltered, if result_out_ptr was NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and *result_out_ptr is set to SE_FALSE, if object_in is not a handle to a valid, active (i.e., unfreed) SEDRIS object.

SE_STAT_CODE_UNRESOLVED_START_OBJECT and *result_out_ptr is set to SE_FALSE, if object_in is currently unresolved (see SE_Object's comments for details on how this condition occurs).

SE_STAT_CODE_FAILURE and *result_out_ptr is set to SE_FALSE, if

drm_class holds an invalid value,

itr_traversal holds an invalid value,

the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

object_in

 the SEDRIS object for which the user wants to know whether
    aggregates exist.

drm_class

 the DRM class of aggregate object the user is
    looking for.  If this is SE_DRM_CLS_NULL, then any aggregate will do.

itr_traversal

 the user must choose how
    the function will behave when it encounters an Inter-Transmittal
    Reference (ITR). The function could automatically resolve such
    references and continue the search within the new transmittal;
    report all ITR references without resolving them; or just ignore
    them completely and continue to search within the current
    transmittal.

result_out_ptr

 a pointer to the variable in the user's memory space
    where the answer will be stored.

SE_STAT_CODE_SUCCESS	and *result_out_ptr is set appropriately, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *result_out_ptr is left unaltered, if result_out_ptr was NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and *result_out_ptr is set to SE_FALSE, if object_in is not a handle to a valid, active (i.e., unfreed) SEDRIS object.
SE_STAT_CODE_UNRESOLVED_START_OBJECT	and *result_out_ptr is set to SE_FALSE, if object_in is currently unresolved (see SE_Object's comments for details on how this condition occurs).
SE_STAT_CODE_FAILURE	and *result_out_ptr is set to SE_FALSE, if drm_class holds an invalid value, itr_traversal holds an invalid value, the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.