ec_spool_ctx_swap_out_met

March 26, 2020 Contributors

Name

ec_spool_ctx_swap_out_met — Swap out everything about the message except for the body

Synopsis

#include "spool.h"

| int **ec_spool_ctx_swap_out_met** ( | ctx, |   |
|   | mid, |   |
|   | force); |   |

ec_spool_ctx * <var class="pdparam">ctx</var>;
message_id * <var class="pdparam">mid</var>;
int <var class="pdparam">force</var>;

Description

Swap out everything about a message such as the envelope, size, context dictionaries, etc.) except for the body.

Parameters

ctx

The spool context.

mid

The message id.

force

Set this parameter to 1 to force a swap out. Otherwise set it to 0.

Return Values

On success this function returns EC_MSG_SWAP_RESULT_COMPLETE or EC_MSG_SWAP_RESULT_PARTIAL; on failure EC_MSG_SWAP_RESULT_ERR is returned.

Threading

It is legal to call this function in any thread.

See Also

“ec_spool_ctx” and “message_id”