Skip to content
Start free evaluation

pdcomm_gem_result_formatted_program_transfer_command_info

Function

Reads the parameter count and CCODE format of one received command.

PdcommStatus pdcomm_gem_result_formatted_program_transfer_command_info(const PdcommGemResult *result, size_t index, size_t *parameter_count, uint8_t *code_format)

Declared in: #include <pdcomm_gem_formatted_program_transfers.h>

Parameters

NameDescription
resultResult that carries a received program.
indexZero-based command index, less than command_count.
parameter_countReceives the number of PPARM items; set to 0 first.
code_formatReceives the CCODE format: #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 a pointer is NULL; #PDCOMM_INVALID_STATE when the result carries no received program; #PDCOMM_OUT_OF_RANGE when index is out of range; #PDCOMM_INTERNAL_ERROR when a panic was contained.