NAME
irSetVarParam, irGetVarParam, irPrintVarParam
SYNOPSIS
#include <irapi.h>
int irGetVarParam (int identifier,...);
int irSetVarParam (int identifier,...);
int irPrintVarParam (int identifier...);
DESCRIPTION
The irGetVarParam function gets the value of the VarParam
identified by identifier.
The irSetVarParam function sets the value of the VarParam
identified by identifier. Application software use of this
function is not supported.
The irPrintVarParam function prints the value of the Var-
Param identified by identifier.
The identifier argument is always first in the argument list
for each of these functions. The remainder of the argument
list to these functions varies according to value of the
identifier field.
The IrVARPARAMS(4IRAPI) manual page should be consulted for
the exact argument list expected by each of these functions
for the VarParams enumerated in irVarParams.h.
Other VarParams may be available via add-on packages.
RETURN VALUE
All functions return IRR_FAIL if an error occurs. All func-
tions return IRR_OK on success, with one exception below.
irGetVarParam can be used to determined the number of bytes
required to store a buffer type VarParam. This done by cal-
ling irGetVarParam with a NULL pointer as the buffer to fill
in, all other arguments are still required. The return
value in this case will be the number of bytes for the
buffer VarParam.
ERROR
irError is set as follows if an error occurs:
IRER_INVALID if the identifier is not valid, or if a NULL
pointer is encountered when one was not allowed.
IRER_OBSOLETE if the identifier is obsolete.
EVENTS
No events are generated by a call to irGetVarParam, irSet-
VarParam, or irPrintVarParam.
FILES
irVarParams.h, shmemtab.h, /vs/data/irSPI.libs,
/usr/lib/libirVP.so
NOTE
irGetVarParam, irSetVarParam and irPrintVarParam functions
are not supported for IRAPI parameters enumerated in
irParams.h. Instead, the irGetParam and irSetParam func-
tions should be used.
The shared memory structures, structure formats, and shared
memory keys declared in "shmemtab.h" will not be supported
by Cornerstone in future releases. Access to these data
elements should be done strictly through the irGetVarParam
function.
WARNING
The irSetVarParam function is not supported for application
use. Use of this function will result in undefined
behaviour.
SEE ALSO
IrVARPARAMS(4IRAPI), irSPIRegister(3IRAPI)
VERSION
This is version 11/25/02 of this man page.