\input manualMacros.tex
\manBegin
\manPageInfo{RCI Reference Manual}{}{}
\manTitle{setpar}{3}
\manSection{NAME}
{\rightskip=0ptplus1fil
{\tt \manName{setparInteger}},
{\tt \manName{setparFloat}},
{\tt \manName{setparIdentifier}},
{\tt \manName{setparString}}
-- routines to set values in an RCI parameter set.
}
\manSection{USAGE}
\cverbatim
setparInteger (ival, key, handle)
  int ival;
  const char *key;
  int handle;

setparFloat (fval, key, handle)
  float fval;
  const char *key;
  int handle;

setparString (sval, key, handle)
  char *sval;
  const char *key;
  int handle;

setparIdentifier (sval, key, handle)
  char *sval;
  const char *key;
  int handle; @endcverbatim
\manSection{ARGUMENTS}
\manItem{{\tt key} --}
Key name associated with the parameter.
\manItem{{\tt handle} --}
Parameter set handle returned by {\tt rciParameters()};
the parameter set must be opened with the {\it write} option set.
\manItem{{\tt ival} --}
Integer value.
\manItem{{\tt fval} --}
Floating point value.
\manItem{{\tt sval} --}
Pointer to string value.
\manSection{RESTRICTIONS}
These routines must be called from the planning level.
\manSection{DESCRIPTION}
These routines are used to set parameters associated with an
RCI parameter set (see {\tt rciParameters(3)}).

In general, the routines place a parameter of the indicated type
into the parameter set under the name specified by {\tt key}.
If this replaces a previous parameter, then the routine 
returns 1; otherwise, the routine returns 0.

{\tt setparInteger()} places an integer into the parameter set.

{\tt setparFloat()} places a floating point value
into the parameter set.

{\tt setparIndentifier()} places an indentifier into the parameter
set (an identifier is an alphanumeric string, including underscores
and dollar signs, that 
does not begin with a digit).

{\tt setparString()} places a string into the parameter set.
\manSection{DIAGNOSTICS}
The {\it setpar} routines return {\tt 0} (and take no action) if the parameter
set was not opened for writing.
The routines return {\tt -1} if the system runs out of memory, and
{\tt setparIdentifier()} returns {\tt -1} if its argument is not an
identifier.

These routines will abort the program if called from the control level.
\manSection{SEE ALSO}
\raggedright
{\tt rciParameters(3)}, {\tt getpar(3)}.
\manEnd
\end
