PdcommGemCommandParameterDefinition

Struct

Definition of one remote command parameter (CPNAME and its CPVAL rules).

typedef struct PdcommGemCommandParameterDefinition { ... } PdcommGemCommandParameterDefinition

Declared in: #include <pdcomm_gem_commands.h>

Members

format

Field

Exact SECS-II format code required for the CPVAL item.

uint8_t format

Declared in: #include <pdcomm_gem_commands.h>

For S2F41 commands the allowed formats are Binary, Boolean, ASCII, I1, I2, I4, I8, U1, U2, U4, and U8. Enhanced commands (S2F49) allow every format except JIS-8.

format_present

Field

1 when format is enforced, otherwise 0.

uint8_t format_present

Declared in: #include <pdcomm_gem_commands.h>

max_count

Field

Largest allowed element count of the CPVAL item; must not be less than min_count.

size_t max_count

Declared in: #include <pdcomm_gem_commands.h>

maximum

Field

Inclusive upper bound for every integer element; read only when maximum_present is 1.

PdcommGemInt128 maximum

Declared in: #include <pdcomm_gem_commands.h>

maximum_present

Field

1 when maximum is enforced; requires an integer format.

uint8_t maximum_present

Declared in: #include <pdcomm_gem_commands.h>

min_count

Field

Smallest allowed element count of the CPVAL item (bytes for ASCII and Binary).

size_t min_count

Declared in: #include <pdcomm_gem_commands.h>

minimum

Field

Inclusive lower bound for every integer element; read only when minimum_present is 1.

PdcommGemInt128 minimum

Declared in: #include <pdcomm_gem_commands.h>

minimum_present

Field

1 when minimum is enforced; requires an integer format.

uint8_t minimum_present

Declared in: #include <pdcomm_gem_commands.h>

name

Field

CPNAME item (ASCII or integer scalar); borrowed for the call and must not be NULL.

const PdcommSecsItem *name

Declared in: #include <pdcomm_gem_commands.h>

required

Field

1 when the parameter must be present in the request, otherwise 0.

uint8_t required

Declared in: #include <pdcomm_gem_commands.h>