pdcomm_gem_configure_formatted_program_capabilities
Function
Enables the formatted program capability service on a GEM endpoint.
PdcommStatus pdcomm_gem_configure_formatted_program_capabilities(PdcommTcpEndpoint *endpoint, const PdcommGemFormattedProgramCapabilityOptions *options)Call once, after configuring the GEM host or equipment and while the endpoint is stopped. The service allocates its bounded queues up front.
Parameters
| Name | Description |
|---|---|
endpoint | TCP endpoint with a configured GEM role. |
options | Service limits; see ::PdcommGemFormattedProgramCapabilityOptions. |
Returns
#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when endpoint or options is NULL, options->struct_size is too small, version is not #PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_OPTIONS_VERSION, reserved is nonzero, or a queue limit (max_pending, max_received, max_results, max_history) is 0; #PDCOMM_INVALID_STATE when the endpoint is not stopped, holds a staged event, has no GEM role, or is already configured for capabilities; #PDCOMM_ALLOCATION_FAILED when the queues cannot be allocated; #PDCOMM_POISONED when the endpoint was poisoned by an earlier panic.