\input manualMacros.tex
\manBegin
\manPageInfo{RCI Reference Manual}{}{}
\manTitle{getRciTask}{3}
\manSection{NAME}
{\rightskip=0ptplus1fil
{\tt \manName{getRciTask}},
{\tt \manName{findRciTask}},
{\tt \manName{getCurrentTask}},
{\tt \manName{rciTaskName}}
-- routines for obtaining RCI task descriptors or names.

}
\manSection{USAGE}
\cverbatim
RCI_DESC *getRciTask(name)
  const char *name;

RCI_DESC *findRciTask(id)
  int id;

RCI_DESC *getCurrentTask()

char *rciTaskName(td)
  RCI_DESC *td;
@endcverbatim
\manSection{ARGUMENTS}
\manItem{{\tt name} --}
Name of an RCI task (the same name that was given to {\tt rciCreate()}).
\manItem{{\tt id} --}
ID number of an RCI task (the same number that would be returned by
{\tt TASKNUM(td)}).
\manItem{{\tt td} --}
Pointer to an RCI task, as would be returned by {\tt rciCreate()} or
{\tt getRciTask()}.

\manSection{DESCRIPTION}
These routines give RCI tasks a way of obtaining pointers to task descriptors
for either themselves or some other task. They may be called from
any part of the RCI program.

{\tt getRciTask()} returns a task descriptor {\tt td} for the named task.

{\tt findRciTask()} returns a task descriptor {\tt td} for the RCI task with
the indicated ID number.

{\tt getCurrentTask()} returns the task descriptor for the current RCI task
(which will be the planning task, if called from the planning level).

{\tt rciTaskName()} returns a pointer to the name of the RCI task described by
the descriptor {\tt td}.

\manSection{DIAGNOSTICS}
{\tt getRciTask()} returns {\tt NULL} if it can't find the named task; the
other routines assume that nothing will go wrong.
\manSection{BUGS}
The other routines assume that nothing will go wrong.
\manSection{SEE ALSO}
\raggedright
{\tt rciCreate(3)}, {\tt TASKNUM(3)}.
\manEnd
\end
