|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE GetNumberOfPathsToTransmittalRoot |
|---|
| extern SE_Return_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_RET_CODE_SUCCESS | and the requested number of paths is returned. |
| SE_RET_CODE_FAILURE | and the status code is set appropriately if the call failed. |
SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:
| SE_STAT_CODE_SUCCESS | set if valid parameters were passed in and call was successful. |
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 the call fails for any other reason. |
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_GetNthComponent.
Next: SE_GetObjectFromIDString.
Up:Index.
|