pdcomm_gem_equipment_directory_at

Function

Reads one local event directory entry by position.

PdcommStatus pdcomm_gem_equipment_directory_at(PdcommTcpEndpoint *endpoint, size_t index, PdcommGemDirectoryEntryInfo *info)

Declared in: #include <pdcomm_gem_directories.h>

Entries are enumerated in definition order.

Parameters

Name	Description
endpoint	Equipment endpoint.
index	Zero-based position.
info	Caller storage; set info->struct_size first.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when info is NULL or too small, or endpoint is NULL; #PDCOMM_OUT_OF_RANGE when index is not less than the entry count; #PDCOMM_INVALID_STATE when the endpoint is not an Equipment or has no directory; #PDCOMM_BACKPRESSURE or #PDCOMM_POISONED.