Skip to content
Start free evaluation

pdcomm_gem_formatted_program_execution_snapshot_command_info

Function

Reads the parameter count and code format of one program command.

PdcommStatus pdcomm_gem_formatted_program_execution_snapshot_command_info(const PdcommGemFormattedProgramExecutionSnapshotHandle *snapshot, size_t command_index, size_t *parameter_count, uint8_t *code_format)

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

Parameters

NameDescription
snapshotLive snapshot handle.
command_indexZero-based command index, less than PdcommGemFormattedProgramExecutionInfo::command_count.
parameter_countReceives the number of parameters; set to 0 first.
code_formatReceives the SECS-II format code of the command code (#PDCOMM_SECS_ASCII, #PDCOMM_SECS_U1, #PDCOMM_SECS_U2, #PDCOMM_SECS_U4, or #PDCOMM_SECS_U8); set to 0 first.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when an output or snapshot is NULL; #PDCOMM_INVALID_STATE when the snapshot is in the EMPTY state; #PDCOMM_OUT_OF_RANGE when command_index is too large.