ITK Function Reference

(12.1)
Macros | Functions
pom.h File Reference
#include <limits.h>
#include <unidefs.h>
#include <pom/pom/pom_typedefs.h>
#include <pom/enq/old_on_new.h>
#include <pom/pom/libpom_exports.h>
#include <pom/pom/pom_mapping.h>
#include <pom/pom/pom_errors.h>
#include <pom/pom/pom_tokens.h>
#include <pom/pom/pom_macros.h>
#include <pom/pom/libpom_undef.h>

Go to the source code of this file.

Macros

#define NULLCLASS   ((tag_t)0)
 
#define NULLDATE   (POM_null_date())
 
#define NULLTAG   ((tag_t)0)
 
Some maxima
#define POM_MAX_NAME_LENGTH   27
 
#define POM_MAX_ATTR_ARRAY_LENGTH   INT_MAX
 
#define POM_MAX_MAX_STRING_LENGTH   4000
 
#define POM_MAX_INDEXED_STRING_LENGTH   450
 
#define POM_MAX_NOTE_LENGTH   4000
 
#define POM_MAX_ATTRS_IN_CLASS   1000
 
#define POM_MAX_TOTAL_ATTRS_IN_CLASS   1000
 
#define POM_MAX_ATTRS_IN_INDEX   16
 
#define POM_MAX_IN_UNIQUE_SET   16
 
#define POM_MAX_ATTRS_IN_ENQUIRY   50
 
#define POM_MAX_ATTRS_IN_ORDER   127
 
#define POM_MAX_ENQUIRIES   99999
 
#define POM_MAX_INSTANCES   100
 
#define POM_license_level_author   0
 
#define POM_license_level_consumer   1
 
#define POM_license_level_occasional   2
 
#define POM_license_level_viewer   3
 
#define POM_license_level_user   4
 
#define POM_license_level_admin   5
 
#define POM_license_level_max   5
 
Valid input parameters for the #POM_set_user_license_status ITK
#define POM_USER_STATUS_ACTIVE   0
 
#define POM_USER_STATUS_INACTIVE   1
 

Functions

POMAPI int POM_acknowledge_error (int error_code)
 
POMAPI int POM_allocate_tag (tag_t *new_tag)
 
POMAPI int POM_append_attr_chars (int n_instances, const tag_t *instance_tags, tag_t attr_id, int n_values, const char *values)
 
POMAPI int POM_append_attr_dates (int n_instances, const tag_t *instance_tags, tag_t attr_id, int n_values, const date_t *values)
 
POMAPI int POM_append_attr_doubles (int n_instances, const tag_t *instance_tags, tag_t attr_id, int n_values, const double *values)
 
POMAPI int POM_append_attr_ints (int n_instances, const tag_t *instance_tags, tag_t attr_id, int n_values, const int *values)
 
POMAPI int POM_append_attr_logicals (int n_instances, const tag_t *instance_tags, tag_t attr_id, int n_values, const logical *values)
 
POMAPI int POM_append_attr_nulls (int n_instances, const tag_t *instance_tags, tag_t attr_id, int n_values)
 
POMAPI int POM_append_attr_strings (int n_instances, const tag_t *instance_tags, tag_t attr_id, int n_values, char **values)
 
POMAPI int POM_append_attr_tags (int n_instances, const tag_t *instance_tags, tag_t attr_id, int n_values, const tag_t *values)
 
POMAPI int POM_ask_accessor_instances (tag_t accessor, int *n_instances, tag_t **instances)
 
POMAPI int POM_ask_any_unsaved_info (logical *answer)
 
POMAPI int POM_ask_archive_date (tag_t instance, date_t *archive_date)
 
POMAPI int POM_ask_archive_info (tag_t instance, char **archive_info)
 
POMAPI int POM_ask_attr_char (tag_t instance_tag, tag_t attr_id, char *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_chars (tag_t instance_tag, tag_t attr_id, int start, int n_values, char **values, logical **is_it_null, logical **is_it_empty)
 
POMAPI int POM_ask_attr_date (tag_t instance_tag, tag_t attr_id, date_t *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_dates (tag_t instance_tag, tag_t attr_id, int start, int n_values, date_t **values, logical **is_it_null, logical **is_it_empty)
 
POMAPI int POM_ask_attr_double (tag_t instance_tag, tag_t attr_id, double *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_doubles (tag_t instance_tag, tag_t attr_id, int start, int n_values, double **values, logical **is_it_null, logical **is_it_empty)
 
POMAPI int POM_ask_attr_initial_char (tag_t class_id, tag_t attr_id, char *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_initial_date (tag_t class_id, tag_t attr_id, date_t *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_initial_double (tag_t class_id, tag_t attr_id, double *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_initial_int (tag_t class_id, tag_t attr_id, int *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_initial_logical (tag_t class_id, tag_t attr_id, logical *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_initial_string (tag_t class_id, tag_t attr_id, char **value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_initial_utc_date (tag_t class_id, tag_t attr_id, date_t *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_int (tag_t instance_tag, tag_t attr_id, int *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_ints (tag_t instance_tag, tag_t attr_id, int start, int n_values, int **values, logical **is_it_null, logical **is_it_empty)
 
POMAPI int POM_ask_attr_logical (tag_t instance_tag, tag_t attr_id, logical *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_logicals (tag_t instance_tag, tag_t attr_id, int start, int n_values, logical **values, logical **is_it_null, logical **is_it_empty)
 
POMAPI int POM_ask_attr_lower_char (tag_t class_id, tag_t attr_id, char *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_lower_date (tag_t class_id, tag_t attr_id, date_t *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_lower_double (tag_t class_id, tag_t attr_id, double *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_lower_int (tag_t class_id, tag_t attr_id, int *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_lower_string (tag_t class_id, tag_t attr_id, char **value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_lower_utc_date (tag_t class_id, tag_t attr_id, date_t *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_string (tag_t instance_tag, tag_t attr_id, char **value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_strings (tag_t instance_tag, tag_t attr_id, int start, int n_values, char ***values, logical **is_it_null, logical **is_it_empty)
 
POMAPI int POM_ask_attr_tag (tag_t instance_tag, tag_t attr_id, tag_t *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_tags (tag_t instance_tag, tag_t attr_id, int start, int n_values, tag_t **values, logical **is_it_null, logical **is_it_empty)
 
POMAPI int POM_ask_attr_upper_char (tag_t class_id, tag_t attr_id, char *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_upper_date (tag_t class_id, tag_t attr_id, date_t *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_upper_double (tag_t class_id, tag_t attr_id, double *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_upper_int (tag_t class_id, tag_t attr_id, int *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_upper_string (tag_t class_id, tag_t attr_id, char **value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_upper_utc_date (tag_t class_id, tag_t attr_id, date_t *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_utc_date (tag_t instance_tag, tag_t attr_id, date_t *value, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_ask_attr_utc_dates (tag_t instance_tag, tag_t attr_id, int start, int n_values, date_t **values, logical **is_it_null, logical **is_it_empty)
 
POMAPI int POM_ask_authenticated_groups (int *n_groups, tag_t **groups)
 
POMAPI int POM_ask_database_info (char **database_name, char **database_version, char **database_banner)
 
POMAPI int POM_ask_default_group (tag_t *group_tag)
 
POMAPI int POM_ask_domain_of_char (tag_t class_id, tag_t attr_id, int *n_values, char **values)
 
POMAPI int POM_ask_domain_of_date (tag_t class_id, tag_t attr_id, int *n_values, date_t **values)
 
POMAPI int POM_ask_domain_of_double (tag_t class_id, tag_t attr_id, int *n_values, double **values)
 
POMAPI int POM_ask_domain_of_int (tag_t class_id, tag_t attr_id, int *n_values, int **values)
 
POMAPI int POM_ask_domain_of_logical (tag_t class_id, tag_t attr_id, int *n_values, logical **values)
 
POMAPI int POM_ask_domain_of_string (tag_t class_id, tag_t attr_id, int *n_values, char ***values)
 
POMAPI int POM_ask_domain_of_tag (tag_t class_id, tag_t attr_id, int *n_values, tag_t **values)
 
POMAPI int POM_ask_earliest_date (date_t *value)
 
POMAPI int POM_ask_env_info (int what_to_ask_about, logical *logical_current_value, int *int_current_value, double *double_current_value, tag_t *tag_current_value, char **string_current_value)
 
POMAPI int POM_ask_group (char **group_name_string, tag_t *group_tag)
 
POMAPI int POM_ask_group_name (tag_t group, char **name)
 
POMAPI int POM_ask_group_tag (const char *group_name_string, tag_t *group_tag)
 
POMAPI int POM_ask_index_of_char (tag_t instance_tag, tag_t attr_id, char value, int *values_index)
 
POMAPI int POM_ask_index_of_date (tag_t instance_tag, tag_t attr_id, date_t value, int *values_index)
 
POMAPI int POM_ask_index_of_double (tag_t instance_tag, tag_t attr_id, double value, int *values_index)
 
POMAPI int POM_ask_index_of_int (tag_t instance_tag, tag_t attr_id, int value, int *values_index)
 
POMAPI int POM_ask_index_of_logical (tag_t instance_tag, tag_t attr_id, logical value, int *values_index)
 
POMAPI int POM_ask_index_of_null (tag_t instance_tag, tag_t attr_id, int *values_index)
 
POMAPI int POM_ask_index_of_string (tag_t instance_tag, tag_t attr_id, const char *value, int *values_index)
 
POMAPI int POM_ask_index_of_tag (tag_t instance_tag, tag_t attr_id, tag_t value, int *values_index)
 
POMAPI int POM_ask_instance_lock (tag_t instance, int *lock_token)
 
POMAPI int POM_ask_instance_state (tag_t instance, int *state_token)
 
POMAPI int POM_ask_instances_locks (int n_instances, const tag_t *instances, int **lock_token)
 
POMAPI int POM_ask_instances_states (int n_instances, const tag_t *instances, int **state_tokens)
 
POMAPI int POM_ask_latest_date (date_t *value)
 
POMAPI int POM_ask_logins (logical *enable_logins)
 
POMAPI int POM_ask_member (tag_t *member_tag)
 
POMAPI int POM_ask_owner (tag_t instance_tag, tag_t *user_tag, tag_t *group_tag)
 
POMAPI int POM_ask_retry_count (int *count)
 
POMAPI int POM_ask_server_info (int *node_type, char **node_name)
 
POMAPI int POM_ask_session (tag_t *session)
 
POMAPI int POM_ask_site_config_file (int index, logical leave_loaded, char **text, logical *has_changed)
 
POMAPI int POM_ask_top_class (tag_t *class_id)
 
POMAPI int POM_ask_user_default_group (tag_t user, tag_t *group_tag)
 
POMAPI int POM_ask_user_id (tag_t user, char **id)
 
POMAPI int POM_ask_user_name (tag_t user, char **name)
 
POMAPI int POM_ask_users_accessors (int n_user_accs, tag_t *user_accs, int *n_accessors, tag_t **accessors)
 
POMAPI int POM_attr_to_apid (tag_t class_id, tag_t attr_id, int *apid)
 
POMAPI int POM_auto_login (void)
 
POMAPI int POM_check_password (tag_t user_tag, const char *password_string, logical *answer)
 
POMAPI int POM_class_to_cpid (tag_t class_id, int *cpid)
 
POMAPI int POM_clear_attr (int n_instances, const tag_t *instance_tags, tag_t attr_id)
 
POMAPI int POM_compare_attr_ids (tag_t attr_id1, tag_t attr_id2, logical *answer)
 
POMAPI int POM_compare_class_ids (tag_t class_id1, tag_t class_id2, logical *answer)
 
POMAPI int POM_compare_dates (date_t date1, date_t date2, int *answer)
 
POMAPI int POM_convert_date (int conversion, date_t original_date, date_t *converted_date)
 
POMAPI int POM_copy_over (tag_t source, tag_t target)
 
POMAPI int POM_create_file (const char *application, int version, tag_t *file)
 
POMAPI int POM_dbname_of_att (tag_t class_id, tag_t attr_id, char **table, char **base)
 
POMAPI int POM_define_func_index (const char *index_name, tag_t class_id, int n_attrs, const tag_t *attr_ids, logical is_unique, const char *expr)
 
POMAPI int POM_delete_accessor (tag_t accessor)
 
POMAPI int POM_delete_group (tag_t a_group)
 
POMAPI int POM_delete_instances (int n_instances, const tag_t *instance_tags)
 
POMAPI int POM_delete_instances_by_enq (tag_t enquiry_id, int *n_instances, tag_t **instances)
 
POMAPI int POM_delete_member (tag_t a_member)
 
POMAPI int POM_delete_user (tag_t a_user)
 
POMAPI int POM_describe_class_index (const char *index_name, tag_t class_id, int *n_attrs, tag_t **attr_ids, int **pos, char ***expr)
 
POMAPI int POM_describe_error (int error_code, char **string)
 
POMAPI int POM_describe_token (int token, char **string)
 
POMAPI int POM_exit_module (void)
 
POMAPI int POM_file_add_instance (tag_t file, tag_t instance)
 
POMAPI int POM_file_add_unsaved_instance (tag_t file, tag_t instance)
 
POMAPI int POM_file_ask_candidate_keys (tag_t pom_file, int *n_key_strings, char ***key_strings)
 
POMAPI int POM_file_ask_contents (tag_t file, int *n_instances, tag_t **instances)
 
POMAPI int POM_file_ask_conv_attr_info (tag_t file, const char *class_name, int *count, char ***attrs, int **states)
 
POMAPI int POM_file_ask_conv_class_info (tag_t file, int *count, char ***classes, int **states)
 
POMAPI int POM_file_ask_data (tag_t file, tag_t class_id, tag_t instance, int *n_values, char ***values)
 
POMAPI int POM_file_ask_destination (tag_t file, tag_t *destination)
 
POMAPI int POM_file_ask_selected (tag_t file, int *n_instances, tag_t **instances)
 
POMAPI int POM_file_ask_xmit_file (const char *pathname, char **xmitname)
 
POMAPI int POM_file_is_included (tag_t file, tag_t instance, logical *is_included)
 
POMAPI int POM_file_is_recovered (tag_t file, tag_t instance, logical *is_recovered)
 
POMAPI int POM_file_recover_instance (tag_t file, tag_t instance)
 
POMAPI int POM_file_replace_tag (tag_t file, tag_t original_tag, tag_t replacement_tag)
 
POMAPI int POM_file_select_instance (tag_t file, tag_t instance)
 
POMAPI int POM_file_set_candidate_key (tag_t pom_file, tag_t instance, int n_attributes, const tag_t *attributes)
 
POMAPI int POM_file_set_data (tag_t file, tag_t class_id, tag_t instance, int n_values, char **values)
 
POMAPI int POM_file_set_destination (tag_t file, tag_t destination)
 
POMAPI int POM_file_set_stub_data (int n_entries, tag_t *tags, char **names, char **values)
 
POMAPI int POM_file_transfer_instance (tag_t file, tag_t instance)
 
POMAPI int POM_file_view_instance (tag_t file, tag_t instance)
 
POMAPI int POM_find_accessor (int n_instances, const tag_t *instances, tag_t *accessor)
 
POMAPI int POM_find_h_groups (const char *group_pattern, tag_t root_group, int *n_groups, tag_t **groups)
 
POMAPI int POM_free (void *space)
 
POMAPI int POM_freeze (tag_t instance_to_freeze)
 
POMAPI int POM_get_char_ordering (char **string)
 
POMAPI int POM_get_earliest_date (date_t *value)
 
POMAPI int POM_get_earliest_utc_date (date_t *value)
 
POMAPI int POM_get_latest_date (date_t *value)
 
POMAPI int POM_get_latest_utc_date (date_t *value)
 
POMAPI int POM_get_object_property (tag_t instance, int bit_to_get, logical *verdict)
 
POMAPI int POM_get_user (char **user_name_string, tag_t *user_tag)
 
POMAPI int POM_get_user_id (char **user_id_string)
 
POMAPI int POM_get_version (int *version)
 
POMAPI int POM_init_group (tag_t new_group, const char *name, int privilege)
 
POMAPI int POM_init_h_group (tag_t group, const char *name, int privilege, tag_t parent_group)
 
POMAPI int POM_init_member (tag_t new_member, tag_t user, tag_t group, logical as_ga)
 
POMAPI int POM_init_module (void)
 
POMAPI int POM_init_user (tag_t new_user, const char *user_id, const char *user_name, const char *password)
 
POMAPI int POM_insert_attr_chars (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const char *values)
 
POMAPI int POM_insert_attr_dates (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const date_t *values)
 
POMAPI int POM_insert_attr_doubles (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const double *values)
 
POMAPI int POM_insert_attr_ints (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const int *values)
 
POMAPI int POM_insert_attr_logicals (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const logical *values)
 
POMAPI int POM_insert_attr_nulls (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values)
 
POMAPI int POM_insert_attr_strings (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, char **values)
 
POMAPI int POM_insert_attr_tags (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const tag_t *values)
 
POMAPI int POM_instance_exists (tag_t instance_tag, logical *verdict)
 
POMAPI int POM_is_cached (tag_t instance, logical *is_cached)
 
POMAPI int POM_is_database_there (int *state)
 
POMAPI int POM_is_frozen (tag_t instance, logical *verdict)
 
POMAPI int POM_is_loaded (tag_t instance, logical *verdict)
 
POMAPI int POM_is_newly_created (tag_t instance, logical *answer)
 
POMAPI int POM_is_possible_earliest_date (const date_t *value, logical *result)
 
POMAPI int POM_is_possible_earliest_utc_date (const date_t *value, logical *result)
 
POMAPI int POM_is_running (logical *logged_in)
 
POMAPI int POM_is_sub_group (tag_t group, tag_t sub_group, logical *answer)
 
POMAPI int POM_is_tag_valid (tag_t tag, logical *answer)
 
POMAPI int POM_length_of_attr (tag_t instance, tag_t attr_id, int *length)
 
POMAPI int POM_list_connected_sessions (int *count, char ***descriptors)
 
POMAPI int POM_list_group_members (tag_t a_group, int *n_members, tag_t **members)
 
POMAPI int POM_load_class_extent (const char *aclass, int *n_instances, tag_t **instances, int lock_type)
 
POMAPI int POM_load_instances_possible_by_enquiry (const char *enq_id, const char *class_name, int *n_instances, tag_t **instances, int *n_failures, tag_t **failed_instances)
 
POMAPI int POM_location_of_instance (tag_t instance, tag_t *location)
 
POMAPI int POM_lock_instances_for_reference (unsigned int n_ref_instances, const tag_t *ref_instances, unsigned int *n_failed_ref_instances, tag_t **failed_ref_instances)
 
POMAPI int POM_login (const char *user_name, const char *password, const char *group_name)
 
POMAPI int POM_login_sponsored (const char *user_name, const char *password, const char *sponsored_user_name, const char *sponsored_group_name)
 
POMAPI int POM_logout (logical ignore_unsaved_stuff)
 
POMAPI int POM_look_for_lost_locks (int *n_lost, tag_t **lost, int **why, char ***who)
 
POMAPI int POM_lookup_imc (int site_id, tag_t *imc)
 
POMAPI int POM_modify_char (int n_instances, const tag_t *instance_tags, tag_t attr_id, char value)
 
POMAPI int POM_modify_char_by_enq (tag_t enquiry_id, tag_t attr_id, char value, int *n_instances, tag_t **instances)
 
POMAPI int POM_modify_chars (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const char *values)
 
POMAPI int POM_modify_chars_by_enq (tag_t enquiry_id, tag_t attr_id, int start, int n_values, const char *values, int *n_instances, tag_t **instances)
 
POMAPI int POM_modify_date (int n_instances, const tag_t *instance_tags, tag_t attr_id, date_t value)
 
POMAPI int POM_modify_date_by_enq (tag_t enquiry_id, tag_t attr_id, date_t value, int *n_instances, tag_t **instances)
 
POMAPI int POM_modify_dates (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const date_t *values)
 
POMAPI int POM_modify_dates_by_enq (tag_t enquiry_id, tag_t attr_id, int start, int n_values, const date_t *values, int *n_instances, tag_t **instances)
 
POMAPI int POM_modify_double (int n_instances, const tag_t *instance_tags, tag_t attr_id, double value)
 
POMAPI int POM_modify_double_by_enq (tag_t enquiry_id, tag_t attr_id, double value, int *n_instances, tag_t **instances)
 
POMAPI int POM_modify_doubles (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const double *values)
 
POMAPI int POM_modify_doubles_by_enq (tag_t enquiry_id, tag_t attr_id, int start, int n_values, const double *values, int *n_instances, tag_t **instances)
 
POMAPI int POM_modify_int (int n_instances, const tag_t *instance_tags, tag_t attr_id, int value)
 
POMAPI int POM_modify_int_by_enq (tag_t enquiry_id, tag_t attr_id, int value, int *n_instances, tag_t **instances)
 
POMAPI int POM_modify_ints (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const int *values)
 
POMAPI int POM_modify_ints_by_enq (tag_t enquiry_id, tag_t attr_id, int start, int n_values, const int *values, int *n_instances, tag_t **instances)
 
POMAPI int POM_modify_logical (int n_instances, const tag_t *instance_tags, tag_t attr_id, logical value)
 
POMAPI int POM_modify_logical_by_enq (tag_t enquiry_id, tag_t attr_id, logical value, int *n_instances, tag_t **instances)
 
POMAPI int POM_modify_logicals (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const logical *values)
 
POMAPI int POM_modify_logicals_by_enq (tag_t enquiry_id, tag_t attr_id, int start, int n_values, const logical *values, int *n_instances, tag_t **instances)
 
POMAPI int POM_modify_null (int n_instances, const tag_t *instance_tags, tag_t attr_id)
 
POMAPI int POM_modify_null_by_enq (tag_t enquiry_id, tag_t attr_id, int *n_instances, tag_t **instances)
 
POMAPI int POM_modify_nulls (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values)
 
POMAPI int POM_modify_nulls_by_enq (tag_t enquiry_id, tag_t attr_id, int start, int n_values, int *n_instances, tag_t **instances)
 
POMAPI int POM_modify_string (int n_instances, const tag_t *instance_tags, tag_t attr_id, const char *value)
 
POMAPI int POM_modify_string_by_enq (tag_t enquiry_id, tag_t attr_id, const char *value, int *n_instances, tag_t **instances)
 
POMAPI int POM_modify_strings (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, char **values)
 
POMAPI int POM_modify_strings_by_enq (tag_t enquiry_id, tag_t attr_id, int start, int n_values, char **values, int *n_instances, tag_t **instances)
 
POMAPI int POM_modify_tag (int n_instances, const tag_t *instance_tags, tag_t attr_id, tag_t value)
 
POMAPI int POM_modify_tag_by_enq (tag_t enquiry_id, tag_t attr_id, tag_t value, int *n_instances, tag_t **instances)
 
POMAPI int POM_modify_tags (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const tag_t *values)
 
POMAPI int POM_modify_tags_by_enq (tag_t enquiry_id, tag_t attr_id, int start, int n_values, const tag_t *values, int *n_instances, tag_t **instances)
 
POMAPI int POM_new_group (const char *name, int privilege, tag_t *new_group)
 
POMAPI int POM_new_h_group (const char *name, int privilege, tag_t parent_group, tag_t *new_group)
 
POMAPI int POM_new_member (tag_t user, tag_t group, logical as_ga, tag_t *new_member)
 
POMAPI int POM_new_user (const char *user_id, const char *user_name, const char *password, tag_t *new_user)
 
POMAPI date_t POM_null_date (void)
 
POMAPI date_tPOM_null_date_ptr (void)
 
POMAPI int POM_order_instances (tag_t class_id, int n_instances, const tag_t *instances, int n_attrs, const tag_t *attr_ids, const int *up_or_down_tokens, tag_t **ordered_instances)
 
POMAPI int POM_pack_strings (int n_strings, char **strings, char ***packed_strings)
 
POMAPI int POM_preinit_pattern_match (int pattern)
 
POMAPI int POM_read_file (const char *pathname, char **application, int *version, tag_t *file)
 
POMAPI int POM_refresh_instances (int n_instances, const tag_t *instances, tag_t class_to_load_as, int lock_type)
 
POMAPI int POM_refresh_instances_any_class (int n_instances, const tag_t *instances, int lock_type)
 
POMAPI int POM_regen_schema_file (const char *initial_user, const char *initial_password, const char *initial_group)
 
POMAPI int POM_remove_from_attr (int n_instances, const tag_t *instances, tag_t attr_id, int position, int number)
 
POMAPI int POM_reorder_attr (int n_instances, const tag_t *instances, tag_t attr_id, int start, int number, int newstart)
 
POMAPI int POM_replace_string_value (const char *class_name, const char *attr_name, const char *old_str_value, const char *new_str_value, logical match_exact_value)
 
POMAPI int POM_revert_attr (const tag_t instance, tag_t attr_id)
 
POMAPI int POM_set_archive_date (tag_t instance, date_t archive_date)
 
POMAPI int POM_set_archive_date_null (tag_t instance)
 
POMAPI int POM_set_archive_info (tag_t instance, const char *archive_info)
 
POMAPI int POM_set_archive_info_null (tag_t instance)
 
POMAPI int POM_set_attr_char (int n_instances, const tag_t *instance_tags, tag_t attr_id, char value)
 
POMAPI int POM_set_attr_chars (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const char *values)
 
POMAPI int POM_set_attr_date (int n_instances, const tag_t *instance_tags, tag_t attr_id, date_t value)
 
POMAPI int POM_set_attr_dates (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const date_t *values)
 
POMAPI int POM_set_attr_double (int n_instances, const tag_t *instance_tags, tag_t attr_id, double value)
 
POMAPI int POM_set_attr_doubles (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const double *values)
 
POMAPI int POM_set_attr_int (int n_instances, const tag_t *instance_tags, tag_t attr_id, int value)
 
POMAPI int POM_set_attr_ints (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const int *values)
 
POMAPI int POM_set_attr_logical (int n_instances, const tag_t *instance_tags, tag_t attr_id, logical value)
 
POMAPI int POM_set_attr_logicals (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const logical *values)
 
POMAPI int POM_set_attr_null (int n_instances, const tag_t *instance_tags, tag_t attr_id)
 
POMAPI int POM_set_attr_nulls (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values)
 
POMAPI int POM_set_attr_string (int n_instances, const tag_t *instance_tags, tag_t attr_id, const char *value)
 
POMAPI int POM_set_attr_strings (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, char **values)
 
POMAPI int POM_set_attr_tag (int n_instances, const tag_t *instance_tags, tag_t attr_id, tag_t value)
 
POMAPI int POM_set_attr_tags (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const tag_t *values)
 
POMAPI int POM_set_attr_utc_date (int n_instances, const tag_t *instance_tags, tag_t attr_id, date_t value)
 
POMAPI int POM_set_attr_utc_dates (int n_instances, const tag_t *instance_tags, tag_t attr_id, int start, int n_values, const date_t *values)
 
POMAPI int POM_set_backup_date (tag_t instance, date_t backup_date)
 
POMAPI int POM_set_creation_date (tag_t instance, date_t creation_date)
 
POMAPI int POM_set_creation_utc_date (tag_t instance, date_t creation_date)
 
POMAPI int POM_set_default_group (tag_t group_tag)
 
POMAPI int POM_set_env_info (int what_to_set, logical logical_value_to_set, int int_value_to_set, double double_value_to_set, tag_t tag_value_to_set, const char *string_value_to_set)
 
POMAPI int POM_set_group (const char *group_name_string, tag_t *group_tag)
 
POMAPI int POM_set_group_by_tag (tag_t group_tag)
 
POMAPI int POM_set_group_name (tag_t group, const char *name)
 
POMAPI int POM_set_group_parent (tag_t group, tag_t parent)
 
POMAPI int POM_set_group_privilege (tag_t group, int privilege)
 
POMAPI int POM_set_instance_location (tag_t instance, tag_t location)
 
POMAPI int POM_set_logins (logical enable_logins)
 
POMAPI int POM_set_member_group (tag_t member, tag_t group)
 
POMAPI int POM_set_member_is_ga (tag_t member, logical is_ga)
 
POMAPI int POM_set_member_user (tag_t member, tag_t user)
 
POMAPI int POM_set_modification_date (tag_t instance, date_t modification_date)
 
POMAPI int POM_set_modification_user (tag_t instance, tag_t modification_user)
 
POMAPI int POM_set_modification_utc_date (tag_t instance, date_t modification_date)
 
POMAPI int POM_set_object_property (tag_t instance, int bit_to_set, logical value)
 
POMAPI int POM_set_owners (int n_instances, tag_t *instances, tag_t owning_user, tag_t owning_group)
 
POMAPI int POM_set_owning_group (tag_t instance, tag_t group)
 
POMAPI int POM_set_owning_user (tag_t instance, tag_t user)
 
POMAPI int POM_set_password (tag_t user_tag, const char *old_password_string, const char *new_password_string)
 
POMAPI int POM_set_retry_count (int count)
 
POMAPI int POM_set_retry_interval (int retry_interval)
 
POMAPI int POM_set_site_config_file (int index, const char *text)
 
POMAPI int POM_set_user_default_group (tag_t user, tag_t group_tag)
 
POMAPI int POM_set_user_id (tag_t user, const char *id)
 
POMAPI int POM_set_user_license_status (tag_t a_user, int new_status, int license_level, int *purchased, int *used)
 
POMAPI int POM_set_user_license_status2 (tag_t a_user, int new_status, int license_level, const char *license_bundle, int *purchased, int *used)
 
POMAPI int POM_set_user_license_status_with_server (tag_t a_user, int new_status, int license_level, const char *license_bundle, const char *license_server, int *purchased, int *used)
 
POMAPI int POM_set_user_name (tag_t user, const char *name)
 
POMAPI int POM_site_id (int *site)
 
POMAPI int POM_sql_drop_view (const char *view_name)
 
POMAPI int POM_sql_view_exists (const char *view_name, logical *answer)
 
POMAPI int POM_sql_view_of_class (tag_t class_id, int n_attrs, const tag_t *attr_ids, char **column_names, const char *view_name)
 
POMAPI int POM_start (const char *user_name, const char *password, const char *group_name, tag_t *user_tag, tag_t *topmost_class_id, int *pom_version)
 
POMAPI int POM_stop (logical ignore_unsaved_stuff)
 
POMAPI int POM_string_to_token (const char *string, int *token)
 
POMAPI int POM_tag_to_uid (tag_t tag, char **string)
 
POMAPI int POM_type_of_att (tag_t class_id, tag_t attr_id, int *type)
 
POMAPI int POM_unfreeze (tag_t instance_to_unfreeze)
 
POMAPI int POM_unload_file (tag_t file)
 
POMAPI int POM_unload_instances (int n_instances, const tag_t *instance_tags)
 
POMAPI int POM_unlock_reference_instances (unsigned int n_ref_instances, const tag_t *ref_instances)
 
POMAPI int POM_who_locked_instance (tag_t inst, char **user_name, date_t *login_date, char **node_name)
 
POMAPI int POM_who_locked_instances (int n_instances, tag_t *insts, logical **is_modify_locked, char ***user_names, date_t **login_dates, char ***node_names)
 
POMAPI int POM_write_file (tag_t file, const char *pathname, int os_protection)
 
POMAPI int POM_write_transmit_file (void)
 
Basic POM Functions

Columns names made public via pom_tokens.inc (for generating sql).Error codes returned by POM Input tokens Macro commands

POMAPI int POM_define_index (const char *index_name, tag_t class_id, int n_attrs, const tag_t *attr_ids, logical is_unique)
 
POMAPI int POM_remove_index (const char *index_name, tag_t class_id)
 
POMAPI int POM_superclasses_of_class (tag_t class_id, int *n_ids, tag_t **superclass_ids)
 
POMAPI int POM_subclasses_of_class (tag_t class_id, int *n_ids, tag_t **subclass_ids)
 
POMAPI int POM_is_descendant (tag_t class_id, tag_t sub_class_id, logical *answer)
 
POMAPI int POM_class_id_of_class (const char *class_name, tag_t *class_id)
 
POMAPI int POM_does_class_exist (const char *class_name, logical *exists)
 
POMAPI int POM_name_of_class (tag_t class_id, char **class_name)
 
POMAPI int POM_describe_class (tag_t class_id, int n_names, char **attr_names, char **application_name, int *descriptor, int *n_attrs, tag_t **attr_ids)
 
POMAPI int POM_describe_attrs (tag_t class_id, int n_attrs, const tag_t *attr_ids, char ***names, int **types, int **max_string_lengths, tag_t **referenced_classes, int **lengths, int **descriptors, int **attr_failures)
 
POMAPI int POM_describe_index (const char *index_name, tag_t class_id, int *n_attrs, tag_t **attr_ids)
 
POMAPI int POM_indexes_of_class (tag_t class_id, int *n_indexes, char ***index_names)
 
POMAPI int POM_indexes_of_attr (tag_t class_id, tag_t attr_id, int *n_indexes, char ***index_names)
 
POM Functions for Instances
POMAPI int POM_refresh_required (tag_t instance, logical *verdict)
 
POMAPI int POM_save_required (tag_t instance, logical *verdict)
 
POMAPI int POM_modifiable (tag_t instance, logical *verdict)
 
POMAPI int POM_attr_id_of_attr (const char *attr_name, const char *class_name, tag_t *attr_id)
 
POMAPI int POM_attr_exists (const char *attr_name, const char *class_name, logical *exists)
 
POMAPI int POM_instances_of_class (tag_t class_id, logical include_subclasses, int *n_instances, tag_t **instance_tags)
 
POMAPI int POM_class_of_instance (tag_t instance_tag, tag_t *class_id)
 
POMAPI int POM_loaded_class_of_instance (tag_t instance_tag, tag_t *class_id)
 
POMAPI int POM_negate_enquiry (tag_t enquiry_id, tag_t *new_enquiry_id)
 
POMAPI int POM_scope_enquiry (tag_t enquiry_id, tag_t scope)
 
POMAPI int POM_select_instances (int n_instances, const tag_t *instance_tags, int n_attrs, const tag_t *attr_ids, tag_t class_to_load_as, int lock_type)
 
POMAPI int POM_select_instances_by_enq (tag_t enquiry_id, int n_attrs, const tag_t *attr_ids, tag_t class_to_load_as, int lock_type, int *n_instances, tag_t **instances)
 
POMAPI int POM_referencers_of_instance (tag_t instance_tag, int n_levels, int where_to_search, int *n_instances, tag_t **ref_instances, int **instance_levels, int **instance_where_found, int *n_classes, tag_t **ref_classes, int **class_levels, int **class_where_found)
 
POMAPI int POM_create_instance (tag_t class_id, tag_t *instance_tag)
 
POMAPI int POM_copy_instances (int n_instances, const tag_t *instance_tags, tag_t **new_instances)
 
POMAPI int POM_save_instances (int n_instances, const tag_t *instance_tags, logical whether_to_unload)
 
POMAPI int POM_load_instances_any_class (int n_instances, const tag_t *instances, int lock_type)
 
POMAPI int POM_load_instances (int n_instances, const tag_t *instance_tags, tag_t class_to_load_as, int lock_type)
 
POMAPI int POM_load_instances_possible (int n_instances, const tag_t *instances, int *n_ret_instances, tag_t **ret_instances)
 
POMAPI int POM_load_instances_by_enq (tag_t enquiry_id, tag_t class_to_load_as, int lock_type, int *n_instances, tag_t **instances)
 
POM Functions for Users and Groups
POMAPI int POM_is_user_sa (logical *verdict)
 
POMAPI int POM_is_user_ga (tag_t group, logical *verdict)
 
POM System Functions
POMAPI int POM_place_markpoint (int *markpoint_number)
 
POMAPI int POM_roll_to_markpoint (int markpoint_number, logical *state_has_changed)
 
POMAPI int POM_forget_markpoint (int markpoint_number)
 
POMAPI int POM_cache_for_session (tag_t *value)
 
POMAPI int POM_install_application (const char *name, const char *password)
 
POMAPI int POM_is_application_installed (const char *application_name, const char *application_password, logical *result)
 
POMAPI int POM_register_application (const char *application_name, const char *application_password, int *application_id, int *application_code)
 
POMAPI int POM_is_application_registered (const char *application_name, const char *application_password, logical *result)
 
POMAPI int POM_identify_application (int application_id, int application_code, logical permission)
 
POMAPI int POM_is_application_identified (int application_id, int application_code, logical *result)
 
POMAPI int POM_check_reference (tag_t instance_tag, tag_t attr_id, tag_t *class_id_of_reference, logical *is_it_null, logical *is_it_empty)
 
POMAPI int POM_set_timeout (double timeout_value)
 
POMAPI int POM_ask_timeout (double *timeout_value)
 
POMAPI int POM_explain_last_error (int *error_code, int *argument_number, char **function_name, char **explanation)
 
Miscellaneous POM Functions
POMAPI int POM_tag_to_string (tag_t tag, char **string)
 
POMAPI int POM_string_to_tag (const char *string, tag_t *tag)
 
POMAPI int POM_uids_to_tags (const int n_uids, const char **uids, const tag_t cparam, const int *cpids, tag_t **tags)
 

Detailed Description

Interface definition for the POM module.

Contains:

Definition in file pom.h.