sieve_suspend

March 26, 2020 Contributors

Name

sieve_suspend — Suspend the current Sieve action

Synopsis

#include "sieve/ecsieve.h"

| void **sieve_suspend** ( | seng); |   |

SENG * <var class="pdparam">seng</var>;

Description

Suspend the current Sieve action. Use this function only if can_go_async is true. Use sieve_resume to resume the Sieve action.

Parameters

seng

The Sieve engine state.

Return Values

This function returns void.

Threading

It is legal to call this function in the Scheduler thread.

See Also

Section 68.73, “SENG (sieve_engine)”, sieve_resume, sieve_seng_get_can_go_async and sieve_seng_set_can_go_async