Function ziAPIModListNodes#

ZIResult_enum ziAPIModListNodes(ZIConnection conn, ZIModuleHandle handle, const char *path, char *nodes, uint32_t bufferSize, uint32_t flags)#

Returns all child parameter node paths found under the specified parent module parameter path.

This function returns a list of parameter names found at the specified path. The path may contain wildcards. The list is returned in a null-terminated char-buffer, each element delimited by a newline. If the maximum length of the buffer (bufferSize) is not sufficient for all elements, nothing will be returned and the return value will be ZI_ERROR_LENGTH.

Parameters:

  • conn – [in] The ZIConnection from which the module was created.

  • handle – [in] The ZIModuleHandle from which the parameter names should be retrieved.

  • path – [in] Path for which all children will be returned. The path may contain wildcard characters.

  • nodes – [out] Upon call filled with newline-delimited list of the names of all the children found. The string is zero-terminated.

  • bufferSize – [in] The length of the buffer specified as the nodes output parameter.

  • flags – [in] A combination of flags (applied bitwise) as defined in ZIListNodes_enum.

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 or the length of the char-buffer for the nodes given by bufferSize is too small for all elements.

  • 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.

  • ZI_ERROR_TIMEOUT When communication timed out.

  • ZI_ERROR_GENERAL If a general error occurred, use ziAPIGetLastError for a detailed error message.

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