pdcomm_gem_configure_formatted_program_transfers

Function

Enables the S7F23/S7F24 transfer service on an endpoint.

PdcommStatus pdcomm_gem_configure_formatted_program_transfers(PdcommTcpEndpoint *endpoint, const PdcommGemFormattedProgramTransferOptions *options)

Declared in: #include <pdcomm_gem_formatted_program_transfers.h>

Call it once per endpoint, after the GEM role is configured and while the endpoint is stopped. Both roles may configure it: the Host sends programs and the Equipment receives them. To store received programs, the Equipment also needs pdcomm_gem_configure_formatted_program_queries().

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_INVALID_STATE when the endpoint is not stopped, has a staged TCP event, 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.