pdcomm_gem_equipment_status_id_at
Function
Returns the ID of the status variable at a registration index.
PdcommStatus pdcomm_gem_equipment_status_id_at(PdcommTcpEndpoint *endpoint, size_t index, uint32_t *out_id)Iterate from 0 until #PDCOMM_OUT_OF_RANGE to list every registered ID; variable_count from pdcomm_gem_state() gives the count.
Parameters
| Name | Description |
|---|---|
endpoint | Live TCP endpoint with an equipment role. |
index | Zero-based registration index. |
out_id | Receives the ID; set to 0 first. Must not be NULL. |
Returns
#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when endpoint or out_id is NULL; #PDCOMM_OUT_OF_RANGE when index is not less than the number of registered variables; #PDCOMM_INVALID_STATE when the endpoint has no equipment role; #PDCOMM_BACKPRESSURE when a staged TCP event exists; #PDCOMM_POISONED when the endpoint is poisoned.