|
SEDRIS Reference Manual
APPENDIX A - LEVEL 0 READ and WRITE API Functions SE GetNumberOfPathsToTransmittalRoot |
|---|
| extern SE_Status_Code | |||
| SE_GetNumberOfPathsToTransmittalRoot | |||
| ( | |||
| SE_Object | object_in, | (notes) | |
| SE_Integer_Unsigned | * | number_of_paths_out_ptr | (notes) |
| ); | |||
Determines how many different paths can be traversed from the <Transmittal Root> to the given object, where a path is defined as a bidirectional aggregate to component relationship.
If object_in, or any of the objects between it and its <Transmittal Root>, are referenced as a component from another transmittal and that transmittal is open, then the paths counted are those to the other transmittal's <Transmittal Root>. Otherwise, the paths are to the <Transmittal Root> within object_in's own transmittal.0
| SE_STAT_CODE_SUCCESS | and *number_of_paths_out_ptr is set appropriately, if valid parameters were passed in. |
| SE_STAT_CODE_NULL_REQUIRED_PARAMETER | and *number_of_paths_out_ptr is set to zero (0), if number_of_paths_out_ptr is NULL. |
| SE_STAT_CODE_INVALID_OR_NULL_OBJECT | and *number_of_paths_out_ptr is set to zero (0), if object_in is not a handle to a valid SEDRIS object. |
| SE_STAT_CODE_UNRESOLVED_START_OBJECT | and *number_of_paths_out_ptr is set to zero (0), if object_in is unresolved. |
| SE_STAT_CODE_FAILURE | and *number_of_paths_out_ptr is set to 0, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time. |
a SEDRIS object.
a pointer to an SE_Integer_Unsigned variable
in the user's memory space where the number of paths will be stored.
Prev: SE_GetNthComponentOfDRMClass.
Next: SE_GetObjectForID.
Up:Index.
|