icetGetStrategyName -- retrieve strategy name.
Contents
Bugs
None known.
Copyright
Copyright (C)2003 Sandia Corporation
Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains
certain rights in this software.
This source code is released under the New BSD License.
Description
icetGetStrategyName retrieves a human-readable name for the current strategy.
Errors
ICET_INVALID_ENUM
A strategy was never set with icetStrategy.
Name
icetGetStrategyName--retrievestrategyname.
Notes
The string returned does not contain the identifier used in a C program. For example, if the current
strategy is ICET_STRATEGY_REDUCE, icetGetStrategyName returns ``Reduce,'' not ``ICET_STRATEGY_REDUCE.''
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, NULL is returned.
See Also
icetGetSingleImageStrategyName(3), icetStrategy(3) IceT Reference August 23, 2010 icetGetStrategyName(3)
Synopsis
#include <IceT.h>
const char *icetGetStrategyName( void );
Warnings
None.
