SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE GetRelationCounts
extern SE_Return_Code
SE_GetRelationCounts
(
SE_Object object,1
SE_ITR_Behaviour itr_traversal,2
SE_Integer_Unsigned *component_count,3
SE_Integer_Unsigned *aggregate_count,4
SE_Integer_Unsigned *associate_count5
);

Definition

Given the DRM object specified by object, this function returns the counts of

  1. the number of components (in component_count),
  2. the number of aggregates (in aggregate_count), and
  3. the number of associates (in associate_count)
that the specified DRM object has.


Returns

SE_RETCOD_SUCCESS and the requested counts are returned.
SE_RETCOD_FAILURE and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS set if valid parameters were passed in.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_UNRESOLVED_INPUT_OBJECT set if object is unresolved.
SE_STATCODE_INACTIONABLE_FAILURE set if the call fails for any other reason.

Parameters Notes

1 the object for which the counts are being retrieved.

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

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

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

5 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 26, 2006 Copyright © 2006 SEDRIS™