pdcomm_gem_result_formatted_program_capability_info

Function

Reads the summary of a capability result.

PdcommStatus pdcomm_gem_result_formatted_program_capability_info(const PdcommGemResult *result, PdcommGemFormattedProgramCapabilityInfo *info)

Declared in: #include <pdcomm_gem_formatted_program_capabilities.h>

Works for host data results and for equipment received-request results. A received request holds no capability until it is answered, so its command and size fields are 0 before pdcomm_gem_formatted_program_capability_respond() succeeds.

Parameters

Name	Description
result	GEM result.
info	Caller storage with struct_size set. When the size is sufficient, the known fields are zeroed (with struct_size set) before result is examined; bytes beyond the known layout are not touched.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when info is NULL, info->struct_size is too small, or result is NULL; #PDCOMM_INVALID_STATE when result is not a capability result.