 |
UNICENS V2.3.0-4567
User Manual and API Reference
|
| Ucs_Return_t Ucs_Network_GetNodesCount | ( | Ucs_Inst_t * | self, |
| uint8_t * | count_ptr | ||
| ) |
Retrieves the number of nodes within the network.
This attribute corresponds with the parameter MaxPosition of the INIC function INIC.NetworkStatus. |
- Parameters
-
self The instance count_ptr References the nodes count which is written if the function returns UCS_RET_SUCCESS.
Possible values:
- 0x01..0x40 (the number of nodes if the network is available)
- 0xFF (if the network is not available)
- 0x01..0x40 (the number of nodes if the network is available)
- Returns
- Possible return values are shown in the table below.
Value Description UCS_RET_SUCCESS No error UCS_RET_ERR_PARAM The parameter selfis NULL.UCS_RET_ERR_NOT_SUPPORTED API is not supported in the current Network Supervisor Mode. UCS_RET_ERR_NOT_INITIALIZED UNICENS is not initialized.