%-*-mode:latex-*-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Copyright (C) 1996-2004 Jason Evans <jasone@canonware.com>.
% All rights reserved.
% 
% Redistribution and use in source and binary forms, with or without
% modification, are permitted provided that the following conditions
% are met:
% 1. Redistributions of source code must retain the above copyright
%    notice(s), this list of conditions and the following disclaimer
%    unmodified other than the allowable addition of one or more
%    copyright notices.
% 2. Redistributions in binary form must reproduce the above copyright
%    notice(s), this list of conditions and the following disclaimer in
%    the documentation and/or other materials provided with the
%    distribution.
% 
% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
% EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
% PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
% BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
% WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
% OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
% EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Version: Onyx 5.1.1
%
% nxn portion of Onyx Manual.
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\subsection{nxn}
\label{nxn}
\index{nxn@\classname{nxn}{}}

The \classname{nxn} class provides access to a table of string constants.  The
main reason for this class's existence is that often, multiple C files use
identical string constants, and this saves memory by allowing all to refer to a
single string.

\subsubsection{API}
\begin{capi}
\label{nxn_str}
\index{nxn_str@\cfunc{nxn\_str}{}}
\citem{\cfunc[const char *]{nxn\_str}{cw\_nxn\_t a\_nxn}}
	\begin{capilist}
	\item[Input(s): ]
		\begin{description}\item[]
		\item[a\_nxn: ]
			A number that corresponds to an entry in the string
			table.
		\end{description}
	\item[Output(s): ]
		\begin{description}\item[]
		\item[retval: ]
			Pointer to a string constant.
		\end{description}
	\item[Exception(s): ] None.
	\item[Description: ]
		Return a pointer to the string constant associated with
		\cvar{a\_nxn}.
	\end{capilist}
\label{nxn_len}
\index{nxn_len@\cfunc{nxn\_len}{}}
\citem{\cfunc[uint32\_t]{nxn\_len}{cw\_nxn\_t a\_nxn}}
	\begin{capilist}
	\item[Input(s): ]
		\begin{description}\item[]
		\item[a\_nxn: ]
			A number that corresponds to an entry in the string
			table.
		\end{description}
	\item[Output(s): ]
		\begin{description}\item[]
		\item[retval: ]
			String length of a string constant.
		\end{description}
	\item[Exception(s): ] None.
	\item[Description: ]
		Return the string length of the string constant associated with
		\cvar{a\_nxn}.
	\end{capilist}
\end{capi}
