pdcomm_gem_formatted_program_execution_action_parameter_get

Function

Copies one parameter of a Step action's command as a SECS-II item.

PdcommStatus pdcomm_gem_formatted_program_execution_action_parameter_get(const PdcommGemFormattedProgramExecutionActionHandle *action, size_t parameter_index, PdcommSecsItem **out_item)

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

Parameters

Name	Description
action	Live action handle.
parameter_index	Zero-based parameter index, less than PdcommGemFormattedProgramExecutionActionInfo::parameter_count.
out_item	Receives the new item; set to NULL first.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when out_item or action is NULL; #PDCOMM_INVALID_STATE when action is not a Step action; #PDCOMM_OUT_OF_RANGE when parameter_index is too large; #PDCOMM_ALLOCATION_FAILED.

Notes

• Ownership: release the item with pdcomm_secs_destroy().