SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE GetRelationCounts
extern SE_Return_Code
SE_GetRelationCounts
(
SE_Object object_in, (notes)
SE_ITR_Behaviour itr_traversal, (notes)
SE_Integer_Unsigned *comp_count_out_ptr, (notes)
SE_Integer_Unsigned *agg_count_out_ptr, (notes)
SE_Integer_Unsigned *assoc_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_RET_CODE_SUCCESS and the requested counts are returned.
SE_RET_CODE_FAILUREand the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:

SE_STAT_CODE_SUCCESS set if valid parameters were passed in.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_UNRESOLVED_INPUT_OBJECT set if object_in is unresolved.
SE_STAT_CODE_INACTIONABLE_FAILURE set if the call fails for any other reason.


Parameters Notes


object_in

 the object for which the counts are being retrieved.

itr_traversal

 specifies how related objects through ITR are to be counted.
 ITR relationships will be counted if itr_traversal is to automaticallly
 resolve, not otherwise.

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.

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.

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.


Prev: SE_GetReferencedTransmittalList. Next: SE_GetRemainingObjectsList. Up:Index.

Last updated: July 16, 2004 Copyright © 2004 SEDRIS