Skip to content
Start free evaluation

pdcomm_gem_formatted_program_execution_snapshot_parameter_get

Function

Copies one parameter of one program command as a SECS-II item.

PdcommStatus pdcomm_gem_formatted_program_execution_snapshot_parameter_get(const PdcommGemFormattedProgramExecutionSnapshotHandle *snapshot, size_t command_index, size_t parameter_index, PdcommSecsItem **out_item)

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

Parameters

NameDescription
snapshotLive snapshot handle.
command_indexZero-based command index.
parameter_indexZero-based parameter index.
out_itemReceives the new item; set to NULL first.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when out_item or snapshot is NULL; #PDCOMM_INVALID_STATE when the snapshot is in the EMPTY state; #PDCOMM_OUT_OF_RANGE when an index is too large; #PDCOMM_LIMIT_EXCEEDED or #PDCOMM_ALLOCATION_FAILED.

Notes

  • Ownership: release the item with pdcomm_secs_destroy().