pdcomm_gem_result_alarm_info

Function

Reads the summary of a validated Host alarm report or alarm list result.

PdcommStatus pdcomm_gem_result_alarm_info(const PdcommGemResult *result, PdcommGemAlarmResultInfo *info)

Declared in: #include <pdcomm_gem_alarms.h>

A report has count 1, is_report 1, and its original W bit in reply_expected. A list reply has is_report, reply_expected, and acknowledged all 0.

Parameters

Name	Description
`result`	Result with outcome #PDCOMM_GEM_ALARM_RECEIVED, #PDCOMM_GEM_ALARM_LIST_RECEIVED, or #PDCOMM_GEM_ENABLED_ALARM_LIST_RECEIVED.
`info`	Caller storage; set `info->struct_size` before the call. Written only on success.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when result or info is NULL or info->struct_size is too small; #PDCOMM_INVALID_STATE when result is not an alarm result; #PDCOMM_INTERNAL_ERROR when a panic was contained.

Notes

Results and items stay readable after the endpoint is destroyed.