Function Name: Has Aggregates

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_SUCCESS - and *result_out_ptr is set to the appropriate value, if valid parameters were passed in and all operations succeeded.

SE_NULL_REQUIRED_PARAMETER - and *result_out_ptr is left unaltered, if result_out_ptr was NULL.

SE_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_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_FAILURE - and *result_out_ptr is set to SE_FALSE, if

  1. drm_class holds an invalid value,
  2. inter_transmittal_referencing_traversal holds an invalid value,
  3. 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_HasAggregates
(
SE_OBJECT object_in, (notes)
SE_TOKEN_ENUM drm_class, (notes)
SE_ITR_TRAVERSAL_ENUM inter_transmittal_referencing_traversal, (notes)
SE_BOOLEAN *result_out_ptr (notes)
);

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_NULL_TOKEN, then any aggregate will do.

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

Prev: Get User Data. Next: Has Associations. Up:Index.