preferences.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef PREFERENCES_H
#define PREFERENCES_H

#include <unidefs.h>
#include <tc/libtc_exports.h>

typedef enum TC_preference_search_scope_e{
    TC_preference_all,                   
    TC_preference_user,                  
    TC_preference_role,                  
    TC_preference_group,                 
    TC_preference_site,                  
    TC_preference_system,                
    TC_preference_cots_location,         
    TC_preference_overlay_location,      
    TC_preference_env_variable_location  
} TC_preference_search_scope_t;

typedef enum PREF_import_actions_e
{
    PREF_import_action_skip,         
    PREF_import_action_override,     
    PREF_import_action_merge         
} PREF_import_actions_t;

typedef enum PREF_preference_type_e {
    PREF_preference_string,          
    PREF_preference_logical,         
    PREF_preference_integer,         
    PREF_preference_double,          
    PREF_preference_date             
} PREF_preference_type_t;

typedef struct {
    char*                          preferenceName;        
    char*                          preferenceCategory;    
    char*                          preferenceDescription; 
    TC_preference_search_scope_t   preferenceScope;       
    PREF_preference_type_t         preferenceType;        
    logical                        isArray;               
    logical                        isDisabled;            
} PREF_preference_definition_t, *PREF_preference_definition_p_t;

typedef struct {
    char*  contextName;
    int    numberOfValues;
    char** values;
} PREF_preference_context_values_t, *PREF_preference_context_values_p_t;

typedef struct {
    PREF_preference_definition_t      preferenceDefinition;
    int                               numberOfContexts;
    PREF_preference_context_values_t* contextValues;
} PREF_preference_object_t, *PREF_preference_object_p_t;

#ifdef __cplusplus
extern "C"{
#endif
    
    extern TC_API int PREF_initialize(void);
    
    extern TC_API int PREF_reinitialize();
    extern TC_API int PREF_ask_protection_scope(
        const char*                         preference_name,        
        TC_preference_search_scope_t*       protection_scope        
        );

    extern TC_API int PREF_ask_protection_scopes(
        int                                 preference_count,       
        const char**                        preference_names,       
        TC_preference_search_scope_t**      protection_scopes        
        );

    extern TC_API int PREF_set_protection_scope(
        const char*                         preference_name,        
        TC_preference_search_scope_t        protection_scope         
        );

    extern TC_API int PREF_set_protection_scopes(
        int                                   preference_count,     
        const char**                          preference_names,     
        TC_preference_search_scope_t          protection_scopes[]   
        );
    extern TC_API int PREF_ask_environment_set_flag(
        const char*                         preference_name,        
        logical*                            flag                    
        );

    extern TC_API int PREF_ask_environment_set_flags(
        int                                 preference_count,       
        const char**                        preference_names,       
        logical**                           flags                   
        );

    extern TC_API int PREF_set_environment_set_flag(
        const char*                         preference_name,        
        logical                             flag                    
        );

    extern TC_API int PREF_set_environment_set_flags(
        int                                 preference_count,       
        const char**                        preference_names,       
        const logical                       flag[]                  
        );


    extern TC_API int PREF_ask_value_count(
        const char*     preference_name,    
        int*            value_count         
        );

    extern TC_API int PREF_ask_value_count_at_location(
        const char*                         preference_name,        
        TC_preference_search_scope_t        location,               
        int*                                value_count             
        );

    extern TC_API int PREF_ask_char_value(
        const char*     preference_name,    
        int             index,              
        char**          value               
        );

    extern TC_API int PREF_ask_char_values(
        const char*     preference_name,    
        int*            count,              
        char***         value               
        );

    extern TC_API int PREF_set_char_values(
        const char*     preference_name,    
        int             value_count,        
        char*           values[]            
        );

    extern TC_API int PREF_ask_char_value_at_location(
        const char*                         preference_name,        
        TC_preference_search_scope_t        location,               
        int                                 index,                  
        char**                              value                   
        );

    extern TC_API int PREF_ask_char_values_at_location(
        const char*                         preference_name,        
        TC_preference_search_scope_t        location,               
        int*                                count,                  
        char***                             values                  
        );


    extern TC_API int PREF_set_char_values_at_location(
        const char*                         preference_name,        
        TC_preference_search_scope_t        location,               
        int                                 value_count,            
        char*                               values[]                
        );
    extern TC_API int PREF_ask_int_value(
        const char*     preference_name,    
        int             index,              
        int*            value               
        );

    extern TC_API int PREF_ask_int_values(
        const char*     preference_name,    
        int*            value_count,        
        int**           values              
        );

    extern TC_API int PREF_set_int_values(
        const char*     preference_name,    
        int             value_count,        
        int             values[]            
        );

    extern TC_API int PREF_ask_int_value_at_location(
        const char*                         preference_name,        
        TC_preference_search_scope_t        location,               
        int                                 index,                  
        int*                                value                   
        );

    extern TC_API int PREF_ask_int_values_at_location(
        const char*                         preference_name,        
        TC_preference_search_scope_t        location,               
        int*                                value_count,            
        int**                               values                  
        );

    extern TC_API int PREF_set_int_values_at_location(
        const char*                         preference_name,        
        TC_preference_search_scope_t        location,               
        int                                 value_count,            
        int                                 values[]                
        );
    extern TC_API int PREF_ask_double_value(
        const char*     preference_name,    
        int             index,              
        double*         value               
        );

    extern TC_API int PREF_ask_double_values(
        const char*     preference_name,    
        int*            value_count,        
        double**        values              
        );


    extern TC_API int PREF_set_double_values(
        const char*     preference_name,    
        int             value_count,        
        double          values[]            
        );

    extern TC_API int PREF_ask_double_value_at_location(
        const char*                         preference_name,        
        TC_preference_search_scope_t        location,               
        int                                 index,                  
        double*                             value                   
        );

    extern TC_API int PREF_ask_double_values_at_location(
        const char*                         preference_name,        
        TC_preference_search_scope_t        location,               
        int*                                value_count,            
        double**                            values                  
        );

    extern TC_API int PREF_set_double_values_at_location(
        const char*                         preference_name,        
        TC_preference_search_scope_t        location,               
        int                                 value_count,            
        double                              values[]                
        );
    extern TC_API int PREF_ask_logical_value(
        const char*     preference_name,    
        int             index,              
        logical*        value               
        );

    extern TC_API int PREF_ask_logical_values(
        const char*     preference_name,    
        int*            value_count,        
        logical**       values              
        );

    extern TC_API int PREF_set_logical_value(
        const char*                         preference_name,        
        logical                             value                   
        );

    extern TC_API int PREF_set_logical_values(
        const char*                          preference_name,        
        int                                  value_count,            
        logical                              values[]                
        );

    extern TC_API int PREF_ask_logical_value_at_location(
        const char*                         preference_name,        
        TC_preference_search_scope_t        location,               
        int                                 index,                  
        logical*                            value                   
        );

    extern TC_API int PREF_ask_logical_values_at_location(
        const char*                         preference_name,        
        TC_preference_search_scope_t        location,               
        int*                                value_count,            
        logical**                           values                  
        );

    extern TC_API int PREF_set_logical_values_at_location(
        const char*                         preference_name,        
        TC_preference_search_scope_t        location,               
        int                                 value_count,            
        logical                             values[]                
        );
    extern TC_API int PREF_set_definition(
        const char* preference_name,                          
        PREF_preference_object_t preference_object,           
        logical env_variable_enabled                            
        );


    extern TC_API int PREF_delete_definition(
        int nb_of_preferences,                  
        const char** preference_names,          
        logical delete_all_custom_definitions   
        );
    extern TC_API int PREF_export_preference_list(
        int                             preference_count,   
        char**                          preference_names,   
        TC_preference_search_scope_t    location,           
        const char*                     output_file_name    
        );

    extern TC_API int PREF_export_preferences(
        TC_preference_search_scope_t    location,           
        const char*                     output_file_name    
        );


    extern TC_API int PREF_export_preferences_with_category(
        TC_preference_search_scope_t location,             
        int                          number_of_categories, 
        char**                       categories,           
        const char*                  output_file_name      
        );

    extern TC_API int PREF_import_preferences(
        TC_preference_search_scope_t    location,     
        const char*                     input_xml,    
        PREF_import_actions_t           action        
        );

    extern TC_API int PREF_import_preferences_with_category(
        TC_preference_search_scope_t location,   
        const char*                  input_xml,  
        int                          number_of_categories, 
        char**                       category_names,       
        PREF_import_actions_t        action      
        );
    extern TC_API int PREF_delete_preference(
        const char*                     preference_name      
        );


    extern TC_API int PREF_delete_preference_at_location(
        const char*                     preference_name,     
        TC_preference_search_scope_t    location             
        );


    extern TC_API int PREF_delete_non_session_preference(
        char* preference_name,        
        tag_t object                  
        );
    extern TC_API int PREF_refresh(
        const char*     preference_name     
        );

    extern TC_API int PREF_lock_site_preferences( );

    extern TC_API int PREF_unlock_site_preferences( );
    extern TC_API int PREF_set_search_scope(
        TC_preference_search_scope_t  scope   
        );
    
    extern TC_API int PREF_ask_search_scope(
        TC_preference_search_scope_t* scope   
        );
#ifdef __cplusplus
}
#endif


#include <tc/libtc_undef.h>
#endif