aom_prop.h

Go to the documentation of this file.

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

/*  */

#ifndef AOM_PROP_H_INCLUDED
#define AOM_PROP_H_INCLUDED

#include <unidefs.h>
#include <property/propdesc.h>
#include <property/prop_msg.h>

#include <tccore/libtccore_exports.h>

#ifdef __cplusplus
extern "C"
{
#endif

extern TCCORE_API int AOM_ask_prop_names(
    tag_t               object_tag,     
    int*                prop_count,     
    char***             prop_names      
    );

extern TCCORE_API int AOM_ask_sorted_prop_names(
    tag_t               object_tag,     
    int*                prop_count,     
    char***             prop_names      
    );
extern TCCORE_API int AOM_set_value_string(
    tag_t               object_tag,     
    const char*         prop_name,      
    const char*         value           
    );

extern TCCORE_API int AOM_set_value_strings(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 num,            
    char**              values          
    );

extern TCCORE_API int AOM_set_value_string_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    const char*          value          
    );

extern TCCORE_API int AOM_set_value_date(
    tag_t               object_tag,     
    const char*         prop_name,      
    date_t              value           
    );

extern TCCORE_API int AOM_set_value_dates(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 num,            
    const date_t*       values          
    );

extern TCCORE_API int AOM_set_value_date_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    date_t              value           
    );

extern TCCORE_API int AOM_set_value_double(
    tag_t               object_tag,     
    const char*         prop_name,      
    double              value           
    );

extern TCCORE_API int AOM_set_value_doubles(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 num,            
    const double*       values          
    );


extern TCCORE_API int AOM_set_value_double_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    double              value           
    );

extern TCCORE_API int AOM_set_value_int(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 value           
    );

extern TCCORE_API int AOM_set_value_ints(
    tag_t               object_tag,            
    const char*         prop_name,             
    int                 num,                   
    const int*          values                 
    );

extern TCCORE_API int AOM_set_value_int_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    int                 value           
    );

extern TCCORE_API int AOM_set_value_logical(
    tag_t               object_tag,     
    const char*         prop_name,      
    logical             value           
    );

extern TCCORE_API int AOM_set_value_logicals(
    tag_t               object_tag,            
    const char*         prop_name,             
    int                 num,                   
    const logical*      values                 
    );

extern TCCORE_API int AOM_set_value_logical_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    logical             value           
    );

extern TCCORE_API int AOM_set_value_tag(
    tag_t               object_tag,     
    const char*         prop_name,      
    tag_t               value           
    );

extern TCCORE_API int AOM_set_value_tags(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 num,            
    const tag_t*        values          
    );

extern TCCORE_API int AOM_set_value_tag_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    tag_t               value           
    );

extern TCCORE_API int AOM_set_value_char(
    tag_t               object_tag,     
    const char*         prop_name,      
    char                value           
    );

extern TCCORE_API int AOM_set_value_chars(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 num,            
    const char*         values          
    );

extern TCCORE_API int AOM_set_value_char_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    char                value           
    );

extern TCCORE_API int AOM_ask_value_string(
    tag_t               object_tag,     
    const char*         prop_name,      
    char**              value           
    );

extern TCCORE_API int AOM_ask_value_strings(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num,            
    char***             values          
    );

extern TCCORE_API int AOM_ask_value_string_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    char**              value           
    );

extern TCCORE_API int AOM_ask_value_date(
    tag_t               object_tag,     
    const char*         prop_name,      
    date_t*             value           
    );

extern TCCORE_API int AOM_ask_value_dates(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num,            
    date_t**            values          
    );

extern TCCORE_API int AOM_ask_value_date_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    date_t*             value           
    );

extern TCCORE_API int AOM_ask_value_double(
    tag_t               object_tag,     
    const char*         prop_name,      
    double*             value           
    );

extern TCCORE_API int AOM_ask_value_doubles(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num,            
    double**            values          
    );

extern TCCORE_API int AOM_ask_value_double_at(
    tag_t               object_tag,            
    const char*         prop_name,             
    int                 position,              
    double*             value                  
    );

extern TCCORE_API int AOM_ask_value_int(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                value           
    );

extern TCCORE_API int AOM_ask_value_ints(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num,            
    int**               values          
    );

extern TCCORE_API int AOM_ask_value_int_at(
    tag_t               object_tag,            
    const char*         prop_name,             
    int                 position,              
    int*                value                  
    );

extern TCCORE_API int AOM_ask_value_logical(
    tag_t               object_tag,     
    const char*         prop_name,      
    logical*            value           
    );

extern TCCORE_API int AOM_ask_value_logicals(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num,            
    logical**           values          
    );

extern TCCORE_API int AOM_ask_value_logical_at(
    tag_t               object_tag,            
    const char*         prop_name,             
    int                 position,              
    logical*            value                  
    );

extern TCCORE_API int AOM_ask_value_tag(
    tag_t               object_tag,     
    const char*         prop_name,      
    tag_t*              value           
    );

extern TCCORE_API int AOM_ask_value_tags(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num,            
    tag_t**             values          
    );

extern TCCORE_API int AOM_ask_value_tag_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    tag_t*              value           
    );

extern TCCORE_API int AOM_ask_value_char(
    tag_t               object_tag,     
    const char*         prop_name,      
    char*               value           
    );

extern TCCORE_API int AOM_ask_value_chars(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num,            
    char**              values          
    );

extern TCCORE_API int AOM_ask_value_char_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    char*               value           
    );

extern TCCORE_API int AOM_ask_num_elements(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num_elem        
    );

extern TCCORE_API int AOM_is_modifiable(
    tag_t               object_tag,     
    const char*         prop_name,      
    logical*            mod_flag        
    );

extern TCCORE_API int AOM_ask_lov(
    tag_t               object_tag,     
    const char*         prop_name,      
    tag_t*              lov_tag         
    );

extern TCCORE_API int AOM_ask_property_type(
    tag_t               object_tag,     
    const char*         prop_name,      
    PROP_type_t*        proptype,       
    char**              proptype_n      
    );

extern TCCORE_API int AOM_ask_value_type(
    tag_t               object_tag,     
    const char*         prop_name,      
    PROP_value_type_t*  valtype,        
    char**              valtype_n       
    );

extern TCCORE_API int AOM_ask_max_num_elements(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                maxnumelem      
    );

extern TCCORE_API int AOM_ask_max_string_length(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                maxstrlen       
    );

extern TCCORE_API int AOM_UIF_is_displayable(
    tag_t               object_tag,     
    const char*         prop_name,      
    logical*            is_display      
    );

    extern TCCORE_API int AOM_UIF_is_required(
        tag_t               object_tag,     
        const char*         prop_name,      
        logical*            is_required     
        );


extern TCCORE_API int AOM_UIF_is_enabled(
    tag_t               object_tag,     
    const char*         prop_name,      
    logical*            is_enabled      
    );

extern TCCORE_API int AOM_UIF_ask_name(
    tag_t               object_tag,     
    const char*         prop_name,      
    char**              disp_name       
    );

extern TCCORE_API int AOM_UIF_ask_value(
    tag_t               object_tag,     
    const char*         prop_name,      
    char**              d_value         
    );

extern TCCORE_API int AOM_UIF_set_value(
    tag_t               object_tag,     
    const char*         prop_name,      
    const char*         value           
    );

extern TCCORE_API int AOM_ask_descriptor(
    tag_t               object_tag,     
    const char*         prop_name,      
    tag_t*              descriptor      
    );

extern TCCORE_API int AOM_UIF_validate_display_value(
    tag_t               object_tag,     
    const char*         prop_name,      
    const char*         val,            
    logical*            flag            
    );

extern TCCORE_API int AOM_ask_relations(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num,            
    tag_t**             relation_tags   
    );

extern TCCORE_API int AOM_tag_to_string(
    tag_t               the_tag,    
    char**              the_string  
    );

extern TCCORE_API int AOM_string_to_tag(
    const char*         the_string,     
    tag_t*              the_tag         
    );

extern TCCORE_API int AOM_assign_string(
    tag_t               object_tag,     
    const char*         prop_name,      
    const char*         value           
    );

extern TCCORE_API int AOM_assign_string_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    const char*         value           
    );

extern TCCORE_API int AOM_assign_strings(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 num,            
    char**              values          
    );

extern TCCORE_API int AOM_assign_date(
    tag_t               object_tag,     
    const char*         prop_name,      
    date_t              value           
    );

extern TCCORE_API int AOM_assign_date_at(
    tag_t               object_tag,            
    const char*         prop_name,             
    int                 position,              
    date_t              value                  
    );

extern TCCORE_API int AOM_assign_dates(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 num,            
    const date_t*       values          
    );

extern TCCORE_API int AOM_assign_double(
    tag_t               object_tag,     
    const char*         prop_name,      
    double              value           
    );

extern TCCORE_API int AOM_assign_double_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    double              value           
    );

extern TCCORE_API int AOM_assign_doubles(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 num,            
    const double*       values          
    );

extern TCCORE_API int AOM_assign_int(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 value           
    );

extern TCCORE_API int AOM_assign_int_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    int                 value           
    );

extern TCCORE_API int AOM_assign_ints(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 num,            
    const int*          values          
    );

extern TCCORE_API int AOM_assign_logical(
    tag_t               object_tag,     
    const char*         prop_name,      
    logical             value           
    );

extern TCCORE_API int AOM_assign_logical_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    logical             value           
    );

extern TCCORE_API int AOM_assign_logicals(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 num,            
    const logical*      values          
    );

extern TCCORE_API int AOM_assign_tag(
    tag_t               object_tag,     
    const char*         prop_name,      
    tag_t               value           
    );

extern TCCORE_API int AOM_assign_tag_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    tag_t               value           
    );

extern TCCORE_API int AOM_assign_tags(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 num,            
    const tag_t*        values          
    );

extern TCCORE_API int AOM_assign_char(
    tag_t               object_tag,     
    const char*         prop_name,      
    char                value           
    );

extern TCCORE_API int AOM_assign_char_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    char                value           
    );

extern TCCORE_API int AOM_assign_chars(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 num,            
    const char*         values          
    );

extern TCCORE_API int AOM_get_value_string(
    tag_t               object_tag,     
    const char*         prop_name,      
    char**              value           
    );

extern TCCORE_API int AOM_get_value_strings(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num,            
    char***             values          
    );

extern TCCORE_API int AOM_get_value_string_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    char**              value           
    );

extern TCCORE_API int AOM_get_value_date(
    tag_t               object_tag,     
    const char*         prop_name,      
    date_t*             value           
    );

extern TCCORE_API int AOM_get_value_dates(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num,            
    date_t**            values          
    );

extern TCCORE_API int AOM_get_value_date_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    date_t*             value           
    );

extern TCCORE_API int AOM_get_value_double(
    tag_t               object_tag,     
    const char*         prop_name,      
    double*             value           
    );

extern TCCORE_API int AOM_get_value_doubles(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num,            
    double**            values          
    );

extern TCCORE_API int AOM_get_value_double_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    double*             value           
    );

extern TCCORE_API int AOM_get_value_int(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                value           
    );

extern TCCORE_API int AOM_get_value_ints(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num,            
    int**               values          
    );

extern TCCORE_API int AOM_get_value_int_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    int*                value           
    );

extern TCCORE_API int AOM_get_value_logical(
    tag_t               object_tag,     
    const char*         prop_name,      
    logical*            value           
    );

extern TCCORE_API int AOM_get_value_logicals(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num,            
    logical**           values          
    );

extern TCCORE_API int AOM_get_value_logical_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    logical*            value           
    );

extern TCCORE_API int AOM_get_value_tag(
    tag_t               object_tag,     
    const char*         prop_name,      
    tag_t*              value           
    );

extern TCCORE_API int AOM_get_value_tags(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num,            
    tag_t**             values          
    );

extern TCCORE_API int AOM_get_value_tag_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    tag_t*              value           
    );

extern TCCORE_API int AOM_get_value_char(
    tag_t               object_tag,     
    const char*         prop_name,      
    char*               value           
    );

extern TCCORE_API int AOM_get_value_chars(
    tag_t               object_tag,     
    const char*         prop_name,      
    int*                num,            
    char**              values          
    );

extern TCCORE_API int AOM_get_value_char_at(
    tag_t               object_tag,     
    const char*         prop_name,      
    int                 position,       
    char*               value           
    );

extern TCCORE_API int AOM_is_null_empty(
    tag_t                   object_tag,         
    const char *            prop_name,          
    logical                 check_zero_length,  
    logical*                is_null_empty       
    );


extern TCCORE_API int AOM_UIF_set_localized_value_string(
    tag_t           object_tag,           
    const char*     prop_name,            
    const char *    locale,               
    const char*     value,                
    char            localization_status,  
    logical         master                
    );

extern TCCORE_API int AOM_UIF_set_localized_value_strings(
    tag_t        object_tag,        
    const char*  prop_name,         
    const char * locale,            
    int          num,               
    const char** values,            
    char*        localization_statuses, 
    logical      master                 
    );

extern TCCORE_API int AOM_UIF_set_localized_value_string_at(
    tag_t        object_tag,         
    const char*  prop_name,          
    const char*  locale,             
    int          position,           
    const char*  value,              
    char         localization_status,
    logical      master              
    );

extern TCCORE_API int AOM_UIF_ask_localized_value_string(
    tag_t        object_tag,         
    const char*  prop_name,          
    const char*  locale,             
    char**       value,              
    char*        localization_status,
    logical*     master              
    );

extern TCCORE_API int AOM_UIF_ask_localized_value_strings(
    tag_t       object_tag,             
    const char* prop_name,              
    const char* locale,                 
    int*        num,                    
    char***     values,                 
    char**      localization_statuses,  
    logical*    master                  
    );

extern TCCORE_API int AOM_UIF_ask_localized_value_string_at(
    tag_t       object_tag,         
    const char* prop_name,          
    const char* locale,             
    int         position,           
    char**      value,              
    char*       localization_status,
    logical*    master              
    );

typedef struct LOC_values_s
{
    int num_prop_values;
    char ** prop_values;
    logical master;
    char* localization_status_values;
} PROP_values_t;

extern TCCORE_API  int  AOM_UIF_ask_multiple_localized_value_strings(
    int               n_objects,  
    tag_t *           object_tags,
    int               n_props,    
    const char**      prop_names, 
    int               n_locales,  
    const char**      locales,    
    PROP_values_t**** prop_values 
    );

extern TCCORE_API  int  AOM_UIF_set_multiple_localized_value_strings(
    int              n_objects,   
    tag_t *          object_tags, 
    int              n_props,     
    const char **    prop_names,  
    int              n_locales,   
    const char **    locales,     
    PROP_values_t*** prop_values  
    );

extern TCCORE_API  int  AOM_UIF_ask_translations(
    tag_t       object_tag,                   
    const char* prop_name,                    
    const int   seq_num,                      
    int  *      num_translations,             
    char ***    translationLocales,           
    char ***    translationValues,            
    char ***    translationStatusNames,       
    char ***    translationStatusDescriptions 
    );

extern TCCORE_API  int  AOM_UIF_set_translations(
    tag_t        object_tag,             
    const char * prop_name,              
    const int    seq_num,                
    int          num_translations,       
    char **      translationLocales,     
    char **      translationValues,      
    char **      translationStatusCodes  
    );

extern TCCORE_API int AOM_UIF_ask_values(
    tag_t       object_tag,  
    const char* prop_name,   
    int*        num_values,  
    char***     values       
    );

extern TCCORE_API int AOM_ask_displayable_values(
    tag_t              object_tag,    
    const char*        prop_name,     
    int*               num_values,    
    char***            values         
    );

extern TCCORE_API int AOM_UIF_delete_localized_value_string(
    tag_t           object_tag,     
    const char*     prop_name,      
    int             index,          
    const char*     locale          
    );


extern TCCORE_API int AOM_UIF_clear_translations(
    tag_t           object_tag,     
    const char *    prop_name       
    );

extern TCCORE_API int AOM_ask_property_master_locale(
    tag_t           object_tag,      
    const char *    prop_name,       
    char**          master_locale    
    );

extern TCCORE_API int AOM_sort_tags_by_properties ( 
    int                n_unsorted_tags,         
    const tag_t        *unsorted_tags,          
    int                n_props,                 
    const tag_t        *pd_tags,                
    const int          *sort_orders,            
    int                *n_sorted_tags,          
    tag_t              **sorted_tags            
    );

extern TCCORE_API int AOM_alphanumeric_sort_tags_by_properties ( 
    int                n_unsorted_tags,         
    const tag_t        *unsorted_tags,          
    int                n_props,                 
    const tag_t        *pd_tags,                
    const int          *sort_orders,            
    int                *n_sorted_tags,          
    tag_t              **sorted_tags            
    );

extern TCCORE_API int AOM_UIF_set_property_master_locale(
    tag_t           object_tag,         
    const char *    prop_name,          
    char*           new_master_locale   
    );

#ifdef __cplusplus
}
#endif

#include <tccore/libtccore_undef.h>

#endif