event_io_printf

March 26, 2020 Contributors

Name

event_io_printf — Initiate a formatted write to an event

Synopsis

#include "event.h"

| int **event_io_printf** ( | e, |   |
|   | state, |   |
|   | fmt, |   |
|   | ); |   |

Event * <var class="pdparam">e</var>;
event_io_state * <var class="pdparam">state</var>;
const char * <var class="pdparam">fmt</var>;
<var class="pdparam">...</var>;

Description

Initiate a formatted write to an event.

Expands the printf style format string into an internal stack buffer that is 8192 bytes in size. If the expanded string would overflow the buffer, this function will return EVENT_IO_ERROR.

Once the format string has been expanded, this function passes the resultant data to event_io_write.

Return values and semantics are otherwise identical to event_io_write.

Parameters

e

For a description of this data type see “Event”.

state

For a description of this data type see “event_io_state”

fmt

The format specifier.

The variable argument.

Return Value

This function returns one of the following values:

  • EVENT_IO_DONE

  • EVENT_IO_ERROR

  • EVENT_IO_PENDING

Threading

Warning

Only call this function from the Scheduler thread.

See Also

Event Functions