Function Name: Get Relation Counts

Definition

Given an object, returns the counts for the number of components, number of aggregates, and number of associates that the object has.

Returns

SE_SUCCESS - if valid parameters were passed in. In this case, the output parameters provided by the user are set to the appropriate values.

SE_NULL_REQUIRED_PARAMETER - and the output parameter values are left unaltered, if all three output parameters were NULL.

SE_INVALID_OR_NULL_OBJECT - and the output parameter values are set to zero (0), if object_in is not a handle to a valid, active (i.e., not freed) SEDRIS object.

SE_UNRESOLVED_START_OBJECT - and the output parameters are set as for the SE_INVALID_OR_NULL_OBJECT case, if object_in is unresolved.

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_GetRelationCounts
(
SE_OBJECT object_in, (notes)
SE_UINT32 *num_comp_out_ptr, (notes)
SE_UINT32 *num_agg_out_ptr, (notes)
SE_UINT32 *num_assoc_out_ptr (notes)
);

Parameters Notes

object_in

 the object for which the counts are being retrieved.

num_comp_out_ptr

 a pointer to an SE_UINT32 variable in the
    user's memory space where the component count will be stored.

num_agg_out_ptr

 a pointer to an SE_UINT32 variable in the
    user's memory space where the aggregate count will be stored.

num_assoc_out_ptr

 a pointer to an SE_UINT32 variable
    in the user's memory space where the associate count will be stored.
Prev: Get Referenced Transmittal List. Next: Get Remaining Objects List. Up:Index.