EvmItemGet(3) Library Functions Manual EvmItemGet(3)
NAME
EvmItemGet(), EvmItemListFree(), EvmItemListGet(), EvmItemRelease(), EvmItemSet(), EvmItemSetVa() - create and manipulate event items
SYNOPSIS
Library
EVM Support Library
Parameters
event The event containing the item to be manipulated.
item_id The identifier for the event data item to be set, obtained, or released by the called routine. Possible values for this op-
erand, and the data contained by the data item are identified in the following list. See the EvmEvent(5) manpage for a
description of the event data items.
Identifier Data Item
-----------------------------------------------------
EvmITEM_NONE None (Control use)
EvmITEM_NAME Event name
EvmITEM_PRIORITY Priority
EvmITEM_PID Process identifier
EvmITEM_PPID Parent process identifier
EvmITEM_EVENT_ID Event identifier
EvmITEM_TIMESTAMP Time posted
EvmITEM_REPEAT_COUNT Repeat count
EvmITEM_LAST_TIMESTAMP Last timestamp
EvmITEM_I18N_MSG_ID I18N message identifier
EvmITEM_I18N_SET_ID I18N message set identifier
EvmITEM_I18N_CATALOG I18N catalog
EvmITEM_HOST_IP Host IP address
EvmITEM_HOST_NAME Host name
EvmITEM_USER_NAME User name
EvmITEM_FORMAT Event format
EvmITEM_REF Reference
EvmITEM_VAR Variables
EvmITEM_KERNEL_ONLY Kernel distribution Only
-----------------------------------------------------
It is also possible to supply a separate item_id for each of the supported variable types. In these cases, an extra one or two op-
erands (depending on the type) must be supplied in addition to the item_value. See the description below for more information. The
following extended variable item IDs are supported:
Identifier Variable Type Parameters
-------------------------------------------------------------------
EvmITEM_VAR_CHAR EvmTYPE_CHAR Name, value
EvmITEM_VAR_INT16 EvmTYPE_INT16 Name, value
EvmITEM_VAR_INT32 EvmTYPE_INT32 Name, value
EvmITEM_VAR_INT64 EvmTYPE_INT64 Name, value
EvmITEM_VAR_UINT8 EvmTYPE_UINT8 Name, value
EvmITEM_VAR_UINT16 EvmTYPE_UINT16 Name, value
EvmITEM_VAR_UINT32 EvmTYPE_UINT32 Name, value
EvmITEM_VAR_UINT64 EvmTYPE_UINT64 Name, value
EvmITEM_VAR_FLOAT EvmTYPE_FLOAT Name, value
EvmITEM_VAR_DOUBLE EvmTYPE_DOUBLE Name, value
EvmITEM_VAR_STRING EvmTYPE_STRING Name, value
EvmITEM_VAR_STRING_I18N EvmTYPE_STRING Name, value, I18N msgid
EvmITEM_VAR_OPAQUE EvmTYPE_OPAQUE Name, value, size
-------------------------------------------------------------------
item_value The value stored into the item indicated by the associated item_id. For this is the location where the value extracted from
the event is stored.
item_count This is the return operand. It is the number of entries in item_list, exclusive of the terminating entry.
DESCRIPTION
These routines manipulate data in the standard items in an event.
The routine sets the value of the event data item specified by item_id to the item_value supplied by the caller.
The routine sets item values in the event. The list of item_id and item_value operands is terminated by an instance of item_id of
The inclusion of extended variable item-IDs simplifies programming by allowing variable items to be added to an event without first having
to set up an structure, or to release it afterwards. To use these extended item-IDs, follow each with the name of the variable, then a
value of the appropriate type. In addition, an value must be followed by an I18N message ID, and an value must be followed by a size.
The routine returns, in the item_value reference argument, the value of the event data item specified by item_id. The caller must use to
free any space allocated for the item.
The routine releases any storage space that was allocated when the data item named by item_id was retrieved from an event using
The routine returns, in the itemList reference argument, a list of all of the items, which are currently defined for the event. The last
item in the list has an item_id value of The number of items in the list, not including the terminating null identifier, is returned in
item_count. The caller is responsible for freeing the memory used by the list by calling
The routine frees the memory used by an item list. The itemList operand is a list of items in an event generated by
RETURN VALUE
The operation completed without error.
One of the arguments to the function is invalid.
A value in a structure member is invalid.
An operation failed because an attempt to acquire heap memory failed.
A request specified an item or variable name component in an
itemList or a varList that is not part of the event being processed.
ERRORS
The value of is not set.
SEE ALSO
Commands
evmshow(1).
Routines
EvmEventCreate(3), EvmEventDestroy(3), EvmEventFormat(3), EvmEventPost(3).
Event Management
EVM(5).
EVM Events
EvmEvent(5).
EvmItemGet(3)