summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
Diffstat (limited to 'include')
-rw-r--r--include/wolf/service/service.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/include/wolf/service/service.h b/include/wolf/service/service.h
index 2645bc3..fbe811e 100644
--- a/include/wolf/service/service.h
+++ b/include/wolf/service/service.h
@@ -85,8 +85,12 @@ wolf_error_t wolf_service_remove( LPCTSTR service_name );
* @param service_main the main function (which should implement startup/shutdown
* and the main processing loop)
*
- * @return When the main thread terminates after a service shutdown.
- * You should not do much after this point in the code..
+ * @return Doesn't return till the service terminates, then it
+ * returns WOLF_OK.
+ * On the other hand if we don't get called as service
+ * we get a WOLF_ERR_INVALID_STATE indicating that the
+ * service is run in the console, in this case you can
+ * call wolf_service_start_console instead of this function.
*/
wolf_error_t wolf_service_start( LPTSTR service_name,
LPSERVICE_MAIN_FUNCTION service_main );