Index for Section 3

Alphabetical listing for E

Bottom of page

EvmEventRead(3)
NAME
  EvmEventRead, EvmEventWrite - Performs I/O of events to and from a file

SYNOPSIS
  #include <evm/evm.h>

  EvmStatus_t EvmEventRead(
	  EvmFd_t fd,
	  EvmEvent_t *event );

  EvmStatus_t EvmEventWrite(
	  EvmFd_t fd,
	  const EvmEvent_t event );

OPERANDS
  event
      For EvmEventRead(), the return operand created for the event read. For
      EvmEventWrite(), the event to be written.

  fd  The file descriptor to which the event should be written, or from which
      it should be read.

DESCRIPTION
  The EvmEventRead() routine creates a new event structure and populates it
  with an event read from the supplied file descriptor (fd). The
  EvmEventDestroy() routine must be used to destroy the new event when it is
  no longer needed.

  The EvmEventWrite() routine writes the supplied event to the specified file
  descriptor (fd).  It does not destroy the event. If the event is no longer
  needed, the caller should call EvmEventDestroy().

RESTRICTIONS
  None

RETURN VALUES
  EvmERROR_NONE
      The operation was completed without error.

  EvmERROR_EOF
      En end-of-file condition was encountered while reading.

  EvmERROR_INVALID_ARGUMENT
      One of the arguments to the function was invalid.

  EvmERROR_NO_MEMORY
      An operation failed because an attempt to acquire heap memory failed.

  EvmERROR_READ
      An error occurred while reading an event.

  EvmERROR_WRITE
      An error occurred while writing an event.

ERRORS
  None

LIBRARY
  EVM Support Library (libevm.so, libevm.a)

FILES
  None

SEE ALSO
  Routines: EvmEventDestroy(3)

  Files: kevm(7)

  Event Management: EVM(5)

  EVM Events: EvmEvent(5)

Index for Section 3

Alphabetical listing for E

Top of page