ec_spool_ctx_filter_open

March 26, 2020 Contributors

Name

ec_spool_ctx_filter_open — Access the spool in the specified way

Synopsis

#include "spool.h"

| io_object * **ec_spool_ctx_filter_open** ( | ctx, |   |
|   | mess, |   |
|   | what, |   |
|   | filename, |   |
|   | options, |   |
|   | mode); |   |

ec_spool_ctx * <var class="pdparam">ctx</var>;
ec_message * <var class="pdparam">mess</var>;
int <var class="pdparam">what</var>;
const char * <var class="pdparam">filename</var>;
int <var class="pdparam">options</var>;
int <var class="pdparam">mode</var>;

Description

Access the spool in the specified way.

Parameters

ctx

The spool context.

mess

The message.

what

The filter to use. Legitimate values for this parameter are as follows:

#define EC_SPOOL_FILTER_META_READ     1
#define EC_SPOOL_FILTER_META_WRITE    2
#define EC_SPOOL_FILTER_CONTENT_READ  3
#define EC_SPOOL_FILTER_CONTENT_WRITE 4
#define EC_SPOOL_FILTER_OVERLAY_READ  5
#define EC_SPOOL_FILTER_OVERLAY_WRITE 6
#define EC_SPOOL_FILTER_GROWBUF_WRITE 7
#define EC_SPOOL_FILTER_GROWBUF_READ  8
#define EC_SPOOL_FILTER_RSRC_READ     9
#define EC_SPOOL_FILTER_RSRC_WRITE    10
filename

The file name.

options

Options can be any combination of the following system constants:

O_RDWR
O_CREAT
O_RDONLY
O_WRONLY
O_TRUNC
O_EXCL
mode

The octal representation of the file mode.

Return Values

This function returns an io_object.

Threading

It is legal to call this function in any thread.

See Also

“ec_spool_ctx”, “ec_message” and “io_object”