pdcomm_gem_result_directory_at

Function

Reads the ID and VID count of one entry of a validated S1F22 or S1F24 reply.

PdcommStatus pdcomm_gem_result_directory_at(const PdcommGemResult *result, size_t index, PdcommGemDirectoryEntryInfo *info)

Declared in: #include <pdcomm_gem_directories.h>

PdcommGemResultInfo::entry_count gives the number of entries. variable_count is 0 for data variable entries.

Parameters

Name	Description
result	Result with outcome #PDCOMM_GEM_DATA_DIRECTORY_RECEIVED or #PDCOMM_GEM_EVENT_DIRECTORY_RECEIVED.
index	Zero-based entry 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 result is NULL; #PDCOMM_INVALID_STATE when result is an invalid, failed, or unrelated result; #PDCOMM_OUT_OF_RANGE when index is not less than the entry count; #PDCOMM_INVALID_DATA or #PDCOMM_INTERNAL_ERROR.