pdcomm_gem_formatted_program_selection_snapshot_parameter_get

Function

Copies one PPARM of one selected command as a new SECS-II item.

PdcommStatus pdcomm_gem_formatted_program_selection_snapshot_parameter_get(const PdcommGemFormattedProgramSelectionSnapshot *snapshot, size_t command_index, size_t parameter_index, PdcommSecsItem **out_item)

Declared in: #include <pdcomm_gem_formatted_program_selections.h>

Parameters

Name	Description
snapshot	Live snapshot that contains a program.
command_index	Zero-based command index.
parameter_index	Zero-based parameter index.
out_item	Receives a copy of the parameter item. Set to NULL first when out_item is not NULL.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when snapshot or out_item is NULL; #PDCOMM_INVALID_STATE when the snapshot has no selected program; #PDCOMM_OUT_OF_RANGE when an index is out of range; #PDCOMM_ALLOCATION_FAILED when the item cannot be created; #PDCOMM_INTERNAL_ERROR when a panic was contained.

Notes

• Ownership: release the item with pdcomm_secs_destroy().