client: extend documentation on pa_operation_cancel() a bit

This commit is contained in:
Lennart Poettering 2009-08-03 23:07:59 +02:00
parent a44cb642eb
commit 3e2ab9b22e

View file

@ -40,7 +40,11 @@ pa_operation *pa_operation_ref(pa_operation *o);
/** Decrease the reference count by one */ /** Decrease the reference count by one */
void pa_operation_unref(pa_operation *o); 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); void pa_operation_cancel(pa_operation *o);
/** Return the current status of the operation */ /** Return the current status of the operation */