pdcomm_gem_configure_formatted_programs

Function

Enables the S7F27/S7F28 verification report service on an endpoint.

PdcommStatus pdcomm_gem_configure_formatted_programs(PdcommTcpEndpoint *endpoint, const PdcommGemFormattedProgramOptions *options)

Declared in: #include <pdcomm_gem_formatted_programs.h>

Call it once per endpoint, after pdcomm_gem_configure_host() or pdcomm_gem_configure_equipment() and before pdcomm_tcp_start(), while the endpoint is stopped. Both roles may configure the service: the Equipment sends reports and the Host receives them.

Parameters

Name	Description
`endpoint`	Stopped endpoint with a configured GEM role.
`options`	Service limits. Read only during the call.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when endpoint or options is NULL, options->struct_size is too small, version or reserved is wrong, or a queue limit (max_pending, max_received, max_results, max_history) is 0; #PDCOMM_BACKPRESSURE when a staged TCP event must be drained first; #PDCOMM_INVALID_STATE when the endpoint is not stopped, has no GEM role, or already has this service; #PDCOMM_ALLOCATION_FAILED when the queues cannot be allocated; #PDCOMM_POISONED when the endpoint is poisoned.

Notes

Thread safety: serialize with every other call on endpoint.