SE GetRelationCounts

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

extern SE_Status_Code
SE_GetRelationCounts
(
SE_Object		object_in,	(notes)
SE_Integer_Unsigned	*	comp_count_out_ptr,	(notes)
SE_Integer_Unsigned	*	comp_link_count_out_ptr,	(notes)
SE_Integer_Unsigned	*	agg_count_out_ptr,	(notes)
SE_Integer_Unsigned	*	agg_link_count_out_ptr,	(notes)
SE_Integer_Unsigned	*	assoc_count_out_ptr,	(notes)
SE_Integer_Unsigned	*	assoc_link_count_out_ptr	(notes)
);

Definition

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

Returns

SE_STAT_CODE_SUCCESS and the output parameters provided by the user are set to the appropriate values, if valid parameters were passed in.

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

SE_STAT_CODE_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_STAT_CODE_UNRESOLVED_START_OBJECT and the output parameters are set as for the SE_STAT_CODE_INVALID_OR_NULL_OBJECT case, if object_in is unresolved.

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

Parameters Notes

object_in

 the object for which the counts are being retrieved.

comp_count_out_ptr

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

comp_link_count_out_ptr

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

agg_count_out_ptr

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

agg_link_count_out_ptr

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

assoc_count_out_ptr

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

assoc_link_count_out_ptr

 a pointer to an SE_Integer_Unsigned
    variable in the user's memory space where the associate link count
    will be stored.

SE_STAT_CODE_SUCCESS	and the output parameters provided by the user are set to the appropriate values, if valid parameters were passed in.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and the output parameter values are left unaltered, if all three output parameters were NULL.
SE_STAT_CODE_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_STAT_CODE_UNRESOLVED_START_OBJECT	and the output parameters are set as for the SE_STAT_CODE_INVALID_OR_NULL_OBJECT case, if object_in is unresolved.
SE_STAT_CODE_FAILURE	and the output parameters are set as for SE_STAT_CODE_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.