\input manualMacros.tex
\manBegin
\manPageInfo{RCI Reference Manual}{}{}
\manTitle{getSharedMemory}{3}
\manSection{NAME}
{\rightskip=0ptplus1fil
{\tt \manName{getSharedMemory}}, {\tt \manName{getGlobalMemory}},
{\tt \manName{getLocalMemory}}, {\tt \manName{findSharedMemory}}, 
{\tt \manName{findGlobalMemory}}
-- get pointers to shared and local memory sections of RCI tasks.

}
\manSection{USAGE}
\cverbatim
#include <rci.h>

void *getSharedMemory (label)
   const char *label;

void *getGlobalMemory (label)
   const char *label;

void *getLocalMemory (label)
   const char *label;

void *findSharedMemory (p)
   void *p;

void *findGlobalMemory (p)
   void *p;@endcverbatim
\manSection{ARGUMENTS}
\manItem{{\tt label} --}
Name of the shared memory section.
\manItem{{\tt p} --}
Planning level pointer.
\manSection{DESCRIPTION}
{\tt getSharedMemory()} is used by a control task to obtain a pointer
to the shared section {\tt label} set up by the planning task
using {\tt rciSharedMemory()}.

{\tt getGlobalMemory()} is used by a control task to obtain a pointer
to the global section {\tt label} set up by the planning task
using {\tt rciGlobalMemory()}.

{\tt getLocalMemory()} is used by a control task to obtain a pointer
to a private memory area {\tt label} that was set up by the planning task
using {\tt rciLocalMemory()}.

{\tt findSharedMemory()} is like {\tt getSharedMemory()}, only
it used the planning task's pointer to the memory as a search key.

{\tt findGlobalMemory()} is like {\tt getGlobalMemory()}, only
it used the planning task's pointer to the memory as a search key.

Control tasks which obtain these pointers once can store them for later
use in the {\tt sharedMem}, {\tt globalMem}, and {\tt privateMem} fields of
the task control block (described in {\tt RCI_TCB(3)}).

\manSection{DIAGNOSTICS}
The functions return {\tt NULL} if the section does not exist or if the
task making the request was not given access to the section when it was
created.
\manSection{SEE ALSO}
\raggedright
{\tt rciSharedMemory(3)}, {\tt RCI_TCB(3)}.
\manEnd
\end
