From 5ca9d3a7b8e4b2134d12d2f622eb00693f920356 Mon Sep 17 00:00:00 2001 From: Micke Prag Date: Fri, 28 Oct 2011 15:10:03 +0200 Subject: [PATCH] Add documentation for tdSensor(), see #110 --- telldus-core/client/telldus-core.cpp | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/telldus-core/client/telldus-core.cpp b/telldus-core/client/telldus-core.cpp index f88b5c1d..1ae3649b 100644 --- a/telldus-core/client/telldus-core.cpp +++ b/telldus-core/client/telldus-core.cpp @@ -534,6 +534,17 @@ void WINAPI tdDisconnectTellStickController(int vid, int pid, const char *serial Client::getWStringFromService(msg); } +/** + * Use this function to iterate over all sensors. Iterate until + * TELLSTICK_SUCCESS is not returned + * @param protocol A byref string where the protocol of the sensor will be placed + * @param protocolLen The length of the \c protocol parameter + * @param model A byref string where the model of the sensor will be placed + * @param modelLen The length of the \c model parameter + * @param id A byref int where the id of the sensor will be placed + * @param dataTypes A byref int with flags for the supported sensor values + * @returns TELLSTICK_SUCCESS if there is more sensors to be fetched + */ int WINAPI tdSensor(char *protocol, int protocolLen, char *model, int modelLen, int *id, int *dataTypes) { Client *client = Client::getInstance(); return client->getSensor(protocol, protocolLen, model, modelLen, id, dataTypes);