pdcomm_gem_equipment_directory_get
Function
Copies the name or the VIDs of one local event directory entry.
PdcommStatus pdcomm_gem_equipment_directory_get(PdcommTcpEndpoint *endpoint, uint32_t id, uint32_t field, PdcommSecsItem **out_item)#PDCOMM_GEM_DIRECTORY_NAME returns an owned ASCII item and #PDCOMM_GEM_DIRECTORY_VARIABLE_IDS an owned U4 array item. #PDCOMM_GEM_DIRECTORY_UNITS is invalid for event entries.
Parameters
| Name | Description |
|---|---|
endpoint | Equipment endpoint. |
id | CEID of the entry. |
field | #PDCOMM_GEM_DIRECTORY_NAME or #PDCOMM_GEM_DIRECTORY_VARIABLE_IDS. |
out_item | Receives the new item; set to NULL first. Must not be NULL. |
Returns
#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when endpoint or out_item is NULL or field is not accepted; #PDCOMM_OUT_OF_RANGE when id is not in the directory; #PDCOMM_INVALID_STATE when the endpoint is not an Equipment or has no directory; #PDCOMM_BACKPRESSURE, #PDCOMM_LIMIT_EXCEEDED, #PDCOMM_ALLOCATION_FAILED, or #PDCOMM_POISONED.
Notes
- Ownership: release the item with pdcomm_secs_destroy(). It survives reconfiguration.