SECS/GEM C API

The public C API of SECS/GEM.

All kindsFieldFunctionMacroStructTypedef1806 symbols

• PDCOMM_BACKPRESSURE Macro — Work cannot be accepted until earlier work is drained.
• PDCOMM_GEM300_CAPABILITY_INFO_VERSION Macro — Value for the version field of the catalog, profile, and capability info structures.
• PDCOMM_GEM300_CAPABILITY_OPTIONS_VERSION Macro — Value for PdcommGem300CapabilityOptions::version.
• PDCOMM_GEM300_CARRIER Macro — Capability axis: carrier management (SEMI E87).
• PDCOMM_GEM300_CONTROL_JOB Macro — Capability axis: control job management (SEMI E94).
• PDCOMM_GEM300_EXPERIMENTAL Macro — Capability status label 3 (experimental) that the application assigns to its own capability; the catalog stores it without interpreting it.
• PDCOMM_GEM300_MODEL_ONLY Macro — Capability status label 2 (model only) that the application assigns to its own capability; the catalog stores it without interpreting it.
• PDCOMM_GEM300_PLANNED Macro — Capability status label 1 (planned) that the application assigns to its own capability; the catalog stores it without interpreting it.
• PDCOMM_GEM300_PROCESS_JOB Macro — Capability axis: process job management (SEMI E40).
• PDCOMM_GEM300_SUBSTRATE Macro — Capability axis: substrate tracking (SEMI E90).
• PDCOMM_GEM300_UNVERIFIED Macro — Verification label value 1, currently the only defined value; the catalog accepts and reports it.
• PDCOMM_GEM_ALARM_ACK Macro — Outcome: an Equipment received the S5F2 acknowledgement (ACKC5) of a W=1 alarm report.
• PDCOMM_GEM_ALARM_ENABLE_ACK Macro — Outcome: an alarm enable/disable acknowledgement (ACKC5) was handled.
• PDCOMM_GEM_ALARM_LIST Macro — Request kind of an S5F5 List Alarms Request.
• PDCOMM_GEM_ALARM_LIST_RECEIVED Macro — Outcome: a Host received a validated S5F6 List Alarm Data reply.
• PDCOMM_GEM_ALARM_LIST_REPLIED Macro — Outcome: an Equipment answered an S5F5 request with S5F6 from its alarm store.
• PDCOMM_GEM_ALARM_OPTIONS_VERSION Macro — Required value of PdcommGemAlarmOptions::version.
• PDCOMM_GEM_ALARM_RECEIVED Macro — Outcome: a Host received a validated S5F1 Alarm Report Send.
• PDCOMM_GEM_ALARM_REPORT Macro — Request kind of an S5F1 Alarm Report Send published with W=1.
• PDCOMM_GEM_ALREADY_ONLINE Macro — Outcome: equipment already ON-LINE received S1F17 and answered S1F18 with ONLACK 2.
• PDCOMM_GEM_ANNOTATED_QUERY Macro — Query kind and request kind for an Annotated Individual Report Request (S6F21) by RPTID.
• PDCOMM_GEM_ANNOTATED_QUERY_RECEIVED Macro — Outcome: a Host received a validated Annotated Individual Report Data reply (S6F22).
• PDCOMM_GEM_ARE_YOU_ONLINE Macro — Request kind: S1F1 Are You There Request.
• PDCOMM_GEM_ATTEMPT_ONLINE Macro — Control state: E30 ATTEMPT ON-LINE.
• PDCOMM_GEM_BINDING_OPTIONS_VERSION Macro — Version value for PdcommGemBindingOptions::version.
• PDCOMM_GEM_CHANGE_CONSTANTS Macro — Request kind for a New Equipment Constant Send (S2F15) from pdcomm_gem_host_change_constants().
• PDCOMM_GEM_COMMAND_ACCEPTED_LATER Macro — HCACK 4: acknowledged, the command will be performed and completion is signaled later by an event.
• PDCOMM_GEM_COMMAND_ACK Macro — Outcome: a Host received a validated S2F42 Host Command Acknowledge.
• PDCOMM_GEM_COMMAND_ALREADY_IN_CONDITION Macro — HCACK 5: rejected, the equipment is already in the desired condition.
• PDCOMM_GEM_COMMAND_CANNOT_PERFORM Macro — HCACK 2: the command cannot be performed now.
• PDCOMM_GEM_COMMAND_COMPLETED Macro — HCACK 0: acknowledged, the command has been performed.
• PDCOMM_GEM_COMMAND_NO_SUCH_OBJECT Macro — HCACK 6: no such object exists (used by S2F50 for an unknown OBJSPEC).
• PDCOMM_GEM_COMMAND_OPTIONS_VERSION Macro — Required value of PdcommGemCommandOptions::version.
• PDCOMM_GEM_COMMAND_PARAMETER_ERRORS Macro — HCACK 3: at least one parameter is invalid; CPACK entries describe the problems.
• PDCOMM_GEM_COMMAND_RECEIVED Macro — Outcome: an Equipment received a validated S2F41 Host Command Send.
• PDCOMM_GEM_COMMAND_UNKNOWN Macro — HCACK 1: the command does not exist.
• PDCOMM_GEM_COMMUNICATING Macro — Communication state: E30 COMMUNICATING; GEM requests are allowed.
• PDCOMM_GEM_COMMUNICATION_ESTABLISHED Macro — Outcome: communication was established (E30 COMMUNICATING).
• PDCOMM_GEM_COMMUNICATION_REJECTED Macro — Outcome: S1F14 with a nonzero COMMACK (1, denied) was received.
• PDCOMM_GEM_CONSTANT_APPLY Macro — Equipment decision and EAC 0: accept and apply the new values.
• PDCOMM_GEM_CONSTANT_CANNOT_PERFORM Macro — Equipment decision and EAC 2: denied, busy (cannot perform now).
• PDCOMM_GEM_CONSTANT_CHANGES_RECEIVED Macro — Outcome: an Equipment received a validated S2F15 that awaits a decision.
• PDCOMM_GEM_CONSTANT_CHANGE_ACK Macro — Outcome: a Host received the New Equipment Constant Acknowledge (S2F16); the EAC (0 to 63) is in PdcommGemResultInfo::acknowledgement.
• PDCOMM_GEM_CONSTANT_CURRENT Macro — Field selector: the current value (ECV); valid only for the local pdcomm_gem_equipment_constant_get().
• PDCOMM_GEM_CONSTANT_DEFAULT Macro — Field selector: the default value (ECDEF).
• PDCOMM_GEM_CONSTANT_ID Macro — Field selector: the constant ID (ECID).
• PDCOMM_GEM_CONSTANT_MAXIMUM Macro — Field selector: the maximum value (ECMAX).
• PDCOMM_GEM_CONSTANT_METADATA Macro — Request kind for an Equipment Constant Namelist Request (S2F29); used by pdcomm_gem_host_constant_request().
• PDCOMM_GEM_CONSTANT_METADATA_RECEIVED Macro — Outcome: a Host received a validated Equipment Constant Namelist reply (S2F30).
• PDCOMM_GEM_CONSTANT_METADATA_REPLIED Macro — Outcome: an Equipment answered an S2F29 automatically with S2F30 from its constant store.
• PDCOMM_GEM_CONSTANT_MINIMUM Macro — Field selector: the minimum value (ECMIN).
• PDCOMM_GEM_CONSTANT_NAME Macro — Field selector: the name (ECNAME), as an ASCII item.
• PDCOMM_GEM_CONSTANT_OPTIONS_VERSION Macro — Version value for PdcommGemConstantOptions::version.
• PDCOMM_GEM_CONSTANT_OUT_OF_RANGE Macro — Equipment decision and EAC 3: denied, at least one value is out of range.
• PDCOMM_GEM_CONSTANT_UNITS Macro — Field selector: the units, as an ASCII item.
• PDCOMM_GEM_CONSTANT_VALUES Macro — Request kind for an Equipment Constant Request (S2F13); used by pdcomm_gem_host_constant_request().
• PDCOMM_GEM_CONSTANT_VALUES_RECEIVED Macro — Outcome: a Host received a validated Equipment Constant Data reply (S2F14).
• PDCOMM_GEM_CONSTANT_VALUES_REPLIED Macro — Outcome: an Equipment answered an S2F13 automatically with S2F14 from its constant store.
• PDCOMM_GEM_CONTROL_UNAVAILABLE Macro — Control state and online mode value reported for a host role.
• PDCOMM_GEM_DATA_CACHED Macro — pdcomm_gem_equipment_data_get() field selector: the cached value, or NULL when no value is cached.
• PDCOMM_GEM_DATA_DIRECTORY Macro — Request kind for a Data Variable Namelist Request (S1F21).
• PDCOMM_GEM_DATA_DIRECTORY_RECEIVED Macro — Outcome: a Host received a validated Data Variable Namelist reply (S1F22).
• PDCOMM_GEM_DATA_DIRECTORY_REPLIED Macro — Outcome: an Equipment answered an S1F21 automatically with S1F22.
• PDCOMM_GEM_DATA_NAME Macro — pdcomm_gem_equipment_data_get() field selector: the name, as an owned ASCII item.
• PDCOMM_GEM_DATA_OPTIONS_VERSION Macro — Version value for PdcommGemDataOptions::version.
• PDCOMM_GEM_DATA_UNITS Macro — pdcomm_gem_equipment_data_get() field selector: the units, as an owned ASCII item.
• PDCOMM_GEM_DEFINE_REPORTS Macro — Request kind for a Host Define Report request (S2F33).
• PDCOMM_GEM_DEFINE_REPORTS_ACK Macro — Outcome: a Define Report Acknowledge (S2F34) was exchanged.
• PDCOMM_GEM_DIRECTORY_NAME Macro — Directory field selector: the name (DVVALNAME or CENAME), as an ASCII item.
• PDCOMM_GEM_DIRECTORY_OPTIONS_VERSION Macro — Version value for PdcommGemDirectoryOptions::version.
• PDCOMM_GEM_DIRECTORY_UNITS Macro — Directory field selector: the units of a data variable entry, as an ASCII item.
• PDCOMM_GEM_DIRECTORY_VARIABLE_IDS Macro — Directory field selector: the VIDs of an event entry, as one U4 array item.
• PDCOMM_GEM_DISCONNECTED Macro — Communication state: the HSMS session is not SELECTED.
• PDCOMM_GEM_ENABLED_ALARM_LIST Macro — Request kind of an S5F7 List Enabled Alarm Request.
• PDCOMM_GEM_ENABLED_ALARM_LIST_RECEIVED Macro — Outcome: a Host received a validated S5F8 List Enabled Alarm Data reply.
• PDCOMM_GEM_ENABLED_ALARM_LIST_REPLIED Macro — Outcome: an Equipment answered an S5F7 request with S5F8 from its alarm store.
• PDCOMM_GEM_ENABLE_ALARM Macro — Request kind of an S5F3 Enable/Disable Alarm Send sent with W=1.
• PDCOMM_GEM_ENABLE_EVENTS Macro — Request kind for a Host Enable/Disable Event Report request (S2F37).
• PDCOMM_GEM_ENABLE_EVENTS_ACK Macro — Outcome: an Enable/Disable Event Report Acknowledge (S2F38) was exchanged.
• PDCOMM_GEM_ENHANCED_COMMAND_ACK Macro — Outcome: a Host received a validated S2F50 Enhanced Remote Command Acknowledge.
• PDCOMM_GEM_ENHANCED_COMMAND_OPTIONS_VERSION Macro — Required value of PdcommGemEnhancedCommandOptions::version.
• PDCOMM_GEM_ENHANCED_COMMAND_RECEIVED Macro — Outcome: an Equipment received a validated S2F49 Enhanced Remote Command.
• PDCOMM_GEM_ENHANCED_REMOTE_COMMAND Macro — Request kind of an S2F49 Enhanced Remote Command.
• PDCOMM_GEM_EQUIPMENT Macro — GEM role value for equipment (::PdcommGemState::role).
• PDCOMM_GEM_EQUIPMENT_IDENTITY Macro — Outcome: a host received S1F2 with the equipment model (MDLN) and software revision (SOFTREV); read them with pdcomm_gem_result_body().
• PDCOMM_GEM_EQUIPMENT_OFFLINE Macro — Control state: E30 EQUIPMENT OFF-LINE (operator has the equipment off-line).
• PDCOMM_GEM_ERROR_ABORTED Macro — GEM error: the peer aborted the transaction with a function 0 (SxF0) reply.
• PDCOMM_GEM_ERROR_ACK Macro — GEM error: an acknowledgement code is outside the range the message defines.
• PDCOMM_GEM_ERROR_BODY Macro — GEM error: the body structure, item formats, or item counts do not match the message definition.
• PDCOMM_GEM_ERROR_CODEC Macro — GEM error: the body is not valid SECS-II or exceeds the configured item limits.
• PDCOMM_GEM_ERROR_CORRELATION Macro — GEM error: reply entries do not correspond to the requested identifiers (count or identifier mismatch).
• PDCOMM_GEM_ERROR_DISCONNECTED Macro — GEM error: the GEM role saw no SELECTED HSMS session when it processed the message.
• PDCOMM_GEM_ERROR_MISSING_BODY Macro — GEM error: the message requires a body but has none.
• PDCOMM_GEM_ERROR_RESPONSE Macro — GEM error: the reply does not fit the pending request, or another GEM protocol rule failed without a more specific code.
• PDCOMM_GEM_ERROR_STATE Macro — GEM error: the message is not allowed in the current communication or control state.
• PDCOMM_GEM_ERROR_UNEXPECTED_BODY Macro — GEM error: the message must be header-only but has a body.
• PDCOMM_GEM_ERROR_UNSUPPORTED Macro — GEM error: this role or configuration does not support the stream and function, or a reply has an unexpected stream or function.
• PDCOMM_GEM_ERROR_WAIT Macro — GEM error: the W-bit (reply expected) does not match the message definition.
• PDCOMM_GEM_ESTABLISH Macro — Request kind: S1F13 Establish Communications Request, from pdcomm_gem_begin_communication().
• PDCOMM_GEM_EVENT_ACK Macro — Outcome: an Equipment received the Event Report Acknowledge (S6F12).
• PDCOMM_GEM_EVENT_DIRECTORY Macro — Request kind for a Collection Event Namelist Request (S1F23).
• PDCOMM_GEM_EVENT_DIRECTORY_RECEIVED Macro — Outcome: a Host received a validated Collection Event Namelist reply (S1F24).
• PDCOMM_GEM_EVENT_DIRECTORY_REPLIED Macro — Outcome: an Equipment answered an S1F23 automatically with S1F24 from its event directory.
• PDCOMM_GEM_EVENT_QUERY Macro — Query kind and request kind for an Event Report Request (S6F15) by CEID.
• PDCOMM_GEM_EVENT_QUERY_RECEIVED Macro — Outcome: a Host received a validated Event Report Data reply (S6F16).
• PDCOMM_GEM_EVENT_RECEIVED Macro — Outcome: a Host received a validated Event Report Send (S6F11).
• PDCOMM_GEM_EVENT_REPORT Macro — Request kind for an Equipment Event Report Send (S6F11) from pdcomm_gem_equipment_publish_event().
• PDCOMM_GEM_FAILED Macro — Result kind: a pending GEM request ended without a valid reply.
• PDCOMM_GEM_FORMATTED_PROGRAM_ACK_RECEIVED Macro — GEM result outcome: the equipment received the S7F28 acknowledge.
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_BEFORE Macro — Dependency field selector for BCDS (before command codes).
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_IMMEDIATE_AFTER Macro — Dependency field selector for IACDS (immediately-after command codes).
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_IMMEDIATE_BEFORE Macro — Dependency field selector for IBCDS (immediately-before command codes).
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_NON_AFTER Macro — Dependency field selector for NACDS (not-after command codes).
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_NON_BEFORE Macro — Dependency field selector for NBCDS (not-before command codes).
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_OPTIONS_VERSION Macro — Required value of PdcommGemFormattedProgramCapabilityOptions::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_RECEIVED Macro — GEM result outcome: the equipment received an S7F21 request.
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_RESULT Macro — GEM result outcome: the host received valid S7F22 capability data.
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_SEND Macro — GEM request kind of an S7F21 capability request.
• PDCOMM_GEM_FORMATTED_PROGRAM_CREATE_ONLY Macro — Store action: add the program; fails when the PPID already exists.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_CAPABILITY_MISSING Macro — Issue (indeterminate): no capability catalog is installed or capabilities are not configured.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_CAPABILITY_PARAMETER_UNVERIFIED Macro — Issue (indeterminate): a catalog command has parameter descriptors, whose meaning the dry run does not evaluate; command_index is the catalog command index and observed the descriptor count.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_COMMAND_COUNT_EXCEEDED Macro — Issue (reject): the program has more commands than CMDMAX; observed is the count and expected is CMDMAX.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_DEPENDENCY_UNVERIFIED Macro — Issue (indeterminate): a catalog command declares a nonzero BLKDEF or dependencies, which the dry run does not evaluate; command_index is the catalog command index.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ENCODED_BYTES_EXCEEDED Macro — Issue (reject): the encoded program is larger than BYTMAX; observed is the size and expected is BYTMAX.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_INDETERMINATE Macro — Dry-run outcome: at least one check is indeterminate; execution may still be started.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_INFO_VERSION Macro — Required input value of PdcommGemFormattedProgramDryRunInfo::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ISSUE_COMMAND_INDEX_PRESENT Macro — Issue presence bit: PdcommGemFormattedProgramDryRunIssueInfo::command_index is valid.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ISSUE_EXPECTED_PRESENT Macro — Issue presence bit: PdcommGemFormattedProgramDryRunIssueInfo::expected is valid.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ISSUE_FIELD_INDEX_PRESENT Macro — Issue presence bit: PdcommGemFormattedProgramDryRunIssueInfo::field_index is valid.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ISSUE_INFO_VERSION Macro — Required input value of PdcommGemFormattedProgramDryRunIssueInfo::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ISSUE_OBSERVED_PRESENT Macro — Issue presence bit: PdcommGemFormattedProgramDryRunIssueInfo::observed is valid.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_MODEL_MISMATCH Macro — Issue (reject): the program's MDLN differs from the catalog's MDLN.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_OPTIONS_VERSION Macro — Required value of PdcommGemFormattedProgramDryRunOptions::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_PASS Macro — Dry-run outcome: no issue was found.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_POLICY_V1 Macro — Dry-run policy version 1, the only supported policy.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_PROGRAM_PARAMETER_UNVERIFIED Macro — Issue (indeterminate): a program command has parameters, whose meaning the dry run does not evaluate; command_index is the program command index and observed the parameter count.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_REJECT Macro — Dry-run outcome: the program contradicts the capability catalog; execution is refused.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_REQUIRED_COMMAND_MISSING Macro — Issue (reject): a required catalog command is absent from the program.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_SOFTWARE_REVISION_MISMATCH Macro — Issue (reject): the program's SOFTREV differs from the catalog's SOFTREV.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_UNKNOWN_ASCII_COMMAND Macro — Issue (reject): an ASCII command code is not in the catalog; command_index is the program command index.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_UNSIGNED_COMMAND_UNMAPPED Macro — Issue (indeterminate): an unsigned-integer command code cannot be matched against ASCII catalog codes; command_index is the program command index.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_CANCEL Macro — Action kind: cancel the execution; carries the index of the first command not applied.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_CANCEL_NEXT_COMMAND_INDEX_PRESENT Macro — Action presence bit: cancel_next_command_index is valid (Cancel).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_COMMAND_PRESENT Macro — Action presence bit: a command code and parameters are available (Step).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_INFO_VERSION Macro — Required input value of PdcommGemFormattedProgramExecutionActionInfo::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_MODEL_PRESENT Macro — Action presence bit: the program MDLN is available (Start).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_NONE Macro — Action kind: no action (used when nothing is pending).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_PROGRAM_ID_PRESENT Macro — Action presence bit: the program identifier is available (Start).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_RESULT_ACCEPTED Macro — Action result for Start only: started; the state becomes RUNNING.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_RESULT_APPLIED Macro — Action result for Step only: the command was applied; the next command index advances.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_RESULT_CANCELLED Macro — Action result for Cancel only: cancelled; the state becomes CANCELLED.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_RESULT_FAILED Macro — Action result for any action: the action failed; the state becomes FAILED.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_RESULT_OUTCOME_UNKNOWN Macro — Action result for any action: the effect is unknown; the state becomes OUTCOME_UNKNOWN.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_RESULT_REJECTED Macro — Action result: refused.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_SOFTWARE_REVISION_PRESENT Macro — Action presence bit: the program SOFTREV is available (Start).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_START Macro — Action kind: start the program; carries the program identity and the dry-run admission data.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_STEP Macro — Action kind: apply one program command; carries the command code and parameters.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_TOKEN_VERSION Macro — Required value of PdcommGemFormattedProgramExecutionActionToken::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_APPLICATION_DETAIL_PRESENT Macro — Snapshot presence bit: the terminal report has nonempty detail bytes.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_APPLICATION_REJECTED Macro — Terminal state: the application rejected a Start or Step action.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_APPLICATION_REPORT_PRESENT Macro — Snapshot presence bit: a terminal report was recorded (application_report_kind and application_report_id are valid).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_CANCELLED Macro — Terminal state: the application confirmed a Cancel action.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_CANCEL_PENDING Macro — Execution state: a Cancel action waits for the application's result.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_COMPLETED Macro — Terminal state: the application reported completion after every command was applied.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_EMPTY Macro — Execution state: no execution has been started on this endpoint.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_FAILED Macro — Terminal state: the application reported a failed action or a failed execution.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_INFO_VERSION Macro — Required input value of PdcommGemFormattedProgramExecutionInfo::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_OUTCOME_UNKNOWN Macro — Terminal state: the application could not determine what the machine did.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_PENDING_ACTION_PRESENT Macro — Snapshot presence bit: an action is pending (pending_kind and pending_action_sequence are valid).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_RUNNING Macro — Execution state: started, with no action pending.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_START_PENDING Macro — Execution state: the Start action waits for the application's result.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_STEP_PENDING Macro — Execution state: a Step action waits for the application's result.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_TERMINAL_COMPLETE Macro — Terminal report: the execution completed.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_TERMINAL_FAIL Macro — Terminal report: the execution failed.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_TERMINAL_OUTCOME_UNKNOWN Macro — Terminal report: the outcome is unknown.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_TOKEN_VERSION Macro — Required value of PdcommGemFormattedProgramExecutionToken::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_OPTIONS_VERSION Macro — Value for #PdcommGemFormattedProgramOptions::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_QUERY_OPTIONS_VERSION Macro — Value for #PdcommGemFormattedProgramQueryOptions::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_QUERY_RECEIVED Macro — GEM result outcome: the equipment received an S7F25 request.
• PDCOMM_GEM_FORMATTED_PROGRAM_QUERY_RESULT Macro — GEM result outcome: the host received the S7F26 program data.
• PDCOMM_GEM_FORMATTED_PROGRAM_QUERY_SEND Macro — GEM request kind of an S7F25 Formatted Process Program Request.
• PDCOMM_GEM_FORMATTED_PROGRAM_RECEIVED Macro — GEM result outcome: the host received an S7F27 verification report.
• PDCOMM_GEM_FORMATTED_PROGRAM_REPLACE_ONLY Macro — Store action: replace an existing program; fails when the PPID is absent.
• PDCOMM_GEM_FORMATTED_PROGRAM_RESPOND_ONLY Macro — Store action: send the S7F24 acknowledge without changing the store.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_EMPTY Macro — Selection state: no program is selected.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_INFO_VERSION Macro — Value for #PdcommGemFormattedProgramSelectionInfo::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_READY Macro — Selection state: the selected program is unchanged in the store and in the current session.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE Macro — Selection state: a program is selected but is no longer valid; see the stale reason.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_CLEARED Macro — Validation result: no program is selected.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_DISCONNECTED Macro — Stale reason: the HSMS session in which the selection was made has ended.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_ENTRY_CHANGED Macro — Stale reason: the selected store entry was replaced.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_ENTRY_DELETED Macro — Stale reason: the selected PPID was removed from the store.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_NONE Macro — Stale reason: the selection is not stale.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_SESSION_CHANGED Macro — Stale reason: the current HSMS session generation differs from the one the selection was made in.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_TOKEN_MISMATCH Macro — Validation result: the token does not match the current selection.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_TOKEN_VERSION Macro — Value for #PdcommGemFormattedProgramSelectionToken::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_SEND Macro — GEM request kind of an S7F27 Process Program Verification Send.
• PDCOMM_GEM_FORMATTED_PROGRAM_STORE_INFO_VERSION Macro — Value for the version field of the store info structures.
• PDCOMM_GEM_FORMATTED_PROGRAM_TRANSFER_ACK_RECEIVED Macro — GEM result outcome: the host received the S7F24 acknowledge.
• PDCOMM_GEM_FORMATTED_PROGRAM_TRANSFER_OPTIONS_VERSION Macro — Value for #PdcommGemFormattedProgramTransferOptions::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_TRANSFER_RECEIVED Macro — GEM result outcome: the equipment received an S7F23 program.
• PDCOMM_GEM_FORMATTED_PROGRAM_TRANSFER_SEND Macro — GEM request kind of an S7F23 Formatted Process Program Send.
• PDCOMM_GEM_FORMATTED_PROGRAM_UPSERT Macro — Store action: add the program, or replace the entry with the same PPID.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_ACK_RECEIVED Macro — GEM result outcome: the equipment received the S7F28 acknowledgement of its S7F27 report.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_GRANT_RECEIVED Macro — GEM result outcome: the equipment received an S7F30 grant (granted or denied).
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_OPTIONS_VERSION Macro — Required value of PdcommGemFormattedProgramVerificationNegotiationOptions::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_RECEIVED Macro — GEM result outcome: the host received an S7F29 inquiry.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_SEND Macro — GEM request kind of an S7F29 verification inquiry.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_STATE_PREPARED Macro — Negotiation state: an equipment-side record (prepared, grant, acknowledgement, or failure result).
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_STATE_RECEIVED Macro — Negotiation state: a host-side S7F29 inquiry that has not been answered yet.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_STATE_RESPONDED Macro — Negotiation state: a host-side S7F29 inquiry answered with S7F30.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_TERMINAL_DENIED Macro — Terminal value: denied with a nonzero PPGNT code.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_TERMINAL_DISCONNECTED Macro — Terminal value: the HSMS session was disconnected or deselected first.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_TERMINAL_GRANTED Macro — Terminal value: granted.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_TERMINAL_NONE Macro — Terminal value: not finished, or finished by a protocol error without a more specific reason.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_TERMINAL_TIMED_OUT Macro — Terminal value: the transaction ended with a T3 reply timeout or T6 control timeout.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_REQUEST_ACK_RECEIVED Macro — GEM result outcome: the host received the S7F32 acknowledge.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_REQUEST_OPTIONS_VERSION Macro — Value for #PdcommGemFormattedProgramVerificationRequestOptions::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_REQUEST_RECEIVED Macro — GEM result outcome: the equipment received an S7F31 request.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_REQUEST_SEND Macro — GEM request kind of an S7F31 Verification Request Send.
• PDCOMM_GEM_HOST Macro — GEM role value for a host (::PdcommGemState::role).
• PDCOMM_GEM_HOST_OFFLINE Macro — Control state: E30 HOST OFF-LINE (equipment is willing to go on-line; the host has not accepted).
• PDCOMM_GEM_IGNORED Macro — Result kind: the event is not GEM traffic for this role.
• PDCOMM_GEM_INDIVIDUAL_QUERY Macro — Query kind and request kind for an Individual Report Request (S6F19) by RPTID.
• PDCOMM_GEM_INDIVIDUAL_QUERY_RECEIVED Macro — Outcome: a Host received a validated Individual Report Data reply (S6F20).
• PDCOMM_GEM_INVALID_RESPONSE Macro — Result kind: a reply matched a pending request but failed validation.
• PDCOMM_GEM_LINK_REPORTS Macro — Request kind for a Host Link Event Report request (S2F35).
• PDCOMM_GEM_LINK_REPORTS_ACK Macro — Outcome: a Link Event Report Acknowledge (S2F36) was exchanged.
• PDCOMM_GEM_LOCAL Macro — Online mode: an accepted ON-LINE transition enters ON-LINE LOCAL.
• PDCOMM_GEM_NAMES_RECEIVED Macro — Outcome: a host received a valid S1F12; read the entries with pdcomm_gem_result_status_name().
• PDCOMM_GEM_NOT_COMMUNICATING Macro — Communication state: E30 NOT COMMUNICATING.
• PDCOMM_GEM_OFFLINE Macro — Request kind: S1F15 Request OFF-LINE.
• PDCOMM_GEM_OFFLINE_ACCEPTED Macro — Outcome: equipment received S1F15 and answered S1F16 with OFLACK 0; an ON-LINE control state changes to HOST OFF-LINE, other states are unchanged.
• PDCOMM_GEM_OFFLINE_ACK Macro — Outcome: a host received S1F16; acknowledgement holds OFLACK (0).
• PDCOMM_GEM_ONLINE Macro — Request kind: S1F17 Request ON-LINE.
• PDCOMM_GEM_ONLINE_ACCEPTED Macro — Outcome: the equipment went ON-LINE.
• PDCOMM_GEM_ONLINE_ACK Macro — Outcome: a host received S1F18; acknowledgement holds ONLACK (0 accepted, 1 not allowed, 2 already ON-LINE).
• PDCOMM_GEM_ONLINE_LOCAL Macro — Control state: E30 ON-LINE LOCAL.
• PDCOMM_GEM_ONLINE_REJECTED Macro — Outcome: equipment in EQUIPMENT OFF-LINE or ATTEMPT ON-LINE received S1F17 and answered S1F18 with ONLACK 1 (not allowed).
• PDCOMM_GEM_ONLINE_REMOTE Macro — Control state: E30 ON-LINE REMOTE.
• PDCOMM_GEM_OPERATOR_ONLINE Macro — Request kind: the equipment's operator-initiated S1F1 ON-LINE attempt.
• PDCOMM_GEM_OPTIONS_VERSION Macro — Current version of ::PdcommGemHostOptions and ::PdcommGemEquipmentOptions.
• PDCOMM_GEM_OUTCOME_NONE Macro — Outcome: none (ignored, failed, invalid, and unhandled results, and results without a specific outcome).
• PDCOMM_GEM_PRIMARY Macro — Result kind: a received primary message was processed.
• PDCOMM_GEM_PROGRAM_ACK_RECEIVED Macro — Result outcome: an S7F4 or S7F18 acknowledgement (ACKC7) was received.
• PDCOMM_GEM_PROGRAM_BODY Macro — Field selector for pdcomm_gem_result_program_item(): the PPBODY.
• PDCOMM_GEM_PROGRAM_CONFIRMED Macro — Durability: an unconfirmed installation was accepted with pdcomm_gem_program_confirm_reply().
• PDCOMM_GEM_PROGRAM_CREATE Macro — Put mode: create a new program; fail if the PPID exists.
• PDCOMM_GEM_PROGRAM_DATA_RECEIVED Macro — Result outcome: an S7F6 program data reply was received.
• PDCOMM_GEM_PROGRAM_DELETE Macro — Request kind of S7F17 delete process program send.
• PDCOMM_GEM_PROGRAM_DIRECTORY Macro — Request kind of S7F19 current equipment process program directory request.
• PDCOMM_GEM_PROGRAM_DIRECTORY_RECEIVED Macro — Result outcome: an S7F20 directory reply was received.
• PDCOMM_GEM_PROGRAM_DURABILITY_NONE Macro — Durability: no change was installed.
• PDCOMM_GEM_PROGRAM_GRANT Macro — Request kind of S7F1 process program load inquire (grant request).
• PDCOMM_GEM_PROGRAM_GRANT_OPTIONAL Macro — Grant policy: an incoming S7F3 without a grant is accepted when no other grant is active.
• PDCOMM_GEM_PROGRAM_GRANT_RECEIVED Macro — Result outcome: an S7F2 grant (PPGNT) was received.
• PDCOMM_GEM_PROGRAM_GRANT_REQUIRED Macro — Grant policy: an incoming S7F3 needs a prior accepted S7F1 grant for the same PPID.
• PDCOMM_GEM_PROGRAM_ID Macro — Field selector for pdcomm_gem_result_program_item(): a PPID.
• PDCOMM_GEM_PROGRAM_OPTIONS_VERSION Macro — Required version of ::PdcommGemProgramOptions.
• PDCOMM_GEM_PROGRAM_RECEIVED Macro — Result outcome: a valid incoming S7F1, F3, F5, F17, or F19 request was received.
• PDCOMM_GEM_PROGRAM_REPLACE Macro — Put mode: replace an existing program; fail if the PPID does not exist.
• PDCOMM_GEM_PROGRAM_REQUEST Macro — Request kind of S7F5 process program request.
• PDCOMM_GEM_PROGRAM_SEND Macro — Request kind of S7F3 process program send.
• PDCOMM_GEM_PROGRAM_SYNCED Macro — Durability: the snapshot file was replaced and its parent directory synchronized.
• PDCOMM_GEM_PROGRAM_UNCONFIRMED Macro — Durability: the snapshot file was replaced, but the directory sync failed (#PDCOMM_PROGRAM_UNCONFIRMED).
• PDCOMM_GEM_PROGRAM_UPSERT Macro — Put mode: create the program or replace an existing one.
• PDCOMM_GEM_PROGRAM_VOLATILE Macro — Durability: the change was applied to a RAM store.
• PDCOMM_GEM_REMOTE Macro — Online mode: an accepted ON-LINE transition enters ON-LINE REMOTE.
• PDCOMM_GEM_REMOTE_COMMAND Macro — Request kind of an S2F41 Host Command Send.
• PDCOMM_GEM_REPLIED Macro — Outcome: a received primary was answered automatically and has no more specific outcome, for example S1F1 answered with S1F2.
• PDCOMM_GEM_REPORT_OPTIONS_VERSION Macro — Version value for PdcommGemReportOptions::version.
• PDCOMM_GEM_REPORT_QUERY_RECEIVED Macro — Outcome: an Equipment received a valid S6F15, S6F19, or S6F21 that awaits pdcomm_gem_equipment_respond_report_query().
• PDCOMM_GEM_RESPONSE Macro — Result kind: a valid reply completed a pending GEM request.
• PDCOMM_GEM_SOURCE_CONSTANT Macro — Binding source kind: the current value of an equipment constant from pdcomm_gem_equipment_configure_constants().
• PDCOMM_GEM_SOURCE_DATA Macro — Binding source kind: a data variable from pdcomm_gem_equipment_configure_data_variables().
• PDCOMM_GEM_SOURCE_STATUS Macro — Binding source kind: a status variable registered with pdcomm_gem_equipment_status_register().
• PDCOMM_GEM_SPOOL_ACTIVATED Macro — Mutation: spooling became active because communication is down and spooling is enabled.
• PDCOMM_GEM_SPOOL_CAPTURED Macro — Mutation: a message was stored; entry_id names it and affected_count counts overwritten entries.
• PDCOMM_GEM_SPOOL_CONFIGURE Macro — Request kind of an S2F43 reset spooling streams and functions request.
• PDCOMM_GEM_SPOOL_CONFIGURED Macro — Mutation: spool policy and selection were replaced (initial snapshot, local configuration, or accepted S2F43).
• PDCOMM_GEM_SPOOL_CONFIG_ACK Macro — Result outcome: Host received a valid S2F44 reset spooling acknowledge.
• PDCOMM_GEM_SPOOL_CONFIG_DATA Macro — Result outcome: Host received a valid S2F60 carrying the current selection.
• PDCOMM_GEM_SPOOL_CONFIRMED Macro — Durability: an unconfirmed reply was accepted with pdcomm_gem_spool_confirm_reply().
• PDCOMM_GEM_SPOOL_CONTROL Macro — Request kind of an S6F23 request spooled data (transmit or purge).
• PDCOMM_GEM_SPOOL_CONTROL_ACK Macro — Result outcome: Host received a valid S6F24 request spooled data acknowledge.
• PDCOMM_GEM_SPOOL_DELIVERY Macro — Request kind of a spooled message sent by pdcomm_gem_spool_send_next().
• PDCOMM_GEM_SPOOL_DELIVERY_FAILED Macro — Result outcome: a delivery attempt failed (T3, cancellation, disconnect, write failure, or invalid reply).
• PDCOMM_GEM_SPOOL_DELIVERY_RESPONSE Macro — Result outcome: the matching secondary reply to a W1 spooled message arrived.
• PDCOMM_GEM_SPOOL_DELIVERY_WRITTEN Macro — Result outcome: a W0 spooled message was completely written to the local socket.
• PDCOMM_GEM_SPOOL_DISCARDED Macro — Mutation: a selected message was discarded because the spool is full; only statistics changed.
• PDCOMM_GEM_SPOOL_DISCARD_NEW Macro — Overflow policy: when the spool is full, discard the new message (E30 OverWriteSpool false).
• PDCOMM_GEM_SPOOL_DURABILITY_NONE Macro — Durability: no change was installed.
• PDCOMM_GEM_SPOOL_MUTATION_NONE Macro — Mutation: nothing was changed.
• PDCOMM_GEM_SPOOL_OPTIONS_VERSION Macro — Required version of ::PdcommGemSpoolOptions and ::PdcommGemSpoolHostOptions.
• PDCOMM_GEM_SPOOL_OVERWRITE_OLDEST Macro — Overflow policy: when the spool is full, remove the oldest messages to make room (E30 OverWriteSpool true).
• PDCOMM_GEM_SPOOL_PROOF_NONE Macro — Delivery proof: the result carries no delivery proof.
• PDCOMM_GEM_SPOOL_PROOF_RESPONSE Macro — Delivery proof: a matching secondary reply to a W1 spooled message was received.
• PDCOMM_GEM_SPOOL_PROOF_WRITTEN Macro — Delivery proof: the complete frame of a W0 spooled message was written locally.
• PDCOMM_GEM_SPOOL_PURGE Macro — S6F23 RSDC command 1: purge spooled messages.
• PDCOMM_GEM_SPOOL_PURGED Macro — Mutation: all spooled messages were purged; affected_count counts them.
• PDCOMM_GEM_SPOOL_QUERY Macro — Request kind of an S2F59 spool configuration request (current selection).
• PDCOMM_GEM_SPOOL_RECEIVED Macro — Result outcome: Equipment received a valid S2F43, S2F59, or S6F23 primary.
• PDCOMM_GEM_SPOOL_REMOVED Macro — Mutation: a delivered head entry was dequeued; entry_id names it.
• PDCOMM_GEM_SPOOL_SYNCED Macro — Durability: the snapshot file was replaced and its parent directory synchronized.
• PDCOMM_GEM_SPOOL_TRANSMIT Macro — S6F23 RSDC command 0: transmit spooled messages.
• PDCOMM_GEM_SPOOL_UNCONFIRMED Macro — Durability: the snapshot file was replaced, but the directory sync failed (#PDCOMM_SPOOL_UNCONFIRMED).
• PDCOMM_GEM_SPOOL_VOLATILE Macro — Durability: the change was applied to a RAM spool.
• PDCOMM_GEM_STATUS_NAMES Macro — Request kind: S1F11 Status Variable Namelist Request.
• PDCOMM_GEM_STATUS_REPLIED Macro — Outcome: equipment answered S1F3 with S1F4 or S1F11 with S1F12 from its status variable registry.
• PDCOMM_GEM_STATUS_VALUES Macro — Request kind: S1F3 Selected Equipment Status Request (status variable values).
• PDCOMM_GEM_UNHANDLED Macro — Result kind: a received primary was not processed and no reply was sent.
• PDCOMM_GEM_VALUES_RECEIVED Macro — Outcome: a host received a valid S1F4; read the values with pdcomm_gem_result_status_value().
• PDCOMM_GEM_WAITING_ACK Macro — Communication state: S1F13 sent, waiting for S1F14 (E30 WAIT CRA).
• PDCOMM_INVALID_STATE Macro — The call is not valid in the endpoint's current state or context.
• PDCOMM_POISONED Macro — The endpoint is permanently unusable after a contained panic.
• PDCOMM_PROGRAM_UNCONFIRMED Macro — The program store change was installed, but its durability is unconfirmed.
• PDCOMM_SECS1_EVENT_FAULT Macro — Event kind: a terminal fault stopped the endpoint.
• PDCOMM_SECS1_EVENT_INBOUND Macro — Event kind: a complete message was received.
• PDCOMM_SECS1_EVENT_OUTBOUND_COMPLETE Macro — Event kind: the peer acknowledged every block of a submitted message.
• PDCOMM_SECS1_EVENT_OUTBOUND_FAILED Macro — Event kind: a submitted message was not delivered.
• PDCOMM_SECS1_FAULT_BLOCK Macro — Fault kind reserved for block faults; not produced by this release.
• PDCOMM_SECS1_FAULT_CLOSED Macro — Fault kind: the read callback reported end of stream.
• PDCOMM_SECS1_FAULT_IO Macro — Fault kind: a read or write callback failed.
• PDCOMM_SECS1_FAULT_LINE Macro — Fault kind reserved for line-control faults; not produced by this release.
• PDCOMM_SECS1_FAULT_REASSEMBLY Macro — Fault kind: memory for reassembling an inbound message could not be allocated.
• PDCOMM_SECS1_FAULT_UNKNOWN_CONTROL Macro — Fault kind retained for compatibility; no longer produced.
• PDCOMM_SECS1_IO_ABORTED Macro — I/O result or fault detail: the connection was aborted.
• PDCOMM_SECS1_IO_ADDRESS_IN_USE Macro — I/O result or fault detail: the address is already in use.
• PDCOMM_SECS1_IO_ADDRESS_UNAVAILABLE Macro — I/O result or fault detail: the address is not available.
• PDCOMM_SECS1_IO_BROKEN_PIPE Macro — I/O result or fault detail: the pipe or line is broken.
• PDCOMM_SECS1_IO_CLOSED Macro — I/O result or fault detail: the stream is closed.
• PDCOMM_SECS1_IO_INTERRUPTED Macro — I/O result: the operation was interrupted before any transfer.
• PDCOMM_SECS1_IO_INVALID_DATA Macro — I/O result or fault detail: invalid data.
• PDCOMM_SECS1_IO_INVALID_INPUT Macro — I/O result or fault detail: the device layer rejected an input parameter.
• PDCOMM_SECS1_IO_NOT_CONNECTED Macro — I/O result or fault detail: the stream is not connected.
• PDCOMM_SECS1_IO_NOT_FOUND Macro — I/O result or fault detail: the device or entity was not found.
• PDCOMM_SECS1_IO_OK Macro — I/O result: the operation succeeded.
• PDCOMM_SECS1_IO_OTHER Macro — I/O result or fault detail: any other failure.
• PDCOMM_SECS1_IO_PERMISSION Macro — I/O result or fault detail: permission was denied.
• PDCOMM_SECS1_IO_REFUSED Macro — I/O result or fault detail: the connection was refused.
• PDCOMM_SECS1_IO_RESET Macro — I/O result or fault detail: the connection was reset by the peer.
• PDCOMM_SECS1_IO_TIMED_OUT Macro — I/O result or fault detail: the operation timed out in the device layer.
• PDCOMM_SECS1_IO_WOULD_BLOCK Macro — I/O result: no progress is possible now.
• PDCOMM_SECS1_IO_WRITE_ZERO Macro — I/O result or fault detail: a write made no progress.
• PDCOMM_SECS1_MASTER Macro — Line priority of the SEMI E4 master.
• PDCOMM_SECS1_MESSAGE_VERSION Macro — Value for PdcommSecs1Message::version.
• PDCOMM_SECS1_OPTIONS_VERSION Macro — Value for PdcommSecs1Options::version.
• PDCOMM_SECS1_SLAVE Macro — Line priority of the SEMI E4 slave.
• PDCOMM_SECS1_TO_EQUIPMENT Macro — Message direction host to equipment: the block header R-bit is 0.
• PDCOMM_SECS1_TO_HOST Macro — Message direction equipment to host: the block header R-bit is 1.
• PDCOMM_SECS_ASCII Macro — SECS-II format code for ASCII (E5 format 20, octal); bytes must be 0x00 to 0x7F.
• PDCOMM_SECS_BINARY Macro — SECS-II format code for Binary (E5 format 10, octal), 1-byte elements.
• PDCOMM_SECS_BOOLEAN Macro — SECS-II format code for Boolean (E5 format 11, octal), 1-byte elements.
• PDCOMM_SECS_F4 Macro — SECS-II format code for 4-byte IEEE 754 floats (E5 format 44, octal).
• PDCOMM_SECS_F8 Macro — SECS-II format code for 8-byte IEEE 754 floats (E5 format 40, octal).
• PDCOMM_SECS_I1 Macro — SECS-II format code for 1-byte signed integers (E5 format 31, octal).
• PDCOMM_SECS_I2 Macro — SECS-II format code for 2-byte signed integers (E5 format 32, octal).
• PDCOMM_SECS_I4 Macro — SECS-II format code for 4-byte signed integers (E5 format 34, octal).
• PDCOMM_SECS_I8 Macro — SECS-II format code for 8-byte signed integers (E5 format 30, octal).
• PDCOMM_SECS_JIS8 Macro — SECS-II format code for JIS-8 text (E5 format 21, octal); bytes are not validated.
• PDCOMM_SECS_LIST Macro — SECS-II format code for a List (E5 format 00).
• PDCOMM_SECS_U1 Macro — SECS-II format code for 1-byte unsigned integers (E5 format 51, octal).
• PDCOMM_SECS_U2 Macro — SECS-II format code for 2-byte unsigned integers (E5 format 52, octal).
• PDCOMM_SECS_U4 Macro — SECS-II format code for 4-byte unsigned integers (E5 format 54, octal).
• PDCOMM_SECS_U8 Macro — SECS-II format code for 8-byte unsigned integers (E5 format 50, octal).
• PDCOMM_SPOOL_UNCONFIRMED Macro — The spool change was installed, but its durability is unconfirmed.
• PDCOMM_STALE_TOKEN Macro — The token or event belongs to another endpoint or to an earlier connection generation.
• PDCOMM_TCP_ACTIVE Macro — Connection mode: the endpoint connects to the peer (HSMS active entity).
• PDCOMM_TCP_CANCELLED Macro — Failure reason: cancelled by pdcomm_tcp_cancel() or pdcomm_tcp_stop().
• PDCOMM_TCP_CONNECTING Macro — State: active mode; a connection attempt is due and runs inside pdcomm_tcp_poll().
• PDCOMM_TCP_DESELECTED Macro — Failure reason: a Deselect procedure (local or remote) completed while the transaction was open.
• PDCOMM_TCP_DESELECT_STATUS Macro — Failure reason: Deselect.rsp carried a nonzero DeselectStatus, stored in PdcommTcpEventInfo::value1.
• PDCOMM_TCP_DISCONNECTED Macro — Failure reason: the connection ended while the transaction was open.
• PDCOMM_TCP_DUPLICATE_PRIMARY Macro — Protocol error: a W-bit primary reuses the system bytes of a received primary that is still unanswered.
• PDCOMM_TCP_FAILED Macro — Event kind: an outgoing transaction ended without a reply.
• PDCOMM_TCP_FRAME_BUFFER_TOO_SMALL Macro — Frame error: the frame buffer is too small.
• PDCOMM_TCP_FRAME_CONTROL_BODY Macro — Frame error: a control message has a body; PdcommTcpEventInfo::value1 holds its length.
• PDCOMM_TCP_FRAME_CONTROL_SESSION Macro — Frame error: a control message has a session ID other than 0xFFFF; PdcommTcpEventInfo::value1 holds it.
• PDCOMM_TCP_FRAME_HEADER_FIELD Macro — Frame error: a header byte has an invalid value.
• PDCOMM_TCP_FRAME_INVALID_LENGTH Macro — Frame error: the message length field is smaller than the 10-byte HSMS header; PdcommTcpEventInfo::value1 holds the declared length.
• PDCOMM_TCP_FRAME_LENGTH_OVERFLOW Macro — Frame error: the frame length does not fit in the platform's size type.
• PDCOMM_TCP_FRAME_LIMIT Macro — Protocol error code reserved for received frames above PdcommTcpOptions::max_frame_bytes.
• PDCOMM_TCP_FRAME_LIMIT_EXCEEDED Macro — Frame error: the frame exceeds the frame limit.
• PDCOMM_TCP_FRAME_NEED_MORE Macro — Frame error: more bytes are needed.
• PDCOMM_TCP_FRAME_NOT_DATA Macro — Frame error: a data message was expected but the frame is a control message.
• PDCOMM_TCP_FRAME_READER_FAILED Macro — Frame error: the frame reader failed earlier and cannot continue.
• PDCOMM_TCP_FRAME_SECS_BODY Macro — Frame error: a data message body is not exactly one valid SECS-II item within PdcommTcpOptions::item_limits.
• PDCOMM_TCP_FRAME_TRAILING_DATA Macro — Frame error: bytes follow the frame.
• PDCOMM_TCP_FRAME_UNSUPPORTED_PTYPE Macro — Frame error: unsupported PType; PdcommTcpEventInfo::value1 holds it.
• PDCOMM_TCP_FRAME_UNSUPPORTED_STYPE Macro — Frame error: unsupported SType; PdcommTcpEventInfo::value1 holds it.
• PDCOMM_TCP_INCOMING_LIMIT Macro — Protocol error: a W-bit primary arrived while #PDCOMM_TCP_MAX_TRANSACTIONS received primaries were unanswered.
• PDCOMM_TCP_INVALID_FRAME Macro — Protocol error: a received frame is malformed.
• PDCOMM_TCP_INVALID_REJECT Macro — Protocol error: a Reject.req matches no open transaction, or its rejected type or session ID does not match the transaction.
• PDCOMM_TCP_INVALID_REPLY Macro — Protocol error code reserved for invalid replies; this version does not produce it.
• PDCOMM_TCP_IO_ABORTED Macro — I/O error kind: the connection was aborted.
• PDCOMM_TCP_IO_ADDRESS_IN_USE Macro — I/O error kind: the address is already in use.
• PDCOMM_TCP_IO_ADDRESS_UNAVAILABLE Macro — I/O error kind: the address is not available on this host.
• PDCOMM_TCP_IO_BROKEN_PIPE Macro — I/O error kind: the connection's write side is closed (broken pipe).
• PDCOMM_TCP_IO_INTERRUPTED Macro — I/O error kind: the operation was interrupted.
• PDCOMM_TCP_IO_INVALID_DATA Macro — I/O error kind: invalid data, including HSMS framing failures.
• PDCOMM_TCP_IO_INVALID_INPUT Macro — I/O error kind: an invalid parameter was passed to the operating system.
• PDCOMM_TCP_IO_NOT_CONNECTED Macro — I/O error kind: the socket is not connected.
• PDCOMM_TCP_IO_NOT_FOUND Macro — I/O error kind: an entity was not found.
• PDCOMM_TCP_IO_OTHER Macro — I/O error kind: any error without a more specific portable kind.
• PDCOMM_TCP_IO_PERMISSION Macro — I/O error kind: permission denied.
• PDCOMM_TCP_IO_REFUSED Macro — I/O error kind: the peer refused the connection.
• PDCOMM_TCP_IO_RESET Macro — I/O error kind: the peer reset the connection.
• PDCOMM_TCP_IO_TIMED_OUT Macro — I/O error kind: the operation timed out.
• PDCOMM_TCP_IO_UNEXPECTED_EOF Macro — I/O error kind: the stream ended unexpectedly.
• PDCOMM_TCP_IO_WOULD_BLOCK Macro — I/O error kind: the operation would block.
• PDCOMM_TCP_IO_WRITE_ZERO Macro — I/O error kind: a write accepted zero bytes.
• PDCOMM_TCP_LISTENING Macro — State: passive mode; waiting to accept a connection.
• PDCOMM_TCP_MAX_TRANSACTIONS Macro — Number of transaction slots per endpoint.
• PDCOMM_TCP_NOT_SELECTED Macro — State: TCP connected, HSMS NOT SELECTED.
• PDCOMM_TCP_OPTIONS_VERSION Macro — Required value of PdcommTcpOptions::version.
• PDCOMM_TCP_OP_ACCEPT Macro — Socket operation: accepting a connection (passive mode).
• PDCOMM_TCP_OP_BIND Macro — Socket operation: binding the passive listening socket.
• PDCOMM_TCP_OP_CONFIGURE Macro — Socket operation: configuring a socket (non-blocking mode, TCP_NODELAY) or allocating its buffers.
• PDCOMM_TCP_OP_CONNECT Macro — Socket operation: connecting to the peer (active mode).
• PDCOMM_TCP_OP_LOCAL_ADDRESS Macro — Socket operation: reading the local socket address.
• PDCOMM_TCP_OP_READ Macro — Socket operation: reading from the connection.
• PDCOMM_TCP_OP_WRITE Macro — Socket operation: writing to the connection.
• PDCOMM_TCP_PASSIVE Macro — Connection mode: the endpoint listens and accepts the peer's connection (HSMS passive entity).
• PDCOMM_TCP_PROTOCOL_ERROR Macro — Event kind: the peer violated the HSMS protocol.
• PDCOMM_TCP_RECEIVED Macro — Event kind: a data message (primary or reply) was received.
• PDCOMM_TCP_REJECTED Macro — Failure reason: the peer answered with Reject.req.
• PDCOMM_TCP_RETRY_WAIT Macro — State: active mode; waiting for the T5 connect separation timeout before the next attempt.
• PDCOMM_TCP_SELECTED Macro — State: HSMS SELECTED; data messages can be exchanged.
• PDCOMM_TCP_SELECT_STATUS Macro — Failure reason: Select.rsp carried a nonzero SelectStatus, stored in PdcommTcpEventInfo::value1.
• PDCOMM_TCP_STATE_CHANGED Macro — Event kind: the HSMS state changed.
• PDCOMM_TCP_STOPPED Macro — State: not started, or stopped by pdcomm_tcp_stop().
• PDCOMM_TCP_T3_TIMEOUT Macro — Failure reason: no reply to a W-bit data request within the T3 reply timeout.
• PDCOMM_TCP_T6_TIMEOUT Macro — Failure reason: no response to Select.req, Deselect.req, or Linktest.req within the T6 control transaction timeout.
• PDCOMM_TCP_TRANSPORT_ERROR Macro — Event kind: a socket operation failed.
• PDCOMM_TCP_UNEXPECTED_CONTROL Macro — Protocol error code reserved for unexpected control responses.
• PDCOMM_TCP_UNEXPECTED_REPLY Macro — Protocol error: a reply data message matches no open request, for example after a T3 timeout or a cancellation.
• PDCOMM_TCP_W0_WRITTEN Macro — Event kind: a primary sent without the W-bit was completely written to the local socket.
• PDCOMM_TCP_WRONG_SESSION Macro — Protocol error: a data message carries a session ID other than PdcommTcpOptions::session_id.
• PdcommGem300Capability Struct — Input description of one capability, read by pdcomm_gem300_capability_catalog_replace().
• axis Field — Axis: one of #PDCOMM_GEM300_PROCESS_JOB, #PDCOMM_GEM300_CARRIER, #PDCOMM_GEM300_SUBSTRATE, or #PDCOMM_GEM300_CONTROL_JOB; unique in the profile.
• id Field — Identifier bytes, not NUL-terminated; printable ASCII 0x21 to 0x7E.
• id_length Field — Number of bytes at id; nonzero and at most max_capability_id_bytes.
• reserved Field — Reserved; must be zero.
• status Field — Status label: #PDCOMM_GEM300_PLANNED, #PDCOMM_GEM300_MODEL_ONLY, or #PDCOMM_GEM300_EXPERIMENTAL.
• verification Field — Verification label; must be #PDCOMM_GEM300_UNVERIFIED.
• PdcommGem300CapabilityCatalog Typedef — Opaque, mutable capability catalog.
• PdcommGem300CapabilityCatalogInfo Struct — Totals of a catalog or snapshot, filled by pdcomm_gem300_capability_catalog_info() or pdcomm_gem300_capability_snapshot_info().
• capability_count Field — Number of capabilities across all profiles.
• identifier_bytes Field — Sum of all profile and capability identifier lengths in bytes.
• profile_count Field — Number of profiles.
• reserved Field — Reserved; set to zero before the call.
• revision Field — Catalog revision: 0 for a new catalog, incremented by each change.
• struct_size Field — Structure size in bytes.
• version Field — Structure version; set to #PDCOMM_GEM300_CAPABILITY_INFO_VERSION before the call.
• PdcommGem300CapabilityInfo Struct — Description of one snapshot capability, filled by pdcomm_gem300_capability_snapshot_capability_info().
• axis Field — Capability axis, one of the axis macros such as #PDCOMM_GEM300_PROCESS_JOB.
• id_length Field — Length of the capability identifier in bytes.
• reserved Field — Reserved; set to zero before the call.
• reserved2 Field — Reserved; set to zero before the call.
• status Field — Status label, one of #PDCOMM_GEM300_PLANNED, #PDCOMM_GEM300_MODEL_ONLY, or #PDCOMM_GEM300_EXPERIMENTAL.
• struct_size Field — Structure size in bytes.
• verification Field — Verification label; #PDCOMM_GEM300_UNVERIFIED, the defined value.
• version Field — Structure version; set to #PDCOMM_GEM300_CAPABILITY_INFO_VERSION before the call.
• PdcommGem300CapabilityOptions Struct — Catalog limits for pdcomm_gem300_capability_catalog_create().
• max_capabilities_per_profile Field — Largest number of capabilities in one profile; from 1 to 4, one per axis.
• max_capability_id_bytes Field — Largest capability identifier length in bytes.
• max_profile_id_bytes Field — Largest profile identifier length in bytes.
• max_profiles Field — Largest number of profiles in the catalog.
• max_total_capabilities Field — Largest number of capabilities across all profiles.
• max_total_identifier_bytes Field — Largest sum of all profile and capability identifier lengths in bytes.
• reserved Field — Reserved; must be zero.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGem300CapabilityOptions) or larger.
• version Field — Structure version; must be #PDCOMM_GEM300_CAPABILITY_OPTIONS_VERSION.
• PdcommGem300CapabilityProfile Struct — Input description of one profile, read by pdcomm_gem300_capability_catalog_replace().
• capabilities Field — Array of capability_count capabilities, in the order to keep.
• capability_count Field — Number of capabilities; from 1 to max_capabilities_per_profile.
• id Field — Identifier bytes, not NUL-terminated; printable ASCII 0x21 to 0x7E, unique in the catalog.
• id_length Field — Number of bytes at id; nonzero and at most max_profile_id_bytes.
• PdcommGem300CapabilityProfileInfo Struct — Description of one snapshot profile, filled by pdcomm_gem300_capability_snapshot_profile_info().
• capability_count Field — Number of capabilities in the profile.
• id_length Field — Length of the profile identifier in bytes.
• reserved Field — Reserved; set to zero before the call.
• struct_size Field — Structure size in bytes.
• version Field — Structure version; set to #PDCOMM_GEM300_CAPABILITY_INFO_VERSION before the call.
• PdcommGem300CapabilitySnapshot Typedef — Opaque, immutable, owned copy of a catalog's contents.
• PdcommGemAlarmChange Struct — Result of an alarm observation, filled by pdcomm_gem_equipment_observe_alarm().
• active Field — Alarm state after the observation: 1 for set, 0 for cleared.
• changed Field — 1 when the observation changed the alarm state, 0 when the state was already the observed one.
• event_id Field — CEID of the transition that occurred; 0 when event_present is 0.
• event_present Field — 1 when the transition has a configured set or clear CEID in event_id, otherwise 0 (always 0 without a transition).
• id Field — Alarm ID (ALID) that was observed.
• reporting_enabled Field — Snapshot of the reporting-enabled flag: 1 when an S5F1 report may be published for this alarm.
• struct_size Field — Structure size; set to sizeof(PdcommGemAlarmChange) or larger, receives the size written.
• PdcommGemAlarmDefinition Struct — One alarm definition passed to pdcomm_gem_equipment_configure_alarms().
• category Field — Alarm category, 1 to 63.
• clear_event Field — Collection event ID (CEID) linked to the clear transition; read only when clear_event_present is 1.
• clear_event_present Field — 1 when clear_event is present, otherwise 0.
• id Field — Alarm ID (ALID); must be unique within the store.
• set_event Field — Collection event ID (CEID) linked to the set transition; read only when set_event_present is 1.
• set_event_present Field — 1 when set_event is present, otherwise 0.
• text Field — Alarm text (ALTX) as ASCII bytes, not NUL-terminated; may be NULL when text_length is 0.
• text_length Field — Number of bytes at text.
• PdcommGemAlarmInfo Struct — Definition and current state of one stored alarm, filled by pdcomm_gem_equipment_alarm_at().
• active Field — 1 when the alarm is currently set, otherwise 0.
• category Field — Alarm category, 1 to 63.
• clear_event Field — Clear-transition CEID; 0 when clear_event_present is 0.
• clear_event_present Field — 1 when a clear-transition CEID is configured, otherwise 0.
• enabled Field — 1 when the Host has enabled reporting of this alarm, otherwise 0.
• id Field — Alarm ID (ALID).
• set_event Field — Set-transition CEID; 0 when set_event_present is 0.
• set_event_present Field — 1 when a set-transition CEID is configured, otherwise 0.
• struct_size Field — Structure size; set to sizeof(PdcommGemAlarmInfo) or larger, receives the size written.
• PdcommGemAlarmOptions Struct — Limits for the alarm store, passed to pdcomm_gem_equipment_configure_alarms().
• max_alarms Field — Largest number of alarm definitions; must be at least 1.
• max_text_bytes Field — Largest alarm text length of one alarm, in bytes; the effective limit is min(max_text_bytes, 120).
• max_total_text_bytes Field — Largest sum of the alarm text lengths of all alarms, in bytes.
• reserved Field — Reserved; must be 0.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemAlarmOptions) or larger.
• version Field — Options version; must be #PDCOMM_GEM_ALARM_OPTIONS_VERSION.
• PdcommGemAlarmResultInfo Struct — Summary of an alarm result, filled by pdcomm_gem_result_alarm_info().
• acknowledged Field — 1 after pdcomm_gem_host_acknowledge_alarm() sent S5F2 for this report; always 0 for list replies.
• count Field — Number of alarm entries: 1 for an S5F1 report, the list length for an S5F6 or S5F8 reply.
• is_report Field — 1 for a received S5F1 alarm report, 0 for an alarm list reply.
• reply_expected Field — W bit of the received S5F1 report; always 0 for list replies.
• struct_size Field — Structure size; set to sizeof(PdcommGemAlarmResultInfo) or larger, receives the size written.
• PdcommGemAlarmState Struct — Summary of the alarm store, filled by pdcomm_gem_equipment_alarm_state().
• active_count Field — Number of alarms currently set (active).
• alarm_count Field — Number of configured alarms.
• enabled_count Field — Number of alarms whose reporting the Host has enabled with S5F3.
• struct_size Field — Structure size; set to sizeof(PdcommGemAlarmState) or larger, receives the size written.
• text_bytes Field — Sum of the alarm text lengths of all alarms, in bytes.
• PdcommGemAlarmValue Struct — One alarm tuple from a received report or list, filled by pdcomm_gem_result_alarm_at().
• active Field — 1 when the ALCD alarm-set bit (0x80) is set, otherwise 0.
• category Field — Alarm category from the low six bits of ALCD (ALCD & 0x3F).
• id Field — Alarm ID (ALID).
• struct_size Field — Structure size; set to sizeof(PdcommGemAlarmValue) or larger, receives the size written.
• PdcommGemBindingInfo Struct — One binding, filled by pdcomm_gem_equipment_binding_at().
• source_id Field — Status variable ID or DVID; 0 for a CONSTANT source.
• source_kind Field — Source kind (PDCOMM_GEM_SOURCE_*).
• struct_size Field — Structure size in bytes; set before the call, receives the size written.
• vid Field — Variable ID (VID).
• PdcommGemBindingOptions Struct — Limits of an explicit report binding store.
• max_bindings Field — Largest number of bindings.
• max_identifier_bytes Field — Largest ASCII constant ID of one binding, in bytes (numeric IDs count as 0).
• max_total_identifier_bytes Field — Largest total of ASCII constant ID bytes across all bindings.
• reserved Field — Must be 0.
• struct_size Field — Structure size in bytes; set to sizeof(PdcommGemBindingOptions) or larger.
• version Field — Must be #PDCOMM_GEM_BINDING_OPTIONS_VERSION.
• PdcommGemBindingState Struct — Counters of the binding store, filled by pdcomm_gem_equipment_binding_state().
• binding_count Field — Number of bindings.
• explicit_mode Field — 1 when a binding store is installed (explicit mode, possibly empty); 0 for legacy VID-to-status resolution.
• identifier_bytes Field — Total ASCII constant ID bytes.
• struct_size Field — Structure size in bytes; set before the call, receives the size written.
• PdcommGemCommandDefinition Struct — Definition of one remote command (RCMD).
• completion_event Field — CEID reported to the application when the command is acknowledged with HCACK 0 or 4.
• completion_event_present Field — 1 when completion_event is present, otherwise 0.
• count Field — Number of parameter definitions; names must be unique within the command.
• name Field — RCMD item: nonempty ASCII or an integer scalar from -128 to 255; must not be NULL.
• parameters Field — Array of count parameter definitions; may be NULL when count is 0.
• require_online_remote Field — 1 to answer HCACK 2 unless the control state is ONLINE REMOTE at receipt, otherwise 0.
• PdcommGemCommandInfo Struct — Definition summary of one stored command.
• completion_event Field — Completion CEID; 0 when completion_event_present is 0.
• completion_event_present Field — 1 when a completion CEID is configured.
• parameter_count Field — Number of parameter definitions of the command.
• require_online_remote Field — 1 when the command requires the ONLINE REMOTE control state.
• struct_size Field — Structure size; set to sizeof(PdcommGemCommandInfo) or larger, receives the size written.
• PdcommGemCommandIssue Struct — One CPACK entry for an application S2F42 response.
• code Field — CPACK code: 1 name does not exist, 2 illegal value, 3 illegal format.
• name Field — CPNAME item (ASCII or integer scalar) that the entry refers to; must not be NULL.
• PdcommGemCommandOptions Struct — Limits for the remote command store, passed to pdcomm_gem_equipment_configure_commands().
• max_commands Field — Largest number of command definitions; must be at least 1.
• max_errors Field — Largest number of CPACK entries in a frozen validation or an application response.
• max_identifier_bytes Field — Largest length of one ASCII RCMD or CPNAME, in bytes; numeric names count as 0 bytes.
• max_parameters_per_command Field — Largest number of parameters of one command, in definitions and in a received S2F41.
• max_total_identifier_bytes Field — Largest sum of the ASCII name lengths of all configured commands and parameters, in bytes.
• max_total_parameters Field — Largest number of parameter definitions across all commands.
• reserved Field — Reserved; must be 0.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemCommandOptions) or larger.
• version Field — Options version; must be #PDCOMM_GEM_COMMAND_OPTIONS_VERSION.
• PdcommGemCommandParameter Struct — One CPNAME/CPVAL pair to send with pdcomm_gem_host_remote_command() or pdcomm_gem_host_enhanced_remote_command().
• name Field — CPNAME item (ASCII or integer scalar); must not be NULL.
• value Field — CPVAL (or CEPVAL) item, sent as a copy; must not be NULL.
• PdcommGemCommandParameterDefinition Struct — Definition of one remote command parameter (CPNAME and its CPVAL rules).
• format Field — Exact SECS-II format code required for the CPVAL item.
• format_present Field — 1 when format is enforced, otherwise 0.
• max_count Field — Largest allowed element count of the CPVAL item; must not be less than min_count.
• maximum Field — Inclusive upper bound for every integer element; read only when maximum_present is 1.
• maximum_present Field — 1 when maximum is enforced; requires an integer format.
• min_count Field — Smallest allowed element count of the CPVAL item (bytes for ASCII and Binary).
• minimum Field — Inclusive lower bound for every integer element; read only when minimum_present is 1.
• minimum_present Field — 1 when minimum is enforced; requires an integer format.
• name Field — CPNAME item (ASCII or integer scalar); borrowed for the call and must not be NULL.
• required Field — 1 when the parameter must be present in the request, otherwise 0.
• PdcommGemCommandParameterInfo Struct — Definition of one stored command parameter.
• format Field — Required SECS-II format code; 0 when format_present is 0.
• format_present Field — 1 when format is enforced.
• max_count Field — Largest allowed element count of the CPVAL item.
• maximum Field — Inclusive upper bound; 0 when maximum_present is 0.
• maximum_present Field — 1 when maximum is enforced.
• min_count Field — Smallest allowed element count of the CPVAL item.
• minimum Field — Inclusive lower bound; 0 when minimum_present is 0.
• minimum_present Field — 1 when minimum is enforced.
• required Field — 1 when the parameter is required.
• struct_size Field — Structure size; set to sizeof(PdcommGemCommandParameterInfo) or larger, receives the size written.
• PdcommGemCommandReply Struct — Outcome of a sent S2F42 or S2F50 response.
• acknowledgement Field — HCACK actually sent.
• completion_event Field — Completion CEID to report after the work completes; 0 when completion_event_present is 0.
• completion_event_present Field — 1 when the sent HCACK was 0 or 4 and the command has a completion CEID.
• struct_size Field — Structure size; set to sizeof(PdcommGemCommandReply) or larger, receives the size written.
• PdcommGemCommandResultInfo Struct — Summary of a remote command result, filled by pdcomm_gem_result_command_info().
• completion_event Field — Completion CEID of an accepted request; 0 when completion_event_present is 0.
• completion_event_present Field — 1 when an accepted request has a completion CEID.
• is_request Field — 1 for an Equipment-received S2F41 request, 0 for a Host-received S2F42 reply.
• issue_count Field — Number of frozen validation issues of a request, or of received CPACK entries of a reply.
• parameter_count Field — Number of CPNAME/CPVAL pairs of a received request; 0 for a reply.
• responded Field — 1 after pdcomm_gem_equipment_respond_command() sent S2F42 for the request.
• struct_size Field — Structure size; set to sizeof(PdcommGemCommandResultInfo) or larger, receives the size written.
• validation_accepted Field — 1 when the request passed validation at receipt; always 0 for a reply.
• validation_acknowledgement Field — HCACK frozen at receipt for a request (0 when accepted), or the received HCACK of a reply.
• PdcommGemCommandState Struct — Summary of the command store, filled by pdcomm_gem_equipment_command_state().
• command_count Field — Number of configured commands.
• identifier_bytes Field — Sum of the ASCII name lengths of all commands and parameters, in bytes.
• struct_size Field — Structure size; set to sizeof(PdcommGemCommandState) or larger, receives the size written.
• total_parameters Field — Number of parameter definitions across all commands.
• PdcommGemConstantChange Struct — One ECID/ECV pair for pdcomm_gem_host_change_constants().
• id Field — Constant ID (ECID): an ASCII item or a single-element integer item.
• value Field — New value (ECV).
• PdcommGemConstantChangeInfo Struct — Receipt and decision state of an S2F15 result, filled by pdcomm_gem_result_constant_change_info().
• applied Field — 1 when an EAC 0 reply with at least one pair swapped in the new values.
• change_count Field — Number of ECID/ECV pairs in the received S2F15; 0 for an S2F16 reply result.
• is_request Field — 1 for a received S2F15 on an Equipment; 0 for an S2F16 reply received by a Host.
• responded Field — 1 after pdcomm_gem_equipment_respond_constants() sent S2F16.
• struct_size Field — Structure size in bytes; set before the call, receives the size written.
• validation_accepted Field — 1 when every pair passed receipt validation against the constant store.
• validation_acknowledgement Field — EAC from receipt validation: 0 accepted, 1 unknown ECID, 3 invalid value or format.
• PdcommGemConstantDefinition Struct — Definition of one equipment constant for pdcomm_gem_equipment_configure_constants().
• current Field — Current value (ECV).
• default_value Field — Optional default value (ECDEF); NULL means absent.
• id Field — Constant ID (ECID): an ASCII item or a single-element integer item.
• max_count Field — Largest allowed element count; must be at least min_count.
• maximum Field — Optional maximum value (ECMAX); NULL means absent.
• min_count Field — Smallest allowed element count of current, default, and new values.
• minimum Field — Optional minimum value (ECMIN); NULL means absent.
• name Field — Name as ASCII bytes, not NUL-terminated.
• name_length Field — Number of bytes at name.
• units Field — Units as ASCII bytes, not NUL-terminated.
• units_length Field — Number of bytes at units.
• PdcommGemConstantInfo Struct — Definition summary of one constant, filled by pdcomm_gem_equipment_constant_at().
• default_present Field — 1 when a default value is defined, else 0.
• format Field — Format code of the current value.
• max_count Field — Largest allowed element count.
• maximum_present Field — 1 when a maximum value is defined, else 0.
• min_count Field — Smallest allowed element count.
• minimum_present Field — 1 when a minimum value is defined, else 0.
• struct_size Field — Structure size in bytes; set before the call, receives the size written.
• PdcommGemConstantOptions Struct — Limits of an Equipment constant store.
• item_limits Field — SECS-II limits for each stored value; every field must be nonzero.
• max_changes_per_request Field — Largest number of ECID/ECV pairs accepted in one incoming S2F15.
• max_constants Field — Largest number of constants; must be at least 1.
• max_identifier_bytes Field — Largest ASCII ECID length in bytes, for definitions and incoming requests.
• max_metadata_bytes Field — Largest total of ASCII ID, name, and units bytes across all constants.
• max_query_ids Field — Largest number of ECIDs accepted in one incoming S2F13 or S2F29.
• max_value_bytes Field — Largest total encoded size of current, default, minimum, and maximum values; must be at least 1.
• reserved Field — Must be 0.
• struct_size Field — Structure size in bytes; set to sizeof(PdcommGemConstantOptions) or larger.
• version Field — Must be #PDCOMM_GEM_CONSTANT_OPTIONS_VERSION.
• PdcommGemConstantReply Struct — Reply that pdcomm_gem_equipment_respond_constants() sent.
• acknowledgement Field — EAC sent in S2F16 (0 on failure).
• applied Field — 1 when the new values were applied to the store, else 0.
• struct_size Field — Structure size in bytes; set before the call, receives the size written.
• PdcommGemConstantState Struct — Counters of the constant store, filled by pdcomm_gem_equipment_constant_state().
• constant_count Field — Number of constants.
• metadata_bytes Field — Total ASCII ID, name, and units bytes.
• struct_size Field — Structure size in bytes; set before the call, receives the size written.
• value_bytes Field — Total encoded size of all stored values.
• PdcommGemDataDefinition Struct — Definition of one data variable for pdcomm_gem_equipment_configure_data_variables().
• cached Field — Optional initial cached value, copied; NULL leaves the cache empty.
• format Field — Required top-level format of every value, one of the PDCOMM_SECS_* format codes (List included).
• id Field — Data variable ID (DVID); unique within the store.
• max_count Field — Largest allowed element count; must be at least min_count.
• min_count Field — Smallest allowed element count (List children or primitive elements).
• name Field — Name as ASCII bytes, not NUL-terminated.
• name_length Field — Number of bytes at name.
• units Field — Units as ASCII bytes, not NUL-terminated.
• units_length Field — Number of bytes at units.
• PdcommGemDataInfo Struct — Definition summary of one data variable, filled by pdcomm_gem_equipment_data_at().
• cached_present Field — 1 when a value is cached, else 0.
• format Field — Declared format code.
• id Field — Data variable ID (DVID).
• max_count Field — Largest allowed element count.
• min_count Field — Smallest allowed element count.
• struct_size Field — Structure size in bytes; set before the call, receives the size written.
• PdcommGemDataOptions Struct — Limits of an Equipment data variable store.
• item_limits Field — SECS-II limits for each cached value and sample; every field must be nonzero.
• max_metadata_bytes Field — Largest total of name and units bytes across all variables.
• max_sample_bytes Field — Largest total encoded size of the samples supplied with one call, in bytes.
• max_samples_per_event Field — Largest number of samples supplied with one publication or query response.
• max_value_bytes Field — Largest total encoded size of all cached values, in bytes.
• max_variables Field — Largest number of data variables; must be at least 1.
• reserved Field — Must be 0.
• struct_size Field — Structure size in bytes; set to sizeof(PdcommGemDataOptions) or larger.
• version Field — Must be #PDCOMM_GEM_DATA_OPTIONS_VERSION.
• PdcommGemDataSample Struct — A data variable value sampled for one publication or query response.
• id Field — Data variable ID (DVID), not the report VID.
• value Field — Sampled value; borrowed for the call and never stored in the cache.
• PdcommGemDataState Struct — Counters of the data variable store, filled by pdcomm_gem_equipment_data_state().
• metadata_bytes Field — Total name and units bytes.
• struct_size Field — Structure size in bytes; set before the call, receives the size written.
• value_bytes Field — Total encoded size of the cached values.
• variable_count Field — Number of data variables.
• PdcommGemDirectoryEntryInfo Struct — One directory entry, filled by the *_directory_at functions.
• id Field — VID for a data variable entry, CEID for an event entry.
• struct_size Field — Structure size in bytes; set before the call, receives the size written.
• variable_count Field — Number of VIDs of an event entry; 0 for a data variable entry.
• PdcommGemDirectoryOptions Struct — Limits of an Equipment event directory.
• max_events Field — Largest number of event entries.
• max_metadata_bytes Field — Largest total of name bytes across all entries.
• max_name_bytes Field — Largest name of one entry, in bytes.
• max_total_variables Field — Largest total number of VIDs across all entries.
• max_variables_per_event Field — Largest number of VIDs in one entry.
• reserved Field — Must be 0.
• struct_size Field — Structure size in bytes; set to sizeof(PdcommGemDirectoryOptions) or larger.
• version Field — Must be #PDCOMM_GEM_DIRECTORY_OPTIONS_VERSION.
• PdcommGemDirectoryState Struct — Counters of the event directory, filled by pdcomm_gem_equipment_directory_state().
• configured Field — 1 when a directory is configured (possibly empty), else 0.
• event_count Field — Number of event entries.
• metadata_bytes Field — Total name bytes.
• struct_size Field — Structure size in bytes; set before the call, receives the size written.
• total_variables Field — Total number of VIDs across all entries.
• PdcommGemEnhancedCommandOptions Struct — Limits for the enhanced command store, passed to pdcomm_gem_equipment_configure_enhanced_commands().
• item_limits Field — SECS-II limits applied to each received CEPVAL item.
• max_commands_per_object Field — Largest number of commands of one object.
• max_errors Field — Largest number of nonzero CEPACK values in a frozen validation or an application response.
• max_identifier_bytes Field — Largest length of one ASCII RCMD or CPNAME, in bytes; numeric names count as 0 bytes.
• max_object_bytes Field — Largest length of one object name, in bytes, in definitions and in a received S2F49.
• max_objects Field — Largest number of objects (OBJSPEC values).
• max_parameters_per_command Field — Largest number of parameters of one command, in definitions and in a received S2F49.
• max_request_value_bytes Field — Largest sum of the encoded CEPVAL sizes of one received S2F49, in bytes.
• max_total_commands Field — Largest number of commands across all objects.
• max_total_identifier_bytes Field — Largest sum of the ASCII name lengths of all configured commands and parameters, in bytes.
• max_total_object_bytes Field — Largest sum of the lengths of all object names, in bytes.
• max_total_parameters Field — Largest number of parameter definitions across all commands.
• reserved Field — Reserved; must be 0.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemEnhancedCommandOptions) or larger.
• version Field — Options version; must be #PDCOMM_GEM_ENHANCED_COMMAND_OPTIONS_VERSION.
• PdcommGemEnhancedCommandResultInfo Struct — Summary of an enhanced command result, filled by pdcomm_gem_result_enhanced_command_info().
• completion_event Field — Completion CEID of an accepted request; 0 when completion_event_present is 0.
• completion_event_present Field — 1 when an accepted request has a completion CEID.
• data_id Field — DATAID of a received request; 0 for a reply.
• is_request Field — 1 for an Equipment-received S2F49 request, 0 for a Host-received S2F50 reply.
• issue_count Field — Number of outer acknowledgement entries: frozen errors of a request (0 when accepted), or received entries of a reply.
• parameter_count Field — Number of CPNAME/CEPVAL pairs of a received request; 0 for a reply.
• responded Field — 1 after pdcomm_gem_equipment_respond_enhanced_command() sent S2F50 for the request.
• struct_size Field — Structure size; set to sizeof(PdcommGemEnhancedCommandResultInfo) or larger, receives the size written.
• validation_accepted Field — 1 when the request passed admission at receipt; always 0 for a reply.
• validation_acknowledgement Field — HCACK frozen at receipt for a request (0 when accepted), or the received HCACK of a reply.
• PdcommGemEnhancedCommandState Struct — Summary of the enhanced command store, filled by pdcomm_gem_equipment_enhanced_command_state().
• command_count Field — Number of commands across all objects.
• identifier_bytes Field — Sum of the ASCII name lengths of all commands and parameters, in bytes.
• object_count Field — Number of configured objects.
• struct_size Field — Structure size; set to sizeof(PdcommGemEnhancedCommandState) or larger, receives the size written.
• total_object_bytes Field — Sum of the lengths of all object names, in bytes.
• total_parameters Field — Number of parameter definitions across all commands.
• PdcommGemEnhancedObjectDefinition Struct — Definition of one object (OBJSPEC) and its commands.
• commands Field — Array of count command definitions; may be NULL when count is 0.
• count Field — Number of command definitions; RCMD names must be unique within the object.
• name Field — Object name: an ASCII item, possibly empty; must not be NULL and must be unique.
• PdcommGemEnhancedObjectInfo Struct — Summary of one stored object, filled by pdcomm_gem_equipment_enhanced_object_at().
• command_count Field — Number of commands of the object.
• struct_size Field — Structure size; set to sizeof(PdcommGemEnhancedObjectInfo) or larger, receives the size written.
• PdcommGemEquipmentOptions Struct — Options for pdcomm_gem_configure_equipment().
• initial_control Field — Initial control state.
• item_limits Field — SECS-II limits for every message the equipment builds or parses.
• max_metadata_bytes Field — Largest total size in bytes of all registered status variable names and units; may be 0.
• max_value_bytes Field — Largest total encoded size in bytes of all registered status variable values; must be nonzero.
• max_variables Field — Largest number of registered status variables; must be nonzero.
• model Field — Equipment model type (MDLN) as ASCII bytes, without a terminator; may be NULL when model_length is 0.
• model_length Field — Number of bytes at model.
• online_mode Field — Online mode, #PDCOMM_GEM_LOCAL or #PDCOMM_GEM_REMOTE: the ON-LINE substate entered when going on-line.
• reserved Field — Reserved; must be 0.
• software_revision Field — Software revision (SOFTREV) as ASCII bytes, without a terminator; may be NULL when software_revision_length is 0.
• software_revision_length Field — Number of bytes at software_revision.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemEquipmentOptions) or larger.
• version Field — Options version; must be #PDCOMM_GEM_OPTIONS_VERSION.
• PdcommGemEventDefinition Struct — One collection event entry for pdcomm_gem_equipment_configure_event_directory().
• id Field — Collection event ID (CEID); unique and registered in the report store.
• name Field — Event name (CENAME) as ASCII bytes, not NUL-terminated; may be empty.
• name_length Field — Number of bytes at name.
• variable_count Field — Number of elements in variable_ids.
• variable_ids Field — Array of variable_count unique VIDs; each must be bound to a data variable.
• PdcommGemEventInfo Struct — Header of a received event report (S6F11), filled by pdcomm_gem_result_event_info().
• acknowledged Field — 1 after pdcomm_gem_host_acknowledge_event() sent S6F12 for this result, otherwise 0.
• data_id Field — DATAID of the report message.
• event_id Field — Collection event ID (CEID) that was reported.
• report_count Field — Number of reports in the message.
• struct_size Field — Structure size in bytes.
• PdcommGemFixedEventSpec Struct — One collection event of a fixed report catalog.
• count Field — Number of elements in report_ids; 0 registers the event without links.
• enabled Field — 1 to enable the event report initially, 0 to leave it disabled.
• event_id Field — Collection event ID (CEID).
• report_ids Field — Array of count report IDs linked to the event.
• PdcommGemFormattedProgramCapabilityCommand Struct — One command definition passed to pdcomm_gem_formatted_program_capability_catalog_replace().
• after_dependency Field — ACDS: the single U2 value sent as the after-command field.
• before_dependencies Field — BCDS values; stored and sent verbatim.
• before_dependency_count Field — Number of values in before_dependencies.
• block_definition Field — BLKDEF block definition: +1, 0, or -1 as defined by SEMI E5.
• code Field — CCODE command code: ASCII bytes, at most max_command_code_bytes long.
• code_length Field — Length of code in bytes.
• immediate_after_dependencies Field — IACDS values; stored and sent verbatim.
• immediate_after_dependency_count Field — Number of values in immediate_after_dependencies.
• immediate_before_dependencies Field — IBCDS values; stored and sent verbatim.
• immediate_before_dependency_count Field — Number of values in immediate_before_dependencies.
• name Field — CNAME command name: ASCII bytes, at most 16 long.
• name_length Field — Length of name in bytes.
• non_after_dependencies Field — NACDS values; stored and sent verbatim.
• non_after_dependency_count Field — Number of values in non_after_dependencies.
• non_before_dependencies Field — NBCDS values; stored and sent verbatim.
• non_before_dependency_count Field — Number of values in non_before_dependencies.
• parameter_count Field — Number of handles in parameters.
• parameters Field — Parameter descriptors as live SECS-II item handles.
• required Field — RQCMD: 1 when the command is required in every program, 0 otherwise.
• reserved Field — Reserved; all bytes must be 0.
• PdcommGemFormattedProgramCapabilityCommandInfo Struct — Fixed-size fields of one capability command, filled by pdcomm_gem_result_formatted_program_capability_command_info().
• after_dependency Field — ACDS value.
• before_dependency_count Field — Number of BCDS values.
• block_definition Field — BLKDEF block definition: +1, 0, or -1.
• immediate_after_dependency_count Field — Number of IACDS values.
• immediate_before_dependency_count Field — Number of IBCDS values.
• non_after_dependency_count Field — Number of NACDS values.
• non_before_dependency_count Field — Number of NBCDS values.
• parameter_count Field — Number of parameter descriptors.
• required Field — RQCMD: 1 when the command is required.
• reserved Field — Reserved; written as 0.
• struct_size Field — Structure size; set to sizeof(PdcommGemFormattedProgramCapabilityCommandInfo) or larger.
• PdcommGemFormattedProgramCapabilityInfo Struct — Summary of a capability result, filled by pdcomm_gem_result_formatted_program_capability_info().
• byte_maximum Field — BYTMAX: maximum process program size in bytes; 0 when the result holds no capability.
• command_count Field — Number of commands in the capability; 0 when the result holds no capability.
• command_maximum Field — CMDMAX: maximum number of commands in a process program; 0 when the result holds no capability.
• is_request Field — 1 when the result is a received S7F21 request (equipment side), 0 for host data results.
• reply_ready Field — 1 when the result is a received request that still needs pdcomm_gem_formatted_program_capability_respond().
• request_kind Field — GEM request kind copied from the result, normally #PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_SEND.
• reserved Field — Reserved; written as 0.
• responded Field — 1 when S7F22 has been sent for a received request, or for a host data result.
• struct_size Field — Structure size; set to sizeof(PdcommGemFormattedProgramCapabilityInfo) or larger.
• PdcommGemFormattedProgramCapabilityOptions Struct — Limits for the formatted program capability service.
• max_capability_bytes Field — Largest encoded size of the whole S7F22 capability body, in bytes.
• max_command_code_bytes Field — Largest CCODE (command code) length in bytes.
• max_commands Field — Largest number of commands in one capability.
• max_dependencies_per_field Field — Largest number of values in one dependency vector (BCDS, IBCDS, NBCDS, IACDS, or NACDS).
• max_history Field — Number of finished transactions remembered for replay detection; must be nonzero.
• max_parameters_per_command Field — Largest number of parameter descriptors in one command.
• max_pending Field — Largest number of S7F21 requests the host can have outstanding; must be nonzero.
• max_received Field — Largest number of received S7F21 requests the equipment can hold unanswered; must be nonzero.
• max_results Field — Number of completed host results the service retains; must be nonzero.
• max_total_dependencies Field — Largest number of dependency values across all commands; each command's ACDS value counts as one.
• max_total_parameter_bytes Field — Largest total encoded size of all parameter descriptors, in bytes.
• max_total_parameters Field — Largest number of parameter descriptors across all commands.
• reserved Field — Reserved; must be 0.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemFormattedProgramCapabilityOptions) or larger.
• version Field — Must be #PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_OPTIONS_VERSION.
• PdcommGemFormattedProgramDryRunInfo Struct — Summary of a dry-run report, filled by pdcomm_gem_formatted_program_dry_run_info().
• capability_present Field — 1 when a capability catalog was installed at analysis time.
• capability_revision Field — Capability catalog revision at analysis time (0 when capabilities are not configured).
• command_count Field — Number of commands in the program.
• encoded_bytes Field — Encoded size of the program body (PPID, MDLN, SOFTREV, and commands) in bytes.
• endpoint_id Field — Identifier of the endpoint that produced the report.
• entry_generation Field — Store entry generation captured by the selection.
• id_format Field — SECS-II format code of the program identifier (#PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY).
• issue_count Field — Number of issues in the report.
• outcome Field — Overall outcome: a PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_* outcome value.
• policy_version Field — Policy version used for the analysis.
• reserved Field — Input: must be zero; written as zero.
• selection_generation Field — Selection generation of the analyzed selection token.
• session_generation Field — HSMS session generation of the analyzed selection.
• store_revision Field — Program store revision captured by the selection.
• struct_size Field — Input: size of this structure, at least sizeof(PdcommGemFormattedProgramDryRunInfo).
• version Field — Input: must be #PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_INFO_VERSION.
• PdcommGemFormattedProgramDryRunIssueInfo Struct — One dry-run issue, filled by pdcomm_gem_formatted_program_dry_run_issue_info().
• code Field — Issue code, one of the PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_* issue codes (1 to 11).
• command_index Field — Program or catalog command index, as described by the issue code.
• expected Field — Expected limit (CMDMAX or BYTMAX), as described by the issue code.
• field_index Field — Field index within the command; not used by policy version 1.
• observed Field — Observed count or size, as described by the issue code.
• outcome Field — Outcome contributed by this issue (indeterminate or reject).
• presence_mask Field — Bit set of PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ISSUE_*_PRESENT flags.
• reserved Field — Input: must be 0; written as 0.
• struct_size Field — Input: size of this structure, at least sizeof(PdcommGemFormattedProgramDryRunIssueInfo).
• version Field — Input: must be #PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ISSUE_INFO_VERSION.
• PdcommGemFormattedProgramDryRunOptions Struct — Options for pdcomm_gem_formatted_program_dry_run().
• max_issues Field — Largest number of issues the report may hold; more issues fail the call with #PDCOMM_LIMIT_EXCEEDED.
• max_program_encoded_bytes Field — Largest encoded program size in bytes; a larger program fails the call with #PDCOMM_LIMIT_EXCEEDED.
• policy_version Field — Analysis policy; must be #PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_POLICY_V1.
• reserved Field — Reserved; must be 0.
• reserved2 Field — Reserved; must be 0.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemFormattedProgramDryRunOptions) or larger.
• version Field — Must be #PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_OPTIONS_VERSION.
• PdcommGemFormattedProgramDryRunReportHandle Typedef — Opaque, immutable dry-run report.
• PdcommGemFormattedProgramExecutionActionHandle Typedef — Opaque, immutable copy of one execution action.
• PdcommGemFormattedProgramExecutionActionInfo Struct — Description of an action, filled by pdcomm_gem_formatted_program_execution_action_info().
• action_sequence Field — Action sequence number; copy into the action token.
• cancel_next_command_index Field — Cancel only: index of the first command that was not applied.
• capability_revision Field — Start only: capability catalog revision of the admitting dry run.
• code_format Field — Step only: SECS-II format code of the command code (#PDCOMM_SECS_ASCII, #PDCOMM_SECS_U1, #PDCOMM_SECS_U2, #PDCOMM_SECS_U4, or #PDCOMM_SECS_U8).
• command_count Field — Number of commands in the program, for every kind.
• command_index Field — Step only: zero-based index of the command to apply.
• dry_run_outcome Field — Start only: outcome of the admitting dry run.
• endpoint_id Field — Endpoint identifier; copy into the action token.
• execution_generation Field — Execution generation; copy into the action token.
• id_format Field — Start only: SECS-II format code of the program identifier.
• kind Field — Action kind: START, STEP, or CANCEL.
• parameter_count Field — Step only: number of parameters of the command.
• policy_version Field — Start only: dry-run policy version.
• presence_mask Field — Bit set of action presence flags.
• reserved Field — Input: must be zero; written as zero.
• session_generation Field — HSMS session generation; copy into the action token.
• struct_size Field — Input: size of this structure, at least sizeof(PdcommGemFormattedProgramExecutionActionInfo).
• version Field — Input: must be #PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_INFO_VERSION.
• PdcommGemFormattedProgramExecutionActionToken Struct — Identifies one action of an execution.
• action_sequence Field — Action sequence number: 1 for Start, then increasing for each new Step or Cancel.
• endpoint_id Field — Endpoint identifier of the execution.
• execution_generation Field — Execution generation of the execution.
• kind Field — Action kind: START, STEP, or CANCEL.
• reserved Field — Reserved; must be 0.
• session_generation Field — HSMS session generation of the execution.
• struct_size Field — Size of this structure; set to sizeof(PdcommGemFormattedProgramExecutionActionToken) or larger.
• version Field — Must be #PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_TOKEN_VERSION.
• PdcommGemFormattedProgramExecutionInfo Struct — State of the endpoint's execution, filled by pdcomm_gem_formatted_program_execution_snapshot_info().
• application_detail_length Field — Length of the terminal report's detail bytes, or 0.
• application_report_id Field — Application-defined identifier of the recorded terminal report, or 0.
• application_report_kind Field — Kind of the recorded terminal report (a TERMINAL_* value), or 0 when none was recorded.
• capability_present Field — 1 when a capability catalog was installed at dry-run time.
• capability_revision Field — Capability catalog revision of the admitting dry run.
• command_count Field — Number of commands in the executed program.
• dry_run_outcome Field — Outcome of the admitting dry run (PASS or INDETERMINATE); 0 in the EMPTY state.
• endpoint_id Field — Endpoint identifier from the execution token.
• entry_generation Field — Store entry generation captured by the admitted selection.
• execution_generation Field — Execution generation from the execution token.
• id_format Field — SECS-II format code of the program identifier (#PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY); 0 in the EMPTY state.
• next_command_index Field — Number of commands applied so far, which is also the index of the next command.
• pending_action_sequence Field — Sequence number of the pending action, or 0.
• pending_kind Field — Kind of the pending action, or #PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_NONE.
• policy_version Field — Dry-run policy version of the admitting report; 0 in the EMPTY state.
• presence_mask Field — Bit set of snapshot presence flags.
• reserved Field — Input: must be zero; written as zero.
• selection_generation Field — Selection generation of the admitted selection.
• session_generation Field — HSMS session generation from the execution token.
• state Field — Execution state, a PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_* state value.
• store_revision Field — Program store revision captured by the admitted selection.
• struct_size Field — Input: size of this structure, at least sizeof(PdcommGemFormattedProgramExecutionInfo).
• version Field — Input: must be #PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_INFO_VERSION.
• PdcommGemFormattedProgramExecutionSnapshotHandle Typedef — Opaque, immutable snapshot of the endpoint's execution state.
• PdcommGemFormattedProgramExecutionToken Struct — Identifies one execution on one endpoint.
• endpoint_id Field — Identifier of the endpoint that started the execution.
• execution_generation Field — Execution generation; increases by one for each started execution.
• reserved Field — Reserved; must be 0.
• session_generation Field — HSMS session generation at start.
• struct_size Field — Size of this structure; set to sizeof(PdcommGemFormattedProgramExecutionToken) or larger.
• version Field — Must be #PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_TOKEN_VERSION.
• PdcommGemFormattedProgramInfo Struct — Summary of a verification report result, filled by pdcomm_gem_result_formatted_program_info().
• id_format Field — Format of the PPID: #PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY; 0 when the result has no report.
• is_request Field — 1 when the result is a received S7F27 primary (host side), 0 for an S7F28 acknowledge.
• issue_count Field — Number of issues in the received report; 0 for an S7F28 acknowledge result.
• reply_ready Field — 1 when the result is an S7F27 primary that still needs pdcomm_gem_formatted_program_respond().
• request_kind Field — GEM request kind, #PDCOMM_GEM_FORMATTED_PROGRAM_SEND for these results.
• responded Field — 1 when S7F28 has been sent for this primary, or the result is itself an acknowledge.
• struct_size Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramInfo).
• PdcommGemFormattedProgramIssue Struct — One verification issue of an S7F27 report.
• code Field — ACKC7A code, from 0 to 5.
• length Field — Length of text in bytes.
• sequence Field — SEQNUM: the number of the process program command the issue refers to; sent as U4.
• text Field — ERRW7 text as ASCII bytes, not NUL-terminated.
• PdcommGemFormattedProgramOptions Struct — Limits for the S7F27/S7F28 verification report service.
• max_history Field — Number of completed transactions remembered to reject replays; the oldest is discarded first.
• max_issue_text_bytes Field — Largest ERRW7 text of a single issue, in bytes.
• max_issues Field — Largest number of issues in one S7F27 report; 0 allows only reports without issues.
• max_pending Field — Largest number of sent S7F27 reports awaiting S7F28; must be nonzero.
• max_received Field — Largest number of received S7F27 reports awaiting a reply; must be nonzero.
• max_results Field — Number of completed report outcomes the service retains; the oldest is discarded first.
• max_total_issue_text_bytes Field — Largest sum of all ERRW7 text lengths in one report, in bytes.
• reserved Field — Reserved; must be 0.
• struct_size Field — Size of this structure in bytes; at least sizeof(PdcommGemFormattedProgramOptions).
• version Field — Options layout version; must be #PDCOMM_GEM_FORMATTED_PROGRAM_OPTIONS_VERSION.
• PdcommGemFormattedProgramQueryCommand Struct — One process command (CCODE and PPARM list) passed to pdcomm_gem_formatted_program_query_seed().
• code Field — CCODE item; must be a non-NULL ASCII item.
• parameter_count Field — Number of PPARM items in parameters.
• parameters Field — Array of parameter_count PPARM items of any format; NULL when the count is 0.
• PdcommGemFormattedProgramQueryInfo Struct — Summary of a query result, filled by pdcomm_gem_result_formatted_program_query_info().
• command_count Field — Number of process commands in the returned program; 0 when no program is present.
• id_format Field — Format of the requested PPID, #PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY.
• is_request Field — 1 when the result is a received S7F25 primary (equipment side), 0 for an S7F26 result.
• present Field — 1 when the answer contains the program; 0 when it is absent or not yet known.
• present_known Field — 1 when the answer is known: always for an S7F26 result, and after the reply for a received S7F25.
• reply_ready Field — 1 when the result is an S7F25 primary that still needs pdcomm_gem_formatted_program_query_respond().
• request_kind Field — GEM request kind, #PDCOMM_GEM_FORMATTED_PROGRAM_QUERY_SEND for these results.
• reserved Field — Reserved; written as zero.
• responded Field — 1 when S7F26 has been sent for this primary, or the result is itself an S7F26.
• struct_size Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramQueryInfo).
• PdcommGemFormattedProgramQueryOptions Struct — Limits for the S7F25/S7F26 service and the Equipment program store.
• max_catalog_entries Field — Largest number of programs in the store.
• max_catalog_identifier_bytes Field — Largest sum of the PPID lengths of all stored programs, in bytes.
• max_commands Field — Largest number of process commands in one program; must be below SIZE_MAX - 1.
• max_history Field — Number of completed transactions remembered to reject replays; the oldest is discarded first.
• max_parameters_per_command Field — Largest number of PPARM items in one command.
• max_pending Field — Largest number of sent S7F25 requests awaiting S7F26; must be nonzero.
• max_received Field — Largest number of received S7F25 requests awaiting a reply; must be nonzero.
• max_results Field — Number of completed query outcomes the service retains; the oldest is discarded first.
• max_total_parameter_bytes Field — Largest sum of the encoded sizes of all PPARM items in one program, in bytes.
• max_total_parameters Field — Largest number of PPARM items in one program.
• reserved Field — Reserved; must be 0.
• struct_size Field — Size of this structure in bytes; at least sizeof(PdcommGemFormattedProgramQueryOptions).
• version Field — Options layout version; must be #PDCOMM_GEM_FORMATTED_PROGRAM_QUERY_OPTIONS_VERSION.
• PdcommGemFormattedProgramSelectionInfo Struct — Summary of a selection snapshot, filled by pdcomm_gem_formatted_program_selection_snapshot_info().
• command_count Field — Number of process commands in the selected program; 0 when none is selected.
• entry_generation Field — Entry generation captured at selection; 0 when no program is selected.
• id_format Field — PPID format, #PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY; 0 when no program is selected.
• reserved Field — Reserved; all bytes must be 0 before the call and are written as zero.
• selection_generation Field — Selection revision of the selection, or the current revision when no program is selected.
• session_generation Field — Session generation of the selection; 0 when no program is selected.
• stale_reason Field — For the STALE state, one of the reasons 1 to 4; otherwise #PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_NONE.
• state Field — Selection state: #PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_EMPTY, _READY, or _STALE.
• store_revision Field — Store revision captured at selection; 0 when no program is selected.
• struct_size Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramSelectionInfo).
• valid_for_execution Field — 1 when the state was READY at snapshot time.
• version Field — Set to #PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_INFO_VERSION before the call.
• PdcommGemFormattedProgramSelectionSnapshot Typedef — Opaque, immutable, owned copy of the selection state and program.
• PdcommGemFormattedProgramSelectionToken Struct — Identity of one selection, returned by pdcomm_gem_formatted_program_select().
• endpoint_id Field — Identity of the endpoint that made the selection.
• entry_generation Field — Generation of the selected store entry at the time of selection.
• reserved Field — Set to 0.
• selection_generation Field — Selection revision; increases with every new selection and every clear.
• session_generation Field — HSMS session generation in which the selection was made.
• store_revision Field — Store revision at the time of selection.
• struct_size Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramSelectionToken).
• version Field — Set to #PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_TOKEN_VERSION.
• PdcommGemFormattedProgramStoreCommand Struct — One process command (CCODE and PPARM list) passed to pdcomm_gem_formatted_program_store_put().
• code Field — CCODE item: ASCII, or a single-element U1, U2, U4, or U8 item.
• parameter_count Field — Number of PPARM items in parameters.
• parameters Field — Array of parameter_count PPARM items of any format; NULL when the count is 0.
• PdcommGemFormattedProgramStoreEntryInfo Struct — Summary of one program in a store snapshot, filled by pdcomm_gem_formatted_program_store_entry_info().
• command_count Field — Number of process commands in the program.
• id_format Field — PPID format: #PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY.
• reserved Field — Set to 0 before the call.
• reserved_bytes Field — Reserved; written as zero.
• struct_size Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramStoreEntryInfo).
• version Field — Set to #PDCOMM_GEM_FORMATTED_PROGRAM_STORE_INFO_VERSION before the call.
• PdcommGemFormattedProgramStoreInfo Struct — Store totals and limits, filled by pdcomm_gem_formatted_program_store_info() and pdcomm_gem_formatted_program_store_snapshot_info().
• encoded_bytes Field — Sum of the encoded S7F23 body sizes of all stored programs, in bytes.
• entry_count Field — Number of stored programs.
• identifier_bytes Field — Sum of the PPID lengths of all stored programs, in bytes.
• max_encoded_bytes Field — Largest encoded_bytes: the endpoint's SECS-II message_bytes limit times max_entries.
• max_entries Field — Largest number of programs; the query option max_catalog_entries.
• max_identifier_bytes Field — Largest identifier_bytes; the query option max_catalog_identifier_bytes.
• reserved Field — Set to 0 before the call.
• revision Field — Store revision: 0 for a new store, increased by one for every change that alters the stored programs.
• struct_size Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramStoreInfo).
• version Field — Set to #PDCOMM_GEM_FORMATTED_PROGRAM_STORE_INFO_VERSION before the call.
• PdcommGemFormattedProgramStoreSnapshot Typedef — Opaque, immutable, owned copy of the whole program store.
• PdcommGemFormattedProgramTransferCommand Struct — One process command (CCODE and PPARM list) passed to pdcomm_gem_formatted_program_transfer_submit().
• code Field — CCODE item; must be a non-NULL ASCII item for an outgoing S7F23.
• parameter_count Field — Number of PPARM items in parameters.
• parameters Field — Array of parameter_count PPARM items of any format; NULL when the count is 0.
• PdcommGemFormattedProgramTransferInfo Struct — Summary of a transfer result, filled by pdcomm_gem_result_formatted_program_transfer_info().
• acknowledgement Field — ACKC7 code: the code received in S7F24, or the code this side sent for a received S7F23.
• acknowledgement_present Field — 1 when acknowledgement holds a code.
• command_count Field — Number of process commands in the received program; 0 for an S7F24 result.
• id_format Field — PPID format, #PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY; 0 when the result carries no program.
• is_request Field — 1 when the result is a received S7F23 primary (equipment side), 0 for an S7F24 result.
• reply_ready Field — 1 when the result is an S7F23 primary that still needs an S7F24 reply.
• request_kind Field — GEM request kind, #PDCOMM_GEM_FORMATTED_PROGRAM_TRANSFER_SEND for these results.
• reserved Field — Reserved; written as zero.
• responded Field — 1 when S7F24 has been sent for this primary, or the result is itself an S7F24.
• struct_size Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramTransferInfo).
• PdcommGemFormattedProgramTransferOptions Struct — Limits for the S7F23/S7F24 transfer service.
• max_commands Field — Largest number of process commands in one program.
• max_history Field — Number of completed transactions remembered to reject replays; the oldest is discarded first.
• max_parameters_per_command Field — Largest number of PPARM items in one command.
• max_pending Field — Largest number of sent S7F23 messages awaiting S7F24; must be nonzero.
• max_received Field — Largest number of received S7F23 messages awaiting a reply; must be nonzero.
• max_results Field — Number of completed transfer outcomes the service retains; the oldest is discarded first.
• max_total_parameter_bytes Field — Largest sum of the encoded sizes of all PPARM items in one program, in bytes.
• max_total_parameters Field — Largest number of PPARM items in one program.
• reserved Field — Reserved; must be 0.
• struct_size Field — Size of this structure in bytes; at least sizeof(PdcommGemFormattedProgramTransferOptions).
• version Field — Options layout version; must be #PDCOMM_GEM_FORMATTED_PROGRAM_TRANSFER_OPTIONS_VERSION.
• PdcommGemFormattedProgramVerificationNegotiationInfo Struct — Negotiation details of a GEM result, filled by pdcomm_gem_result_formatted_program_verification_negotiation_info().
• correlation Field — Sequence number shared by every result of the same negotiation on this endpoint.
• length Field — LENGTH: byte length of the S7F27 body, computed by the equipment or received by the host.
• negotiation_terminal Field — Outcome of the S7F29/S7F30 exchange, a TERMINAL_* value.
• pp_gnt Field — PPGNT grant code; valid only when pp_gnt_present is 1. 0 means granted.
• pp_gnt_present Field — 1 when a PPGNT code was sent (host) or received (equipment).
• prepared Field — 1 for equipment-side records, 0 for host-side S7F29 records.
• reply_ready Field — 1 when the result is a host-side inquiry that still needs pdcomm_gem_formatted_program_verification_respond().
• request_kind Field — GEM request kind copied from the result; see #PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_SEND.
• reserved Field — Reserved; written as 0.
• responded Field — 1 when the host has answered the inquiry with S7F30.
• state Field — Record state, a PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_STATE_* value.
• struct_size Field — Structure size; set to sizeof(PdcommGemFormattedProgramVerificationNegotiationInfo) or larger.
• submitted Field — 1 when the equipment has sent the S7F29 inquiry for this negotiation.
• verification_terminal Field — Outcome of the S7F27/S7F28 exchange after a grant, a TERMINAL_* value (GRANTED means acknowledged).
• PdcommGemFormattedProgramVerificationNegotiationIssue Struct — One issue of the S7F27 report passed to pdcomm_gem_formatted_program_verification_prepare().
• code Field — ACKC7A acknowledgement code, from 0 to 5 as defined by SEMI E5; other values are rejected.
• sequence Field — SEQNUM: the process program command sequence number the issue refers to.
• text Field — ERRW7 error text: ASCII bytes, copied.
• text_length Field — Length of text in bytes.
• PdcommGemFormattedProgramVerificationNegotiationOptions Struct — Limits for the verification negotiation service.
• max_history Field — Number of finished negotiations remembered for replay detection; must be nonzero.
• max_issue_text_bytes Field — Largest ERRW7 text length of one issue, in bytes.
• max_issues Field — Largest number of issues in a prepared S7F27 report.
• max_pending Field — Largest number of submitted equipment-side negotiations awaiting a grant or acknowledgement; must be nonzero.
• max_prepared Field — Largest number of unfinished equipment-side negotiations (prepared, submitted, or granted); must be nonzero.
• max_received Field — Largest number of unanswered host-side S7F29 inquiries; must be nonzero.
• max_results Field — Number of finished negotiations the service retains; must be nonzero.
• max_total_issue_text_bytes Field — Largest total ERRW7 text length of all issues, in bytes.
• reserved Field — Reserved; must be 0.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemFormattedProgramVerificationNegotiationOptions) or larger.
• version Field — Must be #PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_OPTIONS_VERSION.
• PdcommGemFormattedProgramVerificationRequestCommand Struct — One process command (CCODE and PPARM list) passed to pdcomm_gem_formatted_program_verification_request_submit().
• code Field — CCODE item; must be a non-NULL ASCII item for an outgoing S7F31.
• parameter_count Field — Number of PPARM items in parameters.
• parameters Field — Array of parameter_count PPARM items of any format; NULL when the count is 0.
• PdcommGemFormattedProgramVerificationRequestInfo Struct — Summary of a verification request result, filled by pdcomm_gem_result_formatted_program_verification_request_info().
• acknowledgement Field — ACKC7 code: the code received in S7F32, or the code this side sent for a received S7F31.
• acknowledgement_present Field — 1 when acknowledgement holds a code.
• command_count Field — Number of process commands in the received program; 0 for an S7F32 result.
• id_format Field — PPID format, #PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY; 0 when the result carries no program.
• is_request Field — 1 when the result is a received S7F31 primary (equipment side), 0 for an S7F32 result.
• reply_ready Field — 1 when the result is an S7F31 primary that still needs an S7F32 reply.
• request_kind Field — GEM request kind, #PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_REQUEST_SEND for these results.
• reserved Field — Reserved; written as zero.
• responded Field — 1 when S7F32 has been sent for this primary, or the result is itself an S7F32.
• struct_size Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramVerificationRequestInfo).
• PdcommGemFormattedProgramVerificationRequestOptions Struct — Limits for the S7F31/S7F32 verification request service.
• max_commands Field — Largest number of process commands in one program.
• max_history Field — Number of completed transactions remembered to reject replays; the oldest is discarded first.
• max_parameters_per_command Field — Largest number of PPARM items in one command.
• max_pending Field — Largest number of sent S7F31 requests awaiting S7F32; must be nonzero.
• max_received Field — Largest number of received S7F31 requests awaiting a reply; must be nonzero.
• max_results Field — Number of completed request outcomes the service retains; the oldest is discarded first.
• max_total_parameter_bytes Field — Largest sum of the encoded sizes of all PPARM items in one program, in bytes.
• max_total_parameters Field — Largest number of PPARM items in one program.
• reserved Field — Reserved; must be 0.
• struct_size Field — Size of this structure in bytes; at least sizeof(PdcommGemFormattedProgramVerificationRequestOptions).
• version Field — Options layout version; must be #PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_REQUEST_OPTIONS_VERSION.
• PdcommGemHostOptions Struct — Options for pdcomm_gem_configure_host().
• item_limits Field — SECS-II limits for every message the host builds or parses; item_limits.struct_size must be valid.
• max_pending_ids Field — Largest total number of identifiers copied by pending host requests.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemHostOptions) or larger.
• version Field — Options version; must be #PDCOMM_GEM_OPTIONS_VERSION.
• PdcommGemInt128 Struct — Signed 128-bit integer split into two 64-bit halves.
• high Field — High 64 bits of the two's-complement value; carries the sign.
• low Field — Low 64 bits of the two's-complement value.
• PdcommGemLinkSpec Struct — One event link: a CEID and the reports to link to it (S2F35).
• count Field — Number of elements in report_ids.
• event_id Field — Collection event ID (CEID), sent as U4.
• report_ids Field — Array of count report IDs (RPTID).
• PdcommGemProgramInfo Struct — Process program details of a GEM result, filled by pdcomm_gem_result_program_info().
• acknowledgement Field — PPGNT (S7F2) or ACKC7 (S7F4, S7F18), sent or received.
• acknowledgement_present Field — 1 when acknowledgement is valid.
• applied Field — 1 when responding to this request changed the store.
• confirmation_required Field — 1 when a retained reply waits for pdcomm_gem_program_confirm_reply() after #PDCOMM_PROGRAM_UNCONFIRMED.
• declared_length Field — LENGTH declared in an incoming S7F1, in PPBODY payload bytes; otherwise 0.
• durability Field — Durability of the installation made while responding: one of the PDCOMM_GEM_PROGRAM_* durability values.
• grant_activated Field — 1 when answering this S7F1 activated a grant; it reports the original activation, not whether the grant is still live.
• id_count Field — Number of PPIDs available through #PDCOMM_GEM_PROGRAM_ID.
• is_request Field — 1 for an incoming request; 0 for a response to this endpoint's request.
• persistence_status Field — #PDCOMM_OK, or the persistence error of an unconfirmed installation.
• reply_ready Field — 1 when a prepared reply is retained and can be sent by pdcomm_gem_program_respond().
• request_kind Field — Request kind: one of #PDCOMM_GEM_PROGRAM_GRANT to #PDCOMM_GEM_PROGRAM_DIRECTORY.
• responded Field — 1 after the reply to an incoming request was queued.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemProgramInfo) or larger before the call.
• PdcommGemProgramOptions Struct — Store limits, request budgets, and grant policy for process programs.
• grant_policy Field — S7F3 grant policy: #PDCOMM_GEM_PROGRAM_GRANT_REQUIRED or #PDCOMM_GEM_PROGRAM_GRANT_OPTIONAL.
• max_body_bytes Field — Largest PPBODY payload of one program in bytes.
• max_grants Field — Largest number of concurrently active S7F1 grants; storage for them is reserved at configuration.
• max_identifier_bytes Field — Largest PPID length in bytes; the effective limit is at most 120.
• max_pending_identifier_bytes Field — Largest total PPID bytes across this endpoint's outstanding program requests.
• max_pending_ids Field — Largest total number of PPIDs across this endpoint's outstanding program requests.
• max_programs Field — Largest number of stored programs.
• max_request_ids Field — Largest number of PPIDs in one delete, local or S7F17.
• max_reserved_body_bytes Field — Largest total declared LENGTH bytes reserved by active grants.
• max_serialized_bytes Field — Largest snapshot file size in bytes; used only with a file path.
• max_total_body_bytes Field — Largest total PPBODY payload bytes of all stored programs.
• max_total_identifier_bytes Field — Largest total PPID bytes of all stored programs.
• reserved Field — Reserved; must be 0.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemProgramOptions) or larger.
• version Field — Structure version; must be #PDCOMM_GEM_PROGRAM_OPTIONS_VERSION.
• PdcommGemProgramState Struct — Usage snapshot of the program store, filled by pdcomm_gem_program_state().
• body_bytes Field — Total PPBODY payload bytes of the stored programs.
• grant_count Field — Number of active S7F1 grants.
• identifier_bytes Field — Total PPID bytes of the stored programs.
• persistent Field — 1 when the store is backed by a snapshot file; 0 for RAM.
• program_count Field — Number of stored programs.
• reserved_body_bytes Field — Total declared LENGTH bytes reserved by active grants.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemProgramState) or larger before the call.
• PdcommGemProgramWriteInfo Struct — Outcome of a local store mutation.
• applied Field — 1 when the store was changed and the change installed.
• durability Field — #PDCOMM_GEM_PROGRAM_VOLATILE, #PDCOMM_GEM_PROGRAM_SYNCED, #PDCOMM_GEM_PROGRAM_UNCONFIRMED, or #PDCOMM_GEM_PROGRAM_DURABILITY_NONE.
• persistence_status Field — #PDCOMM_OK, or the persistence error (for example #PDCOMM_IO_ERROR) when durability is #PDCOMM_GEM_PROGRAM_UNCONFIRMED.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemProgramWriteInfo) or larger before the call.
• PdcommGemQueryInfo Struct — Summary of a report query request or response, filled by pdcomm_gem_result_query_info().
• data_id Field — DATAID from an S6F16 reply; 0 when data_id_present is 0.
• data_id_present Field — 1 for an S6F16 reply, which carries a DATAID; otherwise 0.
• id Field — Requested ID: the CEID for an event query, otherwise the RPTID.
• is_request Field — 1 for a query received by an Equipment, 0 for a response received by a Host.
• query_kind Field — #PDCOMM_GEM_EVENT_QUERY, #PDCOMM_GEM_INDIVIDUAL_QUERY, or #PDCOMM_GEM_ANNOTATED_QUERY.
• report_count Field — Number of reports in an S6F16 reply; 0 for requests and for S6F20/S6F22.
• responded Field — 1 after pdcomm_gem_equipment_respond_report_query() sent the reply for this request.
• struct_size Field — Structure size in bytes; set before the call, receives the size written.
• value_count Field — Number of values: summed over all reports for S6F16, the entry count for S6F20/S6F22, 0 for requests.
• PdcommGemQueryReportInfo Struct — One report of an S6F16 reply, filled by pdcomm_gem_result_query_report().
• id Field — Report ID (RPTID).
• struct_size Field — Structure size in bytes; set before the call, receives the size written.
• value_count Field — Number of values in the report.
• PdcommGemQueryValueInfo Struct — Metadata of one query value, filled by pdcomm_gem_result_query_value().
• struct_size Field — Structure size in bytes; set before the call, receives the size written.
• vid Field — VID of an S6F22 entry; 0 when vid_present is 0.
• vid_present Field — 1 only for S6F22 entries, which carry a VID on the wire.
• PdcommGemReportBinding Struct — Binding of one report VID to its value source.
• constant_id Field — Equipment constant ID (ECID) for a CONSTANT source; must be NULL otherwise.
• source_id Field — Status variable ID or DVID for STATUS and DATA sources; must be 0 for CONSTANT.
• source_kind Field — Source kind: #PDCOMM_GEM_SOURCE_STATUS, #PDCOMM_GEM_SOURCE_DATA, or #PDCOMM_GEM_SOURCE_CONSTANT.
• vid Field — Variable ID (VID) used in reports; unique within the store.
• PdcommGemReportOptions Struct — Capacity limits of an Equipment report store.
• max_events Field — Largest number of collection events (CEIDs) in the store.
• max_reports Field — Largest number of defined reports (RPTIDs).
• max_reports_per_event Field — Largest number of reports linked to one event.
• max_total_links Field — Largest total number of event-to-report links.
• max_total_variables Field — Largest total number of VIDs across all reports.
• max_variables_per_report Field — Largest number of VIDs in one report.
• reserved Field — Must be 0.
• struct_size Field — Structure size in bytes; set to sizeof(PdcommGemReportOptions) or larger.
• version Field — Must be #PDCOMM_GEM_REPORT_OPTIONS_VERSION.
• PdcommGemReportSpec Struct — One report definition: an RPTID and its ordered VIDs.
• count Field — Number of elements in variable_ids.
• id Field — Report ID (RPTID), sent as U4.
• variable_ids Field — Array of count variable IDs (VID), sent as U4.
• PdcommGemReportState Struct — Counters of an Equipment report store, filled by pdcomm_gem_equipment_report_state().
• event_count Field — Number of registered collection events.
• report_count Field — Number of defined reports.
• struct_size Field — Structure size in bytes.
• total_links Field — Total number of event-to-report links.
• total_variables Field — Total number of VIDs across all reports.
• PdcommGemResult Typedef — Opaque, immutable snapshot produced by pdcomm_gem_handle_event().
• PdcommGemResultInfo Struct — Fixed fields of a ::PdcommGemResult, read with pdcomm_gem_result_info().
• acknowledgement Field — Acknowledgement code of the exchange (such as COMMACK, OFLACK, or ONLACK); valid only when acknowledgement_present is nonzero.
• acknowledgement_present Field — Nonzero when acknowledgement holds a value.
• code Field — Failure or error detail; 0 when there is none.
• entry_count Field — Number of entries in list-type results, such as the values of #PDCOMM_GEM_VALUES_RECEIVED or the entries of #PDCOMM_GEM_NAMES_RECEIVED; 0 otherwise.
• kind Field — Result kind: #PDCOMM_GEM_IGNORED, #PDCOMM_GEM_PRIMARY, #PDCOMM_GEM_RESPONSE, #PDCOMM_GEM_FAILED, #PDCOMM_GEM_INVALID_RESPONSE, or #PDCOMM_GEM_UNHANDLED.
• outcome Field — What the message did, as a PDCOMM_GEM_* outcome value.
• reply_sent Field — Nonzero when this side has sent the reply to the primary of this result.
• request_kind Field — Request kind of the matched pending request for response, failed, and invalid-response results; 0 otherwise.
• state Field — GEM state of the endpoint after the event was processed.
• struct_size Field — Structure size in bytes.
• token Field — Transaction token.
• PdcommGemSpoolEntryInfo Struct — Header of one spooled message, filled by pdcomm_gem_spool_entry_at().
• body_present Field — 1 when the message has a body; 0 for a header-only message.
• entry_id Field — Entry ID, unique within the spool.
• function Field — Function of the spooled message.
• reply_expected Field — 1 when the message is sent with the W bit (a reply is expected).
• stream Field — Stream of the spooled message.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemSpoolEntryInfo) or larger before the call.
• PdcommGemSpoolHostOptions Struct — Request limits for Host spooling requests.
• max_functions_per_stream Field — Largest number of functions for one stream in a request or accepted reply.
• max_pending_items Field — Largest item budget of one S2F43 request.
• max_streams Field — Largest number of streams in one S2F43 request or accepted reply.
• reserved Field — Reserved; must be 0.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemSpoolHostOptions) or larger.
• version Field — Structure version; must be #PDCOMM_GEM_SPOOL_OPTIONS_VERSION.
• PdcommGemSpoolInfo Struct — Spooling details of a GEM result, filled by pdcomm_gem_result_spool_info().
• acknowledgement Field — Acknowledgement code: RSPACK (S2F44), RSDA (S6F24), or ACKC5/ACKC6 from a delivered S5F1/S6F11 reply.
• acknowledgement_present Field — 1 when acknowledgement is valid.
• applied Field — 1 when processing this result installed a spool change.
• command Field — S6F23 command (#PDCOMM_GEM_SPOOL_TRANSMIT or #PDCOMM_GEM_SPOOL_PURGE) for control kinds; otherwise 0.
• confirmation_required Field — 1 when a retained reply waits for pdcomm_gem_spool_confirm_reply() after #PDCOMM_SPOOL_UNCONFIRMED.
• delivery_attempt Field — Delivery attempt number for delivery results; otherwise 0.
• delivery_completed Field — 1 when pdcomm_gem_spool_complete_delivery() finished with this delivery result.
• delivery_proof Field — Delivery proof: #PDCOMM_GEM_SPOOL_PROOF_NONE, #PDCOMM_GEM_SPOOL_PROOF_RESPONSE, or #PDCOMM_GEM_SPOOL_PROOF_WRITTEN.
• dequeue_pending Field — 1 when delivery succeeded but the dequeue failed before installation and is still pending.
• durability Field — Durability of the change applied by a response or delivery, as in ::PdcommGemSpoolWriteInfo, or #PDCOMM_GEM_SPOOL_CONFIRMED.
• entry_id Field — Entry ID of the delivered message for delivery results; otherwise 0.
• error_count Field — Number of stream errors in a received S2F44.
• is_request Field — 1 for an incoming request (Equipment side); 0 for a response or delivery result.
• persistence_status Field — #PDCOMM_OK, or the persistence error of an unconfirmed or failed installation or dequeue.
• reply_ready Field — 1 when a prepared reply is retained and can be sent by pdcomm_gem_spool_respond().
• request_kind Field — Request kind: #PDCOMM_GEM_SPOOL_CONFIGURE, #PDCOMM_GEM_SPOOL_QUERY, #PDCOMM_GEM_SPOOL_CONTROL, or #PDCOMM_GEM_SPOOL_DELIVERY.
• responded Field — 1 after the reply to an incoming request was queued.
• selection_count Field — Number of stream selections in an incoming S2F43 or a received S2F60.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemSpoolInfo) or larger before the call.
• success_accepted Field — 1 when the application reported this delivery as successful.
• PdcommGemSpoolMessageKey Struct — One spoolable primary message type in the Equipment catalog.
• function Field — Primary function number: odd and nonzero.
• stream Field — Stream number, 2 to 127.
• PdcommGemSpoolOptions Struct — Storage limits and persistence bound for an Equipment spool.
• max_body_bytes Field — Largest encoded body of one captured message in bytes; larger bodies are rejected.
• max_catalog_entries Field — Largest number of catalog entries; also bounds the total functions listed in an incoming S2F43 or an outgoing S2F60.
• max_functions_per_stream Field — Largest number of functions listed for one stream in a selection.
• max_messages Field — Largest number of spooled messages; reaching it makes the spool full.
• max_serialized_bytes Field — Largest snapshot file size in bytes; used only with a file path.
• max_streams Field — Largest number of streams in a selection, locally or in S2F43 and S2F60.
• max_total_body_bytes Field — Largest total encoded body bytes of all spooled messages; reaching it makes the spool full.
• reserved Field — Reserved; must be 0.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemSpoolOptions) or larger.
• version Field — Structure version; must be #PDCOMM_GEM_SPOOL_OPTIONS_VERSION.
• PdcommGemSpoolPolicy Struct — Local spool policy, set with pdcomm_gem_spool_configure_local().
• enabled Field — 1 enables spooling globally (E30 EnableSpooling), 0 disables it, and other values are rejected.
• max_transmit Field — Largest number of messages delivered per transmission run (E30 MaxSpoolTransmit); 0 means unbounded.
• overflow Field — Overflow policy: #PDCOMM_GEM_SPOOL_DISCARD_NEW or #PDCOMM_GEM_SPOOL_OVERWRITE_OLDEST.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemSpoolPolicy) or larger.
• PdcommGemSpoolSelection Struct — Spool selection for one stream, as in S2F43.
• function_count Field — Number of entries in functions; 0 selects the whole stream.
• functions Field — Array of function_count function numbers; may be NULL when function_count is 0.
• stream Field — Stream number.
• PdcommGemSpoolState Struct — Snapshot of an Equipment spool, filled by pdcomm_gem_spool_state().
• active Field — 1 when spooling is active (E30 SPOOL ACTIVE): messages are being stored or are still waiting for delivery.
• body_bytes Field — Total encoded body bytes of the spooled messages.
• catalog_count Field — Number of catalog entries.
• connected Field — 1 when the last sync observed a Selected, Communicating connection.
• delivery_pending Field — 1 while a delivery attempt is in flight or an acknowledged dequeue is pending.
• dequeue_pending Field — 1 when a delivered head entry still has to be dequeued with pdcomm_gem_spool_retry_dequeue().
• discarded Field — Messages discarded or overwritten because the spool was full.
• enabled Field — 1 when spooling is enabled.
• full_time Field — Application timestamp when the spool became full (E30 SpoolFullTime); valid when full_time_present is 1.
• full_time_present Field — 1 when full_time holds a value.
• max_transmit Field — Current per-run transmit limit; 0 means unbounded.
• message_count Field — Number of spooled messages (E30 SpoolCountActual).
• next_id Field — Entry ID that the next stored message receives.
• overflow Field — Current overflow policy: #PDCOMM_GEM_SPOOL_DISCARD_NEW or #PDCOMM_GEM_SPOOL_OVERWRITE_OLDEST.
• persistent Field — 1 when the spool is backed by a snapshot file; 0 for RAM.
• received Field — Selected messages offered for spooling while active, stored or discarded.
• selection_count Field — Number of streams in the current selection.
• start_time Field — Application timestamp when spooling started (E30 SpoolStartTime); valid when start_time_present is 1.
• start_time_present Field — 1 when start_time holds a value.
• stored Field — Messages stored in the spool.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemSpoolState) or larger before the call.
• synchronized Field — 1 when the last pdcomm_gem_spool_sync() still matches the current connection state.
• transmitted Field — Spooled messages delivered and dequeued.
• transmitted_in_run Field — Messages dequeued in the current transmission run.
• transmitting Field — 1 while a transmission run accepted by S6F23 is in progress.
• PdcommGemSpoolWriteInfo Struct — Outcome of a spool mutation.
• affected_count Field — Overwritten entries for a capture, purged entries for a purge, 1 for a dequeue; otherwise 0.
• applied Field — 1 when a change was installed; 0 otherwise.
• durability Field — Durability of the change: #PDCOMM_GEM_SPOOL_DURABILITY_NONE, #PDCOMM_GEM_SPOOL_VOLATILE, #PDCOMM_GEM_SPOOL_SYNCED, or #PDCOMM_GEM_SPOOL_UNCONFIRMED.
• entry_id Field — Entry ID of a captured (#PDCOMM_GEM_SPOOL_CAPTURED) or removed (#PDCOMM_GEM_SPOOL_REMOVED) entry; otherwise 0.
• mutation Field — Kind of change: one of the PDCOMM_GEM_SPOOL_MUTATION_NONE to PDCOMM_GEM_SPOOL_PURGED values.
• persistence_status Field — #PDCOMM_OK, or the persistence error (for example #PDCOMM_IO_ERROR) when durability is #PDCOMM_GEM_SPOOL_UNCONFIRMED.
• selected Field — 1 when a change was installed; 0 when a captured message was not selected for spooling.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommGemSpoolWriteInfo) or larger before the call.
• PdcommGemState Struct — GEM state of an endpoint, filled by pdcomm_gem_state() and embedded in ::PdcommGemResultInfo.
• communication Field — Communication state, one of #PDCOMM_GEM_DISCONNECTED through #PDCOMM_GEM_COMMUNICATING.
• control Field — Equipment control state (#PDCOMM_GEM_EQUIPMENT_OFFLINE through #PDCOMM_GEM_ONLINE_REMOTE), or #PDCOMM_GEM_CONTROL_UNAVAILABLE for a host.
• endpoint_id Field — Identifier of the TCP endpoint, as carried in ::PdcommTcpToken.
• generation Field — Current connection generation of the TCP endpoint.
• online_mode Field — Equipment online mode (#PDCOMM_GEM_LOCAL or #PDCOMM_GEM_REMOTE), or #PDCOMM_GEM_CONTROL_UNAVAILABLE for a host.
• pending_count Field — Number of occupied pending-request slots, at most 32.
• pending_ids Field — Number of identifiers held by pending requests, counted against max_pending_ids for a host.
• role Field — Configured role: #PDCOMM_GEM_HOST or #PDCOMM_GEM_EQUIPMENT.
• struct_size Field — Structure size in bytes.
• variable_count Field — Number of registered status variables; 0 for a host.
• PdcommSecs1Endpoint Typedef — Opaque SECS-I endpoint bound to one caller-provided byte stream.
• PdcommSecs1Event Typedef — Opaque, immutable, owned SECS-I event snapshot.
• PdcommSecs1EventInfo Struct — Description of an event, filled by pdcomm_secs1_event_info().
• body_length Field — Inbound only: message body length in bytes.
• device_id Field — Inbound only: device ID from the block header.
• direction Field — Inbound only: #PDCOMM_SECS1_TO_HOST or #PDCOMM_SECS1_TO_EQUIPMENT, from the R-bit.
• discarded_partial Field — Fault only: 1 when a partially received block or message was discarded.
• fault_detail Field — Fault only: detail for fault_kind.
• fault_kind Field — Fault only: one of the PDCOMM_SECS1_FAULT_* values.
• function Field — Inbound only: SECS-II function number.
• kind Field — Event kind, one of the PDCOMM_SECS1_EVENT_* values.
• reply_expected Field — Inbound only: 1 when the W-bit is set, otherwise 0.
• reserved Field — Reserved; written as zero.
• stream Field — Inbound only: SECS-II stream number.
• struct_size Field — Structure size in bytes.
• system_bytes Field — Inbound only: system bytes from the block header, in host byte order.
• token Field — Submission the event refers to.
• PdcommSecs1Io Struct — Caller-provided I/O callback table.
• context Field — Opaque pointer passed to both callbacks; must not be NULL.
• read Field — Nonblocking read callback; must not be NULL.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommSecs1Io) or larger.
• write Field — Nonblocking write callback; must not be NULL.
• PdcommSecs1Message Struct — A message to send with pdcomm_secs1_submit().
• body Field — Message body, normally one encoded SECS-II item.
• body_length Field — Number of bytes at body.
• device_id Field — Device ID, 0 to 32767.
• direction Field — Direction that sets the R-bit: #PDCOMM_SECS1_TO_HOST or #PDCOMM_SECS1_TO_EQUIPMENT.
• function Field — SECS-II function number, 0 to 255.
• reply_expected Field — W-bit: 1 when the sender expects a reply, otherwise 0.
• reserved Field — Reserved; must be zero.
• stream Field — SECS-II stream number, 0 to 127.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommSecs1Message) or larger.
• system_bytes Field — System bytes of the block header.
• version Field — Structure version; must be #PDCOMM_SECS1_MESSAGE_VERSION.
• PdcommSecs1Options Struct — SECS-I line settings and resource limits for pdcomm_secs1_create().
• ack_wait_ticks Field — T2 for a reply, in ticks; nonzero.
• grant_wait_ticks Field — T2 for the EOT that grants the line after the endpoint sends ENQ, in ticks; nonzero.
• inbound_progress_ticks Field — T1 inter-character timeout while a block is received, in ticks; nonzero.
• inter_block_ticks Field — T4 inter-block timeout of a multi-block inbound message, in ticks; nonzero.
• max_blocks Field — Largest number of blocks in an inbound message.
• max_body_bytes Field — Largest inbound message body in bytes.
• max_event_body_bytes Field — Largest total body bytes held by queued events; at least max_body_bytes.
• max_events Field — Largest number of events queued for pdcomm_secs1_next_event(); nonzero.
• max_io_chunk Field — Largest byte count passed to one read or write callback; nonzero.
• max_outbound_blocks Field — Largest number of blocks of a submitted message; nonzero and at most max_blocks.
• max_outbound_body_bytes Field — Largest body accepted by pdcomm_secs1_submit(); nonzero and at most max_body_bytes.
• poll_budget Field — Number of processing steps in one pdcomm_secs1_poll() call; nonzero.
• priority Field — Contention role: #PDCOMM_SECS1_MASTER or #PDCOMM_SECS1_SLAVE.
• reserved Field — Reserved; must be zero.
• reserved2 Field — Reserved; must be zero.
• retry_limit Field — Retry limit (SEMI E4 RTY) for sending one block.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommSecs1Options) or larger.
• version Field — Structure version; must be #PDCOMM_SECS1_OPTIONS_VERSION.
• PdcommSecs1Read Typedef — Reads bytes from the serial stream without blocking.
• PdcommSecs1State Struct — Snapshot of an endpoint, filled by pdcomm_secs1_state().
• endpoint_id Field — Process-unique, nonzero endpoint identifier.
• faulted Field — 1 while a terminal fault is active, until pdcomm_secs1_reset() or stop.
• generation Field — Current generation; starts at 1 and grows with each restart after stop.
• poisoned Field — 1 after a contained panic poisoned the endpoint; otherwise 0.
• started Field — 1 after pdcomm_secs1_start() until pdcomm_secs1_stop(); otherwise 0.
• stopped Field — 1 after pdcomm_secs1_stop() until the next start; otherwise 0.
• struct_size Field — Structure size in bytes.
• PdcommSecs1Token Struct — Identifies one accepted submission.
• endpoint_id Field — Process-unique, nonzero endpoint identifier.
• generation Field — Endpoint generation; 1 after create, incremented by each restart after stop.
• reserved Field — Reserved; always zero.
• value Field — Per-generation submission number, starting at 1; zero means no submission.
• PdcommSecs1Write Typedef — Writes bytes to the serial stream without blocking.
• PdcommSecsInfo Struct — Summary of a SECS-II item, filled by pdcomm_secs_info().
• count Field — Number of child items for a List; number of elements (payload bytes divided by element width) for a primitive.
• depth Field — Nesting depth: 1 for a primitive or an empty List.
• encoded_length Field — Length of the minimal SECS-II encoding of the whole item, headers included.
• format Field — Format code of the item, one of the PDCOMM_SECS_* format macros.
• node_count Field — Number of items in the tree, including this item.
• struct_size Field — Structure size in bytes.
• PdcommSecsItem Typedef — Opaque, immutable, owned SECS-II item tree.
• PdcommSecsLimits Struct — Resource limits for building, decoding, and copying SECS-II items.
• item_bytes Field — Largest payload of a single primitive item in bytes.
• item_count Field — Largest number of items in a tree, counting every List and primitive; must be at least 1.
• message_bytes Field — Largest total encoded size of an item tree, headers included, in bytes.
• nesting_depth Field — Largest nesting depth; capped at 64.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommSecsLimits) or larger.
• PdcommTcpEndpoint Typedef — Opaque HSMS endpoint handle.
• PdcommTcpEvent Typedef — Opaque, owned snapshot of one endpoint event.
• PdcommTcpEventInfo Struct — Decoded description of an event, filled by pdcomm_tcp_event_info().
• aborted Field — For a received reply: 1 when the reply is an SxF0 abort (function 0).
• body_length Field — Length of the message body in bytes; nonzero only for #PDCOMM_TCP_RECEIVED.
• code Field — Kind-specific code.
• detail Field — Kind-specific detail.
• from_state Field — Previous state for #PDCOMM_TCP_STATE_CHANGED.
• function Field — Function (header byte 3); valid when PdcommTcpEventInfo::header_present is 1.
• header_present Field — 1 when the header fields are valid.
• is_reply Field — For #PDCOMM_TCP_RECEIVED: 1 for a reply to one of your requests, 0 for a primary.
• kind Field — Event kind, such as #PDCOMM_TCP_RECEIVED.
• p_type Field — Header PType; valid when PdcommTcpEventInfo::header_present is 1.
• reply_expected Field — 1 when the header's W-bit is set (a reply is expected); valid when PdcommTcpEventInfo::header_present is 1.
• s_type Field — Header SType (0 for data messages); valid when PdcommTcpEventInfo::header_present is 1.
• session_id Field — Session ID from the message header; valid when PdcommTcpEventInfo::header_present is 1.
• stream Field — Stream (header byte 2 without the W-bit); valid when PdcommTcpEventInfo::header_present is 1.
• struct_size Field — Structure size in bytes.
• to_state Field — New state for #PDCOMM_TCP_STATE_CHANGED.
• token Field — Token of the event.
• value1 Field — First code-specific value, as described for each failure reason, protocol error, and frame error.
• value2 Field — Second code-specific value, as described for each failure reason, protocol error, and frame error.
• PdcommTcpOptions Struct — Configuration for pdcomm_tcp_create().
• connect_timeout_ms Field — Active-mode TCP connect timeout in milliseconds; must be nonzero.
• initial_system_bytes Field — First system bytes value of each connection generation.
• item_limits Field — SECS-II limits for message bodies.
• max_application_bytes Field — Largest total body size of the events in the queue read by pdcomm_tcp_next_event(), in bytes; must be at least PdcommTcpOptions::max_frame_bytes minus 14.
• max_application_events Field — Capacity of the queue read by pdcomm_tcp_next_event(); must be nonzero.
• max_events Field — Capacity of the internal session event queue; must be at least 2 * #PDCOMM_TCP_MAX_TRANSACTIONS + 8 (72).
• max_frame_bytes Field — Largest HSMS frame in bytes, including the 4-byte length field and the 10-byte header; must be at least 14.
• max_io_chunk Field — Largest number of bytes passed to one socket read or write call; must be nonzero.
• max_queued_bytes Field — Largest total size of message bodies held in the internal session queue, in bytes.
• max_write_bytes Field — Largest total size of the socket write queue in bytes; must be at least 14 and at least PdcommTcpOptions::max_frame_bytes.
• max_write_frames Field — Largest number of frames in the socket write queue; must be nonzero.
• mode Field — Connection mode: #PDCOMM_TCP_ACTIVE or #PDCOMM_TCP_PASSIVE.
• poll_budget Field — Largest number of internal actions one pdcomm_tcp_poll() call performs; must be nonzero.
• reserved Field — Reserved; must be 0.
• session_id Field — HSMS session ID (device ID) for data messages.
• shutdown_timeout_ms Field — Graceful shutdown limit in milliseconds; must be nonzero.
• struct_size Field — Size of this structure in bytes; set to sizeof(PdcommTcpOptions) or larger.
• t3_ms Field — T3 reply timeout in milliseconds; must be nonzero.
• t5_ms Field — T5 connect separation timeout in milliseconds; must be nonzero.
• t6_ms Field — T6 control transaction timeout in milliseconds; must be nonzero.
• t7_ms Field — T7 not-selected timeout in milliseconds; must be nonzero.
• t8_ms Field — T8 network intercharacter timeout in milliseconds; must be nonzero.
• version Field — Options layout version; must be #PDCOMM_TCP_OPTIONS_VERSION.
• write_timeout_ms Field — Write timeout in milliseconds; must be nonzero.
• PdcommTcpState Struct — Endpoint state snapshot, filled by pdcomm_tcp_state().
• closed Field — 1 when a stopped endpoint has finished closing, otherwise 0.
• endpoint_id Field — Process-unique, nonzero identity of the endpoint.
• generation Field — Current connection generation; 0 before the first start.
• state Field — Current HSMS state, one of the PDCOMM_TCP_* state values such as #PDCOMM_TCP_SELECTED.
• struct_size Field — Structure size in bytes.
• PdcommTcpToken Struct — Identifies one transaction or received message of one endpoint generation.
• endpoint_id Field — Process-unique, nonzero endpoint identity; 0 in an empty token.
• generation Field — Connection generation in which the transaction or message occurred.
• reserved Field — Reserved; the library writes 0, and tokens you pass in must have 0.
• system_bytes Field — HSMS system bytes of the message.
• pdcomm_gem300_capability_catalog_clear Function — Removes every profile from the catalog.
• pdcomm_gem300_capability_catalog_create Function — Creates an empty capability catalog with revision 0.
• pdcomm_gem300_capability_catalog_destroy Function — Releases a catalog.
• pdcomm_gem300_capability_catalog_info Function — Reads the revision and totals of a catalog.
• pdcomm_gem300_capability_catalog_replace Function — Atomically replaces the catalog contents with an ordered list of profiles.
• pdcomm_gem300_capability_catalog_snapshot Function — Copies the complete ordered catalog contents into a new snapshot.
• pdcomm_gem300_capability_snapshot_capability_id_copy Function — Copies the identifier of one snapshot capability.
• pdcomm_gem300_capability_snapshot_capability_info Function — Reads the axis, labels, and identifier length of one snapshot capability.
• pdcomm_gem300_capability_snapshot_destroy Function — Releases a snapshot.
• pdcomm_gem300_capability_snapshot_info Function — Reads the revision and totals recorded in a snapshot.
• pdcomm_gem300_capability_snapshot_profile_id_copy Function — Copies the identifier of one snapshot profile.
• pdcomm_gem300_capability_snapshot_profile_info Function — Reads the identifier length and capability count of one snapshot profile.
• pdcomm_gem_begin_communication Function — Sends S1F13 Establish Communications Request.
• pdcomm_gem_configure_equipment Function — Attaches a GEM equipment role to a stopped TCP endpoint.
• pdcomm_gem_configure_formatted_program_capabilities Function — Enables the formatted program capability service on a GEM endpoint.
• pdcomm_gem_configure_formatted_program_queries Function — Enables the S7F25/S7F26 service on an endpoint.
• pdcomm_gem_configure_formatted_program_transfers Function — Enables the S7F23/S7F24 transfer service on an endpoint.
• pdcomm_gem_configure_formatted_program_verification_negotiation Function — Enables the verification negotiation service on a GEM endpoint.
• pdcomm_gem_configure_formatted_program_verification_requests Function — Enables the S7F31/S7F32 verification request service on an endpoint.
• pdcomm_gem_configure_formatted_programs Function — Enables the S7F27/S7F28 verification report service on an endpoint.
• pdcomm_gem_configure_host Function — Attaches a GEM host role to a stopped TCP endpoint.
• pdcomm_gem_configure_programs Function — Attaches a process program store to a GEM endpoint.
• pdcomm_gem_configure_spool_host Function — Enables Host spooling requests and sets their limits.
• pdcomm_gem_configure_spooling Function — Attaches an Equipment spool to a GEM endpoint.
• pdcomm_gem_equipment_alarm_at Function — Reads one stored alarm by registration index and copies its text.
• pdcomm_gem_equipment_alarm_state Function — Reads the alarm counts of the Equipment alarm store.
• pdcomm_gem_equipment_binding_at Function — Reads one binding by position.
• pdcomm_gem_equipment_binding_state Function — Reads the counters of the binding store.
• pdcomm_gem_equipment_clear_data_variable Function — Removes the cached value of one data variable.
• pdcomm_gem_equipment_clear_report_bindings Function — Removes the binding store and restores legacy VID-to-status resolution.
• pdcomm_gem_equipment_command_at Function — Reads one stored command by registration index.
• pdcomm_gem_equipment_command_parameter_at Function — Reads one parameter definition of a stored command.
• pdcomm_gem_equipment_command_state Function — Reads the counts of the Equipment remote command store.
• pdcomm_gem_equipment_configure_alarms Function — Installs the alarm store of a GEM Equipment endpoint.
• pdcomm_gem_equipment_configure_commands Function — Installs the remote command store of a GEM Equipment endpoint.
• pdcomm_gem_equipment_configure_constants Function — Installs the equipment constant store of an Equipment.
• pdcomm_gem_equipment_configure_data_variables Function — Installs or replaces the complete data variable store of an Equipment.
• pdcomm_gem_equipment_configure_enhanced_commands Function — Installs the enhanced remote command store of a GEM Equipment endpoint.
• pdcomm_gem_equipment_configure_event_directory Function — Installs or replaces the complete event directory of an Equipment.
• pdcomm_gem_equipment_configure_fixed_catalog Function — Atomically installs a fixed report graph and its STATUS or DATA bindings.
• pdcomm_gem_equipment_configure_report_bindings Function — Installs or replaces the explicit report binding store of an Equipment.
• pdcomm_gem_equipment_configure_reports Function — Installs an empty report store with the given collection events on an Equipment.
• pdcomm_gem_equipment_constant_at Function — Reads one constant definition and its ID by position.
• pdcomm_gem_equipment_constant_get Function — Copies one field of a local constant.
• pdcomm_gem_equipment_constant_state Function — Reads the counters of the constant store.
• pdcomm_gem_equipment_data_at Function — Reads the definition summary of one data variable by position.
• pdcomm_gem_equipment_data_get Function — Copies the name, units, or cached value of one data variable.
• pdcomm_gem_equipment_data_state Function — Reads the counters of the data variable store.
• pdcomm_gem_equipment_directory_at Function — Reads one local event directory entry by position.
• pdcomm_gem_equipment_directory_get Function — Copies the name or the VIDs of one local event directory entry.
• pdcomm_gem_equipment_directory_state Function — Reads the counters of the event directory.
• pdcomm_gem_equipment_enhanced_command_at Function — Reads one stored command of an object.
• pdcomm_gem_equipment_enhanced_command_parameter_at Function — Reads one parameter definition of a stored enhanced command.
• pdcomm_gem_equipment_enhanced_command_state Function — Reads the counts of the Equipment enhanced command store.
• pdcomm_gem_equipment_enhanced_object_at Function — Reads one stored object by registration index.
• pdcomm_gem_equipment_event_at Function — Copies one collection event of the local report store by position.
• pdcomm_gem_equipment_observe_alarm Function — Records the current set or cleared state of an alarm without sending anything.
• pdcomm_gem_equipment_operator_offline Function — Takes the equipment to EQUIPMENT OFF-LINE (the operator's OFF-LINE switch).
• pdcomm_gem_equipment_operator_online Function — Starts an operator-initiated ON-LINE attempt by sending S1F1.
• pdcomm_gem_equipment_publish_alarm Function — Publishes the current state of one alarm as an S5F1 Alarm Report Send.
• pdcomm_gem_equipment_publish_event Function — Sends an Event Report Send (S6F11, W-bit set) for an enabled event.
• pdcomm_gem_equipment_publish_event_with_data Function — Sends an Event Report Send (S6F11, W-bit set) using sampled data variable values.
• pdcomm_gem_equipment_report_at Function — Copies one report definition of the local report store by position.
• pdcomm_gem_equipment_report_state Function — Reads the counters of an Equipment report store.
• pdcomm_gem_equipment_report_value Function — Resolves the current value of one report VID from local stores only.
• pdcomm_gem_equipment_respond_command Function — Sends the S2F42 Host Command Acknowledge for a received S2F41.
• pdcomm_gem_equipment_respond_constants Function — Sends the S2F16 reply for a received S2F15 and applies accepted values.
• pdcomm_gem_equipment_respond_enhanced_command Function — Sends the S2F50 Enhanced Remote Command Acknowledge for a received S2F49.
• pdcomm_gem_equipment_respond_report_query Function — Sends the reply (S6F16, S6F20, or S6F22) to a received report query.
• pdcomm_gem_equipment_set_online_mode Function — Sets the operator's REMOTE/LOCAL switch.
• pdcomm_gem_equipment_status_get Function — Copies the current value of a registered status variable.
• pdcomm_gem_equipment_status_id_at Function — Returns the ID of the status variable at a registration index.
• pdcomm_gem_equipment_status_metadata Function — Copies the name and units of a registered status variable.
• pdcomm_gem_equipment_status_register Function — Registers an equipment status variable (SV).
• pdcomm_gem_equipment_status_update Function — Replaces the value of a registered status variable.
• pdcomm_gem_equipment_update_data_variable Function — Replaces the cached value of one data variable.
• pdcomm_gem_formatted_program_capability_catalog_clear Function — Removes the equipment's published capability catalog.
• pdcomm_gem_formatted_program_capability_catalog_replace Function — Replaces the equipment's published capability catalog.
• pdcomm_gem_formatted_program_capability_respond Function — Answers a received S7F21 request with S7F22 from the catalog.
• pdcomm_gem_formatted_program_capability_submit Function — Sends an S7F21 capability request from the host.
• pdcomm_gem_formatted_program_clear_selection Function — Clears the current selection when the token matches it.
• pdcomm_gem_formatted_program_dry_run Function — Analyzes the selected formatted program against the capability catalog.
• pdcomm_gem_formatted_program_dry_run_destroy Function — Releases a dry-run report.
• pdcomm_gem_formatted_program_dry_run_info Function — Reads the summary of a dry-run report.
• pdcomm_gem_formatted_program_dry_run_issue_info Function — Reads one issue of a dry-run report.
• pdcomm_gem_formatted_program_dry_run_model_copy Function — Copies the analyzed program's MDLN (model name).
• pdcomm_gem_formatted_program_dry_run_program_id_copy Function — Copies the raw bytes of the analyzed program identifier (PPID).
• pdcomm_gem_formatted_program_dry_run_program_id_get Function — Copies the analyzed program identifier (PPID) as a SECS-II item.
• pdcomm_gem_formatted_program_dry_run_software_revision_copy Function — Copies the analyzed program's SOFTREV (software revision).
• pdcomm_gem_formatted_program_execution_action_command_code_get Function — Copies the command code of a Step action as a SECS-II item.
• pdcomm_gem_formatted_program_execution_action_destroy Function — Releases an execution action handle.
• pdcomm_gem_formatted_program_execution_action_info Function — Reads the description of an action, including its token fields.
• pdcomm_gem_formatted_program_execution_action_model_copy Function — Copies the program MDLN (model name) of a Start action.
• pdcomm_gem_formatted_program_execution_action_parameter_get Function — Copies one parameter of a Step action's command as a SECS-II item.
• pdcomm_gem_formatted_program_execution_action_program_id_get Function — Copies the program identifier (PPID) of a Start action.
• pdcomm_gem_formatted_program_execution_action_software_revision_copy Function — Copies the program SOFTREV (software revision) of a Start action.
• pdcomm_gem_formatted_program_execution_cancel Function — Requests cancellation of the execution as a Cancel action.
• pdcomm_gem_formatted_program_execution_complete Function — Records the application's terminal report for the execution.
• pdcomm_gem_formatted_program_execution_snapshot Function — Captures the endpoint's current execution state as a snapshot.
• pdcomm_gem_formatted_program_execution_snapshot_application_detail_copy Function — Copies the detail bytes of the snapshot's terminal report.
• pdcomm_gem_formatted_program_execution_snapshot_command_code_get Function — Copies the command code of one program command as a SECS-II item.
• pdcomm_gem_formatted_program_execution_snapshot_command_info Function — Reads the parameter count and code format of one program command.
• pdcomm_gem_formatted_program_execution_snapshot_destroy Function — Releases an execution snapshot.
• pdcomm_gem_formatted_program_execution_snapshot_info Function — Reads the state summary of a snapshot.
• pdcomm_gem_formatted_program_execution_snapshot_model_copy Function — Copies the executed program's MDLN (model name).
• pdcomm_gem_formatted_program_execution_snapshot_parameter_get Function — Copies one parameter of one program command as a SECS-II item.
• pdcomm_gem_formatted_program_execution_snapshot_program_id_get Function — Copies the executed program's identifier (PPID) as a SECS-II item.
• pdcomm_gem_formatted_program_execution_snapshot_software_revision_copy Function — Copies the executed program's SOFTREV (software revision).
• pdcomm_gem_formatted_program_execution_start Function — Starts tracking an execution of the selected program and returns its Start action.
• pdcomm_gem_formatted_program_execution_step Function — Requests the next program command as a Step action.
• pdcomm_gem_formatted_program_execution_submit_action_result Function — Reports the application's result for the pending action.
• pdcomm_gem_formatted_program_query_remove Function — Removes a program from the Equipment store (compatibility alias).
• pdcomm_gem_formatted_program_query_respond Function — Sends the S7F26 reply for a received S7F25 from the program store.
• pdcomm_gem_formatted_program_query_seed Function — Adds or replaces a program in the Equipment store (compatibility alias).
• pdcomm_gem_formatted_program_query_submit Function — Sends an S7F25 Formatted Process Program Request to the equipment.
• pdcomm_gem_formatted_program_respond Function — Sends the S7F28 acknowledge for a received S7F27 report.
• pdcomm_gem_formatted_program_select Function — Selects a stored program by PPID and returns its selection token.
• pdcomm_gem_formatted_program_selection_snapshot Function — Copies the current selection state, and the selected program if any, into a new snapshot.
• pdcomm_gem_formatted_program_selection_snapshot_command_code_get Function — Copies the CCODE of one selected command as a new SECS-II item.
• pdcomm_gem_formatted_program_selection_snapshot_command_info Function — Reads the parameter count and CCODE format of one selected command.
• pdcomm_gem_formatted_program_selection_snapshot_destroy Function — Releases a selection snapshot.
• pdcomm_gem_formatted_program_selection_snapshot_id_get Function — Copies the PPID of the selected program as a new SECS-II item.
• pdcomm_gem_formatted_program_selection_snapshot_info Function — Reads the summary stored in a selection snapshot.
• pdcomm_gem_formatted_program_selection_snapshot_model_copy Function — Copies the MDLN of the selected program.
• pdcomm_gem_formatted_program_selection_snapshot_parameter_get Function — Copies one PPARM of one selected command as a new SECS-II item.
• pdcomm_gem_formatted_program_selection_snapshot_software_revision_copy Function — Copies the SOFTREV of the selected program.
• pdcomm_gem_formatted_program_store_entry_command_code_get Function — Copies the CCODE of one command as a new SECS-II item.
• pdcomm_gem_formatted_program_store_entry_command_info Function — Reads the parameter count and CCODE format of one command.
• pdcomm_gem_formatted_program_store_entry_id_get Function — Copies the PPID of one snapshot entry as a new SECS-II item.
• pdcomm_gem_formatted_program_store_entry_info Function — Reads the summary of one program in a snapshot.
• pdcomm_gem_formatted_program_store_entry_model_copy Function — Copies the MDLN equipment model of one snapshot entry.
• pdcomm_gem_formatted_program_store_entry_parameter_get Function — Copies one PPARM of one command as a new SECS-II item.
• pdcomm_gem_formatted_program_store_entry_software_revision_copy Function — Copies the SOFTREV software revision of one snapshot entry.
• pdcomm_gem_formatted_program_store_info Function — Reads the current store totals and limits.
• pdcomm_gem_formatted_program_store_put Function — Adds or replaces a formatted process program in the local store.
• pdcomm_gem_formatted_program_store_remove Function — Removes a program from the local store.
• pdcomm_gem_formatted_program_store_snapshot Function — Copies the whole store into a new owned snapshot.
• pdcomm_gem_formatted_program_store_snapshot_destroy Function — Releases a store snapshot.
• pdcomm_gem_formatted_program_store_snapshot_info Function — Reads the totals and limits captured in a snapshot.
• pdcomm_gem_formatted_program_submit Function — Sends an S7F27 Process Program Verification Send to the host.
• pdcomm_gem_formatted_program_transfer_respond Function — Sends the S7F24 acknowledge for a received S7F23 without storing the program.
• pdcomm_gem_formatted_program_transfer_respond_and_store Function — Sends the S7F24 acknowledge for a received S7F23 and applies a store action to the program.
• pdcomm_gem_formatted_program_transfer_submit Function — Sends an S7F23 Formatted Process Program Send to the equipment.
• pdcomm_gem_formatted_program_validate_selection_for_execution Function — Checks that a selection token is still valid for execution and returns a snapshot of the selected program.
• pdcomm_gem_formatted_program_verification_prepare Function — Prepares an S7F27 verification report for negotiation.
• pdcomm_gem_formatted_program_verification_request_respond Function — Sends the S7F32 acknowledge for a received S7F31.
• pdcomm_gem_formatted_program_verification_request_submit Function — Sends an S7F31 Verification Request Send to the equipment.
• pdcomm_gem_formatted_program_verification_respond Function — Answers a received S7F29 inquiry with S7F30.
• pdcomm_gem_formatted_program_verification_retry_response Function — Resends the staged S7F30 reply of a received inquiry.
• pdcomm_gem_formatted_program_verification_retry_verification Function — Resends the S7F27 report after a grant whose automatic send failed.
• pdcomm_gem_formatted_program_verification_submit Function — Sends the S7F29 verification inquiry for a prepared result.
• pdcomm_gem_handle_event Function — Processes one TCP event with the GEM role and returns an owned result.
• pdcomm_gem_host_acknowledge_alarm Function — Sends the S5F2 Alarm Report Acknowledge for a received W=1 alarm report.
• pdcomm_gem_host_acknowledge_event Function — Sends the Event Report Acknowledge (S6F12) for a received S6F11.
• pdcomm_gem_host_change_constants Function — Sends a New Equipment Constant Send (S2F15) from a Host.
• pdcomm_gem_host_constant_request Function — Sends an Equipment Constant Request (S2F13) or Namelist Request (S2F29) from a Host.
• pdcomm_gem_host_define_reports Function — Sends a Define Report request (S2F33) from a Host.
• pdcomm_gem_host_directory_request Function — Sends a Data Variable or Collection Event Namelist Request (S1F21 or S1F23) from a Host.
• pdcomm_gem_host_enable_alarm Function — Sends S5F3 Enable/Disable Alarm Send from a Host.
• pdcomm_gem_host_enable_events Function — Sends an Enable/Disable Event Report request (S2F37) from a Host.
• pdcomm_gem_host_enhanced_remote_command Function — Sends S2F49 Enhanced Remote Command (W=1) from a Host.
• pdcomm_gem_host_link_reports Function — Sends a Link Event Report request (S2F35) from a Host.
• pdcomm_gem_host_remote_command Function — Sends S2F41 Host Command Send (W=1) from a Host.
• pdcomm_gem_host_report_query Function — Sends an Event Report, Individual Report, or Annotated Individual Report request from a Host.
• pdcomm_gem_host_request Function — Sends a host request to the equipment.
• pdcomm_gem_host_request_alarm_list Function — Sends S5F5 List Alarms Request (W=1) from a Host.
• pdcomm_gem_host_request_enabled_alarm_list Function — Sends S5F7 List Enabled Alarm Request (W=1) from a Host.
• pdcomm_gem_program_at Function — Copies one stored program by position.
• pdcomm_gem_program_cancel_grant Function — Cancels a grant activated by answering an S7F1.
• pdcomm_gem_program_confirm_reply Function — Accepts an unconfirmed installation so its reply can be sent.
• pdcomm_gem_program_delete Function — Sends an S7F17 delete process program send (Host only).
• pdcomm_gem_program_delete_local Function — Deletes stored programs locally.
• pdcomm_gem_program_directory Function — Sends a header-only S7F19 current EPPD request (Host only).
• pdcomm_gem_program_get Function — Copies the body of a stored program by PPID.
• pdcomm_gem_program_grant Function — Sends an S7F1 process program load inquire.
• pdcomm_gem_program_put Function — Stores a program locally.
• pdcomm_gem_program_request Function — Sends an S7F5 process program request.
• pdcomm_gem_program_respond Function — Answers an incoming S7F1, F3, F5, F17, or F19 request.
• pdcomm_gem_program_resync Function — Retries the parent directory synchronization of a file store.
• pdcomm_gem_program_send Function — Sends an S7F3 process program send.
• pdcomm_gem_program_state Function — Reads the usage of the program store.
• pdcomm_gem_result_alarm_at Function — Reads one alarm tuple of a validated Host alarm result and copies its text.
• pdcomm_gem_result_alarm_info Function — Reads the summary of a validated Host alarm report or alarm list result.
• pdcomm_gem_result_body Function — Copies the SECS-II body of the message behind a result.
• pdcomm_gem_result_command_info Function — Reads the summary of a remote command request or reply result.
• pdcomm_gem_result_command_issue Function — Copies one CPACK entry of a command request validation or a received reply.
• pdcomm_gem_result_command_name Function — Copies the RCMD item of a received S2F41 request.
• pdcomm_gem_result_command_parameter Function — Copies one CPNAME/CPVAL pair of a received S2F41 request.
• pdcomm_gem_result_constant_change Function — Copies one ECID/ECV pair of a received S2F15 and the value at receipt.
• pdcomm_gem_result_constant_change_info Function — Reads the receipt validation and decision state of an S2F15 or S2F16 result.
• pdcomm_gem_result_constant_metadata Function — Copies one metadata field of one entry of an S2F30 reply.
• pdcomm_gem_result_constant_value Function — Copies one value, and its requested ID, from an S2F14 reply.
• pdcomm_gem_result_destroy Function — Releases a result.
• pdcomm_gem_result_directory_at Function — Reads the ID and VID count of one entry of a validated S1F22 or S1F24 reply.
• pdcomm_gem_result_directory_get Function — Copies one field of one entry of a validated S1F22 or S1F24 reply.
• pdcomm_gem_result_enhanced_command_acknowledgements Function — Copies the outer acknowledgement List of an enhanced command result.
• pdcomm_gem_result_enhanced_command_info Function — Reads the summary of an enhanced command request or reply result.
• pdcomm_gem_result_enhanced_command_name Function — Copies the RCMD item of a received S2F49 request.
• pdcomm_gem_result_enhanced_command_object Function — Copies the OBJSPEC item of a received S2F49 request.
• pdcomm_gem_result_enhanced_command_parameter Function — Copies one CPNAME/CEPVAL pair of a received S2F49 request.
• pdcomm_gem_result_event_info Function — Reads the DATAID, CEID, report count, and acknowledgement state of a received S6F11.
• pdcomm_gem_result_event_report Function — Reads the RPTID and value count of one report in a received S6F11.
• pdcomm_gem_result_event_value Function — Copies one value of one report in a received S6F11.
• pdcomm_gem_result_formatted_program_capability_command_code_copy Function — Copies the CCODE (command code) of one capability command.
• pdcomm_gem_result_formatted_program_capability_command_info Function — Reads the fixed-size fields of one capability command.
• pdcomm_gem_result_formatted_program_capability_command_name_copy Function — Copies the CNAME (command name) of one capability command.
• pdcomm_gem_result_formatted_program_capability_dependency_at Function — Reads one value of a command's dependency vector.
• pdcomm_gem_result_formatted_program_capability_info Function — Reads the summary of a capability result.
• pdcomm_gem_result_formatted_program_capability_model_copy Function — Copies the MDLN (model name) of a capability result.
• pdcomm_gem_result_formatted_program_capability_parameter_get Function — Copies one parameter descriptor of a capability command.
• pdcomm_gem_result_formatted_program_capability_software_revision_copy Function — Copies the SOFTREV (software revision) of a capability result.
• pdcomm_gem_result_formatted_program_id_get Function — Copies the PPID of a verification report as a new SECS-II item.
• pdcomm_gem_result_formatted_program_info Function — Reads the summary of a verification report result.
• pdcomm_gem_result_formatted_program_issue_at Function — Copies one issue of a verification report.
• pdcomm_gem_result_formatted_program_query_command_code_get Function — Copies the CCODE of one returned command as a new SECS-II item.
• pdcomm_gem_result_formatted_program_query_command_info Function — Reads the parameter count and CCODE format of one returned command.
• pdcomm_gem_result_formatted_program_query_id_get Function — Copies the requested PPID of a query result as a new SECS-II item.
• pdcomm_gem_result_formatted_program_query_info Function — Reads the summary of a query result.
• pdcomm_gem_result_formatted_program_query_model_copy Function — Copies the MDLN of the program in a query result.
• pdcomm_gem_result_formatted_program_query_parameter_get Function — Copies one PPARM of one returned command as a new SECS-II item.
• pdcomm_gem_result_formatted_program_query_software_revision_copy Function — Copies the SOFTREV of the program in a query result.
• pdcomm_gem_result_formatted_program_transfer_command_code_get Function — Copies the CCODE of one received command as a new SECS-II item.
• pdcomm_gem_result_formatted_program_transfer_command_info Function — Reads the parameter count and CCODE format of one received command.
• pdcomm_gem_result_formatted_program_transfer_id_get Function — Copies the PPID of a received S7F23 program as a new SECS-II item.
• pdcomm_gem_result_formatted_program_transfer_info Function — Reads the summary of a transfer result.
• pdcomm_gem_result_formatted_program_transfer_model_copy Function — Copies the MDLN of a received S7F23 program.
• pdcomm_gem_result_formatted_program_transfer_parameter_get Function — Copies one PPARM of one received command as a new SECS-II item.
• pdcomm_gem_result_formatted_program_transfer_software_revision_copy Function — Copies the SOFTREV of a received S7F23 program.
• pdcomm_gem_result_formatted_program_verification_negotiation_info Function — Reads the negotiation details of a GEM result.
• pdcomm_gem_result_formatted_program_verification_request_command_code_get Function — Copies the CCODE of one received command as a new SECS-II item.
• pdcomm_gem_result_formatted_program_verification_request_command_info Function — Reads the parameter count and CCODE format of one received command.
• pdcomm_gem_result_formatted_program_verification_request_id_get Function — Copies the PPID of a received S7F31 program as a new SECS-II item.
• pdcomm_gem_result_formatted_program_verification_request_info Function — Reads the summary of a verification request result.
• pdcomm_gem_result_formatted_program_verification_request_model_copy Function — Copies the MDLN of a received S7F31 program.
• pdcomm_gem_result_formatted_program_verification_request_parameter_get Function — Copies one PPARM of one received command as a new SECS-II item.
• pdcomm_gem_result_formatted_program_verification_request_software_revision_copy Function — Copies the SOFTREV of a received S7F31 program.
• pdcomm_gem_result_info Function — Copies the fixed fields of a result.
• pdcomm_gem_result_program_info Function — Reads the process program details of a GEM result.
• pdcomm_gem_result_program_item Function — Copies a PPID or PPBODY from a program result.
• pdcomm_gem_result_query_info Function — Reads the summary of a report query request or response.
• pdcomm_gem_result_query_report Function — Reads the RPTID and value count of one report in an S6F16 reply.
• pdcomm_gem_result_query_value Function — Copies one value of a report query response.
• pdcomm_gem_result_spool_error_at Function — Reads one stream error from a received S2F44 (Host).
• pdcomm_gem_result_spool_info Function — Reads the spooling details of a GEM result.
• pdcomm_gem_result_spool_selection_at Function — Reads one stream selection from an S2F43 request or S2F60 reply.
• pdcomm_gem_result_status_name Function — Copies one SVID, name, and units entry from an S1F12 result.
• pdcomm_gem_result_status_value Function — Copies one status variable value from an S1F4 result.
• pdcomm_gem_spool_capture Function — Offers a generic primary message to the spool.
• pdcomm_gem_spool_capture_alarm Function — Builds an S5F1 alarm report and offers it to the spool.
• pdcomm_gem_spool_capture_event Function — Builds an S6F11 event report and offers it to the spool.
• pdcomm_gem_spool_catalog_at Function — Reads one catalog entry by position.
• pdcomm_gem_spool_complete_delivery Function — Completes a delivery attempt and dequeues the head on success.
• pdcomm_gem_spool_configure_local Function — Replaces the local spool policy and stream/function selection.
• pdcomm_gem_spool_confirm_reply Function — Accepts an unconfirmed installation so its reply can be sent.
• pdcomm_gem_spool_entry_at Function — Reads one spooled message by queue position.
• pdcomm_gem_spool_entry_time_at Function — Reads the capture timestamp of one spooled message.
• pdcomm_gem_spool_purge Function — Removes every spooled message locally.
• pdcomm_gem_spool_request_configure Function — Sends an S2F43 reset spooling streams and functions request (Host).
• pdcomm_gem_spool_request_data Function — Sends an S6F23 request spooled data (Host).
• pdcomm_gem_spool_request_query Function — Sends a header-only S2F59 spool configuration request (Host).
• pdcomm_gem_spool_respond Function — Answers an incoming S2F43, S2F59, or S6F23 request (Equipment).
• pdcomm_gem_spool_resync Function — Retries the parent directory synchronization of a file spool.
• pdcomm_gem_spool_retry_dequeue Function — Retries a pending dequeue after an accepted delivery.
• pdcomm_gem_spool_selection_at Function — Reads one stream selection of the current local selection.
• pdcomm_gem_spool_send_next Function — Sends the head of the spool queue during an accepted transmission.
• pdcomm_gem_spool_state Function — Reads the current Equipment spool state.
• pdcomm_gem_spool_stop_transmit Function — Ends the current transmission run.
• pdcomm_gem_spool_sync Function — Synchronizes the spool with the current communication state.
• pdcomm_gem_state Function — Reads the current GEM state of an endpoint.
• pdcomm_secs1_create Function — Creates a stopped SECS-I endpoint.
• pdcomm_secs1_destroy Function — Releases an endpoint without invoking callbacks.
• pdcomm_secs1_event_body Function — Copies the body of an inbound event.
• pdcomm_secs1_event_destroy Function — Releases an event.
• pdcomm_secs1_event_info Function — Describes an event.
• pdcomm_secs1_next_event Function — Takes the oldest queued event.
• pdcomm_secs1_poll Function — Runs line control, timers, and callback I/O for one time slice.
• pdcomm_secs1_reset Function — Clears a terminal fault so the endpoint can transfer messages again.
• pdcomm_secs1_start Function — Starts a created or stopped endpoint.
• pdcomm_secs1_state Function — Reads the identity and lifecycle flags of an endpoint.
• pdcomm_secs1_stop Function — Stops a started endpoint and discards its runtime state.
• pdcomm_secs1_submit Function — Queues one message for transmission.
• pdcomm_secs_child Function — Copies one child of a List into a new, independent item.
• pdcomm_secs_decode Function — Decodes exactly one SECS-II item from encoded bytes.
• pdcomm_secs_destroy Function — Releases an item handle.
• pdcomm_secs_encode Function — Encodes an item as SECS-II bytes into caller storage.
• pdcomm_secs_info Function — Reads the format, element count, and size of an item.
• pdcomm_secs_list Function — Creates a List item from copies of existing items.
• pdcomm_secs_payload Function — Copies the raw payload bytes of a primitive item.
• pdcomm_secs_primitive Function — Creates a primitive item from raw payload bytes.
• pdcomm_tcp_cancel Function — Cancels an open transaction.
• pdcomm_tcp_create Function — Creates an HSMS endpoint.
• pdcomm_tcp_deselect Function — Sends Deselect.req to leave the SELECTED state.
• pdcomm_tcp_destroy Function — Releases an endpoint and its sockets.
• pdcomm_tcp_event_body Function — Copies the message body of a received event.
• pdcomm_tcp_event_destroy Function — Releases an event.
• pdcomm_tcp_event_info Function — Decodes the kind, codes, header, and token of an event.
• pdcomm_tcp_is_pending Function — Reports whether a transaction is still waiting for its response.
• pdcomm_tcp_linktest Function — Sends Linktest.req to check that the connection is alive.
• pdcomm_tcp_local_address Function — Copies the local socket address as text.
• pdcomm_tcp_next_event Function — Removes the oldest event from the endpoint's event queue.
• pdcomm_tcp_poll Function — Performs pending socket I/O and HSMS timer processing.
• pdcomm_tcp_reply Function — Submits the reply to a received primary that has the W-bit set.
• pdcomm_tcp_request Function — Submits a primary data message.
• pdcomm_tcp_select Function — Sends Select.req to enter the SELECTED state.
• pdcomm_tcp_start Function — Starts a new connection generation.
• pdcomm_tcp_state Function — Reads the endpoint identity, generation, HSMS state, and close status.
• pdcomm_tcp_stop Function — Stops the endpoint and starts a graceful close.