set_check_cancellable


Description:

[ Version ( since = "2.36" ) ]
public void set_check_cancellable (bool check_cancellable)

Sets or clears this's check-cancellable flag.

If this is true (the default), then propagate_pointer, etc, and had_error will check the task's Cancellable first, and if it has been cancelled, then they will consider the task to have returned an "Operation was cancelled" error (g_io_error_cancelled), regardless of any other error or return value the task may have had.

If check_cancellable is false, then the Task will not check the cancellable itself, and it is up to this's owner to do this (eg, via return_error_if_cancelled).

If you are using set_return_on_cancel as well, then you must leave check-cancellable set true.

Parameters:

this

the Task

check_cancellable

whether Task will check the state of its Cancellable for you.




2022 vala-language.org