PdcommGemFormattedProgramQueryOptions

Struct

Limits for the S7F25/S7F26 service and the Equipment program store.

typedef struct PdcommGemFormattedProgramQueryOptions { ... } PdcommGemFormattedProgramQueryOptions

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

Pass this structure to pdcomm_gem_configure_formatted_program_queries(). The command and parameter limits apply to programs in the store and to programs received in S7F26.

Members

`max_catalog_entries`

Field

Largest number of programs in the store.

size_t max_catalog_entries

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

Storage for this many entries is reserved at configuration time. The store's total encoded size is limited to this value times the endpoint's SECS-II message_bytes limit.

`max_catalog_identifier_bytes`

Field

Largest sum of the PPID lengths of all stored programs, in bytes.

size_t max_catalog_identifier_bytes

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

`max_commands`

Field

Largest number of process commands in one program; must be below SIZE_MAX - 1.

size_t max_commands

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

`max_history`

Field

Number of completed transactions remembered to reject replays; the oldest is discarded first.

size_t max_history

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

Must be nonzero.

`max_parameters_per_command`

Field

Largest number of PPARM items in one command.

size_t max_parameters_per_command

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

`max_pending`

Field

Largest number of sent S7F25 requests awaiting S7F26; must be nonzero.

size_t max_pending

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

`max_received`

Field

Largest number of received S7F25 requests awaiting a reply; must be nonzero.

size_t max_received

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

A primary leaves this count when it is answered, or when its HSMS session ends (deselect or disconnect), because it can no longer be answered.

`max_results`

Field

Number of completed query outcomes the service retains; the oldest is discarded first.

size_t max_results

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

Must be nonzero.

`max_total_parameter_bytes`

Field

Largest sum of the encoded sizes of all PPARM items in one program, in bytes.

size_t max_total_parameter_bytes

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

`max_total_parameters`

Field

Largest number of PPARM items in one program.

size_t max_total_parameters

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

`reserved`

Field

Reserved; must be 0.

uint32_t reserved

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

`struct_size`

Field

Size of this structure in bytes; at least sizeof(PdcommGemFormattedProgramQueryOptions).

size_t struct_size

Declared in: #include <pdcomm_gem_formatted_program_queries.h>

`version`

Field

Options layout version; must be #PDCOMM_GEM_FORMATTED_PROGRAM_QUERY_OPTIONS_VERSION.

uint32_t version

Declared in: #include <pdcomm_gem_formatted_program_queries.h>