Function ziAPIGetDemodSample#

ZIResult_enum ziAPIGetDemodSample(ZIConnection conn, const char *path, ZIDemodSample *value)#

Gets the demodulator sample value of the specified node.

This function retrieves the value of the specified node as an DemodSample struct. The value first found is returned if more than one value is available (a wildcard is used in the path). This function is only applicable to paths matching DEMODS/[0-9]+/SAMPLE.

Parameters:
  • conn[in] Pointer to ZIConnection with which the value should be retrieved

  • path[in] Path to the node holding the value

  • value[out] Pointer to a ZIDemodSample struct in which the value should be written

Returns:

  • ZI_INFO_SUCCESS on success

  • ZI_ERROR_CONNECTION when the connection is invalid (not connected) or when a communication error occurred

  • ZI_ERROR_LENGTH if the path’s length exceeds MAX_PATH_LEN

  • ZI_ERROR_COMMAND on an incorrect answer of the server

  • ZI_ERROR_SERVER_INTERNAL if an internal error occurred in Data Server

  • ZI_WARNING_NOTFOUND if the given path could not be resolved or no value is attached to the node

  • ZI_ERROR_TIMEOUT when communication timed out

  • Other return codes may also be returned, for a detailed error message use ziAPIGetLastError.