evmvargetxxx man page on HP-UX

Man page or keyword search:  
man Server   10987 pages
apropos Keyword Search (all sections)
Output format
HP-UX logo
[printable version]

EvmVarGet(3)							  EvmVarGet(3)

NAME
       EvmVarGet(),   EvmVarGetOpaque(),  EvmVarGetString(),  EvmVarGetType(),
       EvmVarGetXxx(),	EvmVarListFree(),  EvmVarListGet(),   EvmVarRelease(),
       EvmVarSet(), EvmVarSetOpaque(), EvmVarSetStringI18N(), EvmVarSetXxx() -
       manipulate event variables

SYNOPSIS
   Library
       EVM Support Library

   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	if  the	 named variable exists, the associated data is
		   modified.  If the variable 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:

		   For 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	 vari‐
		   able.   The identifier must refer to a message in the cata‐
		   log and message set associated  with	 the  event  (see  the
		   EvmItemSet(3) manpage).

		   The	msg_id	operand is ignored for variables whose type is
		   not

       size	   The size of the associated item_value in bytes.  The caller
		   must	 specify  the  correct size when setting a variable of
		   type For all other variable types, the size is ignored.

       var	   For the routine, this is a pointer to  the  location	 where
		   the output data is to be stored.

		   For	the 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 not
		   including the terminating NULL pointer.

       varlist	   On  return  from the 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  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  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 and routines offer a simpler means of setting a variable  than  the
       generic	routine.   Using these routines, a single call can set a vari‐
       able of any type.  To use these routines, replace the Xxx() in the rou‐
       tine name with the required type name, and supply a value of the corre‐
       sponding type as the item_value operand.	 The following types are  sup‐
       ported:

       Boolean,	 Char,	Int16,	Int32,	Int64,	Uint8, Uint16, Uint32, Uint64,
       Float, Double, String.

       Use to set a string variable with a non-zero I18N message-ID.   Use  to
       set an opaque variable.	Each of these routines requires one more oper‐
       and than the others in this group.

       The routine returns the event variable indicated by v_name in  the  var
       variable.  The caller must free any space used by the variable by call‐
       ing

       The routine returns the type of the named variable.

       The and routines offer a simpler means of retrieving a  variable	 value
       than  the generic routine.  These routines can retrieve a variable of a
       specific type with a single call.  To use these routines,  replace  the
       Xxx()  in  the  routine	name with the required type name, and supply a
       pointer to a location of	 the  corresponding  type  as  the  item_value
       pointer.	  Refer	 to  the  description of above for details of the sup‐
       ported types.

       Use to retrieve a string variable, specifying NULL for the msg_id oper‐
       and  if you do not want to receive an I18N message-ID.  Use to retrieve
       an opaque variable.  Each of these routines requires one	 more  operand
       than the others in this group.

       Note that and return their variable values in heap memory.  Use to free
       this space when it is no longer needed.

       The routine releases any storage space allocated when the specified var
       was  retrieved from an event using It is important that this routine is
       called when the variable is no longer needed to ensure that all	memory
       associated  with	 the variable is released.  Do not use this routine to
       release variables retrieved with any of the routines.

       The routine returns, in the varList reference argument, a pointer to an
       array of pointers to names of all the variables contained in the event.
       The last entry in the array is a NULL pointer.  The var_count  argument
       receives	 the number of names in the list, not counting the terminating
       null value.  The caller must free the memory used by the list by	 call‐
       ing

       The routine frees the memory used by a variable list (varList).

   Notes
       The  caller  must specify the size when adding an opaque variable to an
       event.

       To avoid memory leakage, memory that is supplied to the caller from API
       routines must be freed with the appropriate routine.

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
	      or a that is not part of the event being processed.

ERRORS
       The value of is not set.

SEE ALSO
   Event Management
       EVM(5).

   EVM Events
       EvmEvent(5)

								  EvmVarGet(3)
[top]

List of man pages available for HP-UX

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net