pdcomm_gem_formatted_program_execution_step
Function
Requests the next program command as a Step action.
PdcommStatus pdcomm_gem_formatted_program_execution_step(PdcommTcpEndpoint *endpoint, const PdcommGemFormattedProgramExecutionToken *execution_token, PdcommGemFormattedProgramExecutionActionHandle **out_action)Allowed in RUNNING while commands remain; the state becomes STEP_PENDING. In STEP_PENDING the call returns the pending Step action again. A connection is not required.
Parameters
| Name | Description |
|---|---|
endpoint | Equipment endpoint with formatted program queries configured. |
execution_token | Token of the current execution. |
out_action | Receives the Step action. When endpoint is valid and not poisoned, it is set to NULL first, so it is NULL after every later failure. |
Returns
#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when a pointer is NULL or the token has an invalid size, version, or reserved field; #PDCOMM_STALE_TOKEN when the token does not identify the current execution; #PDCOMM_INVALID_STATE when execution tracking is not available, the state is not RUNNING or STEP_PENDING, or every command was applied; #PDCOMM_LIMIT_EXCEEDED when the action history or sequence counter is exhausted; #PDCOMM_BACKPRESSURE when the endpoint holds a staged TCP event; #PDCOMM_ALLOCATION_FAILED; #PDCOMM_POISONED.
Notes
- Ownership: release the action with pdcomm_gem_formatted_program_execution_action_destroy().