11.12.3.4.35. Function iot_agent_service_get_protocol_of_service_as_string

11.12.3.4.35.1. Function Documentation

iot_agent_status_t iot_agent_service_get_protocol_of_service_as_string(const nxp_iot_ServiceDescriptor *service_descriptor, const char **buffer)

Get a textual description of the protocol.

Protocol strings are internal constant c-strings. This function returns a pointer to such a string, ownership remains with the iot_agent.

Parameters
  • [in] service_descriptor: The service descriptor to get the protocol for.

  • [out] buffer: A pointer to a c-string that is changed to point to the textual representation of the protocol.

Return Value
  • IOT_AGENT_SUCCESS: The service type could be resolved.

  • IOT_AGENT_FAILURE: The service type is invalid.