Function k_work_cancel

pub unsafe extern "C" fn k_work_cancel(work: *mut k_work) -> i32

@brief Cancel a work item.

This attempts to prevent a pending (non-delayable) work item from being processed by removing it from the work queue. If the item is being processed, the work item will continue to be processed, but resubmissions are rejected until cancellation completes.

If this returns zero cancellation is complete, otherwise something (probably a work queue thread) is still referencing the item.

See also k_work_cancel_sync().

@funcprops \isr_ok

@param work pointer to the work item.

@return the k_work_busy_get() status indicating the state of the item after all cancellation steps performed by this call are completed.