% -*- latex -*-


\setDate{August 23, 2010}
% The following must all be on one line for latex2man to work.
\begin{Name}{3}{icetGetStrategyName}{Kenneth Moreland}{\IceT Reference}{\CFunc{icetGetStrategyName} -- retrieve strategy name.}

  \mansection{Synopsis}

  \textC{\#include <IceT.h>}

  \begin{Table}{3}
    \textC{const char *}\CFunc{icetGetStrategyName}\textC{(}&\textC{void}&\textC{);}
  \end{Table}

  
  \mansection{Description}

  \CFunc{icetGetStrategyName} retrieves a human-readable name for the
  current strategy.


  \mansection{Return Value}

  Returns a short, null terminated string identifying the strategy
  currently in effect.  Helpful for printing out debugging or diagnostic
  statements.  If no strategy is set, \textC{NULL} is returned.


  \mansection{Errors}

  \begin{Description}[ICET\_INVALID\_OPERATION]
  \item[\CErrorEnum{ICET\_INVALID\_ENUM}]
    A strategy was never set with \CFunc{icetStrategy}.
  \end{Description}


  \mansection{Warnings}

  None.


  \mansection{Bugs}

  None known.


  \mansection{Notes}

  The string returned does \emph{not} contain the identifier used in a C
  program.  For example, if the current strategy is
  \CEnum{ICET\_STRATEGY\_REDUCE}, \CFunc{icetGetStrategyName} returns
  ``Reduce,'' not ``ICET\_STRATEGY\_REDUCE.''


  \mansection{Copyright}
  Copyright \copyright 2003 Sandia Corporation

  @copyright@

  \mansection{See Also}

  \CFuncSeeAlso{icetGetSingleImageStrategyName},
  \CFuncSeeAlso{icetStrategy}

\end{Name}


% These are emacs settings that go at the end of the file.
% Local Variables:
% writestamp-format: "%B %e, %Y"
% writestamp-prefix: "^\\\\setDate{"
% writestamp-suffix: "}$"
% End:
