summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2009-08-03 23:07:59 +0200
committerLennart Poettering <lennart@poettering.net>2009-08-03 23:07:59 +0200
commit3e2ab9b22ed95bab3c69b1ea32cf2b8449fe3427 (patch)
tree9b3ae71e3b9955081d4bb20c17cc04aba57c31c2
parenta44cb642ebd2543e55314d4d8679a9b3d115e533 (diff)
client: extend documentation on pa_operation_cancel() a bit
-rw-r--r--src/pulse/operation.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/pulse/operation.h b/src/pulse/operation.h
index 7b0dabdd..b6b5691d 100644
--- a/src/pulse/operation.h
+++ b/src/pulse/operation.h
@@ -40,7 +40,11 @@ pa_operation *pa_operation_ref(pa_operation *o);
/** Decrease the reference count by one */
void pa_operation_unref(pa_operation *o);
-/** Cancel the operation. Beware! This will not necessarily cancel the execution of the operation on the server side. */
+/** Cancel the operation. Beware! This will not necessarily cancel the
+ * execution of the operation on the server side. However it will make
+ * sure that the callback associated with this operation will not be
+ * called anymore, effectively disabling the operation from the client
+ * side's view. */
void pa_operation_cancel(pa_operation *o);
/** Return the current status of the operation */