SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE GetNumberOfPathsToTransmittalRoot
extern SE_Return_Code
SE_GetNumberOfPathsToTransmittalRoot
(
SE_Object object,1
SE_Integer_Unsigned *number_of_paths2
);

Definition

This function determines how many different paths can be traversed from the <Transmittal Root> instance to the given DRM object, where a path is defined as a bidirectional aggregate to component relationship.

If object, or any of the objects between it and its <Transmittal Root> instnce, are referenced as a component from another transmittal and that transmittal is open, the paths counted are those to the other transmittal's <Transmittal Root> instance. Otherwise, the paths are to the <Transmittal Root> instance within object's own transmittal.


Returns

SE_RETCOD_SUCCESS and the requested number of paths is 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 and call was successful.

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 the call fails for any other reason.

Parameters Notes

1 a DRM object.

2 a pointer to an SE_Integer_Unsigned variable in the user's memory space where the number of paths will be stored.


Prev: SE_GetNthComponent. Next: SE_GetObjectFromIDString. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS