Index for Section 3

Alphabetical listing for E

Bottom of page

EvmEventCreate(3)
NAME
  EvmEventCreate, EvmEventCreateVa, EvmEventDup, EvmEventDestroy - Creates
  and destroys events

SYNOPSIS
  #include <evm/evm.h>

  EvmStatus_t EvmEventCreate(
	  EvmEvent_t *event );

  EvmStatus_t EvmEventCreateVa(
	  EvmEvent_t *event,
	  [EvmItemId_t item_id,
	  const EvmItemValue_t item_value]...,
	  EvmITEM_NONE );

  EvmStatus_t EvmEventDup(
	  EvmEvent_t *dupev,
	  EvmEvent_t event );

  EvmStatus_t EvmEventDestroy(
	  EvmEvent_t event );

OPERANDS
  event
      The event to be created, copied, or destroyed.

  item_id
      The identifier for the Event Data Item to be set. See the EvmItemSet(3)
      reference page for possible values for this operand, and the data
      contained by the data item.

  item_value
      The value to be stored in the associated item indicated by item_id.

  dupev
      The return location where the duplicate (new) event is stored.

DESCRIPTION
  The EvmEventCreate() routine creates an empty event. The newly created
  event is returned in the event reference argument.

  The EvmEventCreateVa() routine creates an event and adds the supplied items
  in a single call. The item list is terminated by an instance of the item_id
  operand set to EvmITEM_NONE. The newly created event is returned in the
  event reference argument.

  The EvmEventDup() routine creates a copy of the supplied event and returns
  the new event in the dupev reference argument.

  The EvmEventDestroy() routine destroys a previously created event, freeing
  its memory. This function must be used if it is necessary to destroy an
  event, to ensure that all associated memory is freed.

RESTRICTIONS
  To avoid memory leakage, all structures that are supplied to the caller
  from API routines must be freed with the appropriate EVM API free routine.

RETURN VALUES
  EvmERROR_NONE
      The operation was completed without error.

  EvmERROR_INVALID_ARGUMENT
      One of the arguments to the function was invalid.

  EvmERROR_INVALID_VALUE
      A value in a structure member is invalid.

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

ERRORS
  None

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

FILES
  None

SEE ALSO
  Commands: evmpost(1)

  Routines: EvmConnCreate(3) EvmEventPost(3) EvmItemSet(3) EvmEventWrite(3)

  Files: kevm(7)

  Event Management: EVM(5)

  EVM Events: EvmEvent(5)

Index for Section 3

Alphabetical listing for E

Top of page