HP-UX Reference (11i v3 07/02) - 3 Library Functions A-M (vol 6)

e
EvmVarGet(3) EvmVarGet(3)
EvmVarName_t v_name,
const evm_type
item_value );
Library
EVM Support Library (libevm.so).
Parameters
event The event to be processed.
v_name The name of a variable in the event for which data is to be set or obtained.
For EvmVarSet() , if the named variable exists, the associated data is modified. If the vari-
able does not exist, it is created and added to the event. The value to be stored is passed in
item_value.
type The enumeration constant for the type of the item_value to be stored in the variable indicated
by v_name. Possible values for this field are:
EvmTYPE_BOOLEAN
EvmTYPE_CHAR
EvmTYPE_INT16
EvmTYPE_INT32
EvmTYPE_INT64
EvmTYPE_UINT8
EvmTYPE_UINT16
EvmTYPE_UINT32
EvmTYPE_UINT64
EvmTYPE_FLOAT
EvmTYPE_DOUBLE
EvmTYPE_STRING
EvmTYPE_OPAQUE
For EvmVarGetType()
, the type operand is a returned value.
item_value The value to be stored in the variable indicated by v_name.
msg_id For a string variable being set in an internationalized event, msg_id may contain an I18N
(internationalization) message identifier corresponding to the value of the variable. The
identifier must refer to a message in the catalog and message set associated with the event
(see the EvmItemSet (3) manpage).
The msg_id operand is ignored for variables whose type is not
EvmTYPE_STRING
.
size The size of the associated item_value in bytes. The caller must specify the correct size when
setting a variable of type
EvmTYPE_OPAQUE
. For all other variable types, the size is
ignored.
var For the
EvmVarGet() routine, this is a pointer to the location where the output data is to be
stored.
For the EvmVarRelease() routine, this is a pointer to the storage space to be released.
var_count This is the number of names in the var_list obtained by EvmVarListGet(), not including
the terminating NULL pointer.
varlist On return from the
EvmVarListGet() routine, this is a list of pointers to the names of the
variables associated with the event. The last item in the list is a NULL pointer.
For the EvmVarListFree() routine, this is a list of names of variables for which memory
should be freed. The list must be terminated by a NULL pointer.
DESCRIPTION
The EvmVarSet() routine sets the value of a variable data item, indicated by v_name, in an event. This
routine is used both for adding a variable and for altering its value. If the v_name variable is not already
present in the event, it is added.
The EvmVarSetXxx(), EvmVarSetStringI18N(), and EvmVarSetOpaque() routines offer a
simpler means of setting a variable than the generic EvmVarSet() routine. Using these routines, a sin-
gle call can set a variable of any type. To use these routines, replace the Xxx() in the routine name with the
HP-UX 11i Version 3: February 2007 − 2 − Hewlett-Packard Company 403