constants.h

Go to the documentation of this file.

// @<COPYRIGHT_START>@
// ===============================================
// Copyright 2007 UGS Corp. All Rights Reserved.
// ===============================================
// @<COPYRIGHT_END>@


#ifndef CONSTANTS_H
#define CONSTANTS_H

#include <tc/tc_startup.h>
#include <constants/libconstants_exports.h>

typedef enum CONSTANTSDataType_e
{
    StringDataType=0,
    ListDataType=1,
    BooleanDataType=2
} CONSTANTSDataType_t;

#define PROPERTY_CONST_REQUIRED         "Required"
#define PROPERTY_CONST_VISIBLE          "Visible"
#define PROPERTY_CONST_ENABLED          "Enabled"
#define PROPERTY_CONST_INITIALVALUE     "InitialValue"
#define PROPERTY_CONST_COMPLEXPROPERTY  "ComplexProperty"
#define PROPERTY_CONST_MODIFIABLE       "Modifiable"
#define PROPERTY_CONST_COPYFROMORIGINAL "CopyFromOriginal"
#define PROPERTY_CONST_TRIM_ZEROS       "Fnd0TrimZeroes"

#ifdef __cplusplus
    extern "C"{
#endif

extern CONSTANTS_API int CONSTANTS_is_global_constant_multivalued(
           const char*              constant_name,     
           logical*                 is_multi_valued    
       );

extern CONSTANTS_API int CONSTANTS_get_global_constant_value(
           const char*              constant_name,     
           char **                  value              
       );

extern CONSTANTS_API int CONSTANTS_get_global_constant_values(
           const char*              constant_name,     
           int*                     n_values,          
           char***                  values             
       );

extern CONSTANTS_API int CONSTANTS_get_type_constant_value(
       const char*                   constant_name,      
       const char*                   type_name,          
       char**                        value               
       );


extern CONSTANTS_API int CONSTANTS_get_property_constant_value(
       const char*                   constant_name,      
       const char*                   type_name,          
       const char*                   property_name,      
       char**                        value               
       );

extern CONSTANTS_API int CONSTANTS_find_type_by_type_constant_value(
       const char*                   type_constant_name,      
       const char*                   attached_value,          
       char**                        target_type_name         
       );

#ifdef __cplusplus
}
#endif

#include <constants/libconstants_undef.h>
#endif /* CONSTANTS_H */