ics/ics2.h File Reference

---

Detailed Description

Published ITK functions to create/modify in-CLASS Objects

Definition in file ics2.h.

#include <ics/libics_exports.h>
#include <ics/libics_undef.h>

Go to the source code of this file.

Data Structures

• struct ICS_auto_compute_attr_s
• struct ICS_view_attribute_descriptor_s
• struct ICS_view_descriptor_s

View/Subclass related Functions

Common return values:

ICS_err_attribute_does_not_exist
ICS_err_cannot_create_files
ICS_err_class_does_not_exist
ICS_err_could_not_open_file
ICS_err_file_already_exists
ICS_err_invalid_property
ICS_err_invalid_reference_type
ICS_err_invalid_value
ICS_err_parent_is_not_shared
ICS_err_view_does_not_exist

• typedef struct
  ICS_view_attribute_descriptor_s ICS_view_attribute_descriptor_t
• typedef struct
  ICS_view_attribute_descriptor_s * ICS_view_attribute_descriptor_p_t
• typedef struct
  ICS_view_descriptor_s ICS_view_descriptor_t
• typedef struct
  ICS_view_descriptor_s * ICS_view_descriptor_p_t
• ICS_API logical ICS_view_exists (const char *theClassId, const char *theViewId)
• ICS_API int ICS_view_create (const char *theClassId, const char *theViewId, ICS_view_type_e theViewType, const char *theName, int theAttrCount, int *theAttrIds)
• ICS_API int ICS_view_remove (const char *theClassId, const char *theViewId)
• ICS_API int ICS_view_save (const char *theClassId, const char *theViewId)
• ICS_API int ICS_view_refresh (const char *theClassId, const char *theViewId)
• ICS_API int ICS_view_cancel (const char *theClassId, const char *theViewId)
• ICS_API int ICS_view_set_property (const char *theClassId, const char *theViewId, const char *thePropertyName, const char *thePropertyValue)
• ICS_API int ICS_view_ask_property (const char *theClassId, const char *theViewId, const char *thePropertyName, char **thePropertyValue)
• ICS_API int ICS_view_add_shared_site (const char *theClassId, const char *theViewId, const char *theSharedSite, logical approveShareOfParents)
• ICS_API int ICS_view_ask_shared_sites (const char *theClassId, const char *theViewId, int *theSiteCount, char ***theSharedSites)
• ICS_API int ICS_view_add_attributes (const char *theClassId, const char *theViewId, int theAttrCount, int *theAttrIds)
• ICS_API int ICS_view_remove_attributes (const char *theClassId, const char *theViewId, int theAttrCount, int *theAttrIds)
• ICS_API int ICS_view_set_attr_property (const char *theClassId, const char *theViewId, int theAttributeId, const char *thePropertyName, const char *thePropertyValue)
• ICS_API int ICS_view_ask_attr_property (const char *theClassId, const char *theViewId, int theAttributeId, const char *thePropertyName, char **thePropertyValue)
• ICS_API int ICS_view_ask_attributes (const char *theClassId, const char *theViewId, int *theAttributeCount, int **theAttributeIds)
• ICS_API int ICS_view_describe (const char *theClassId, const char *theViewId, const char *theUnitSystem, logical theUserMode, ICS_view_descriptor_p_t *theViewDescriptor)
• ICS_API void ICS_view_descriptor_free (ICS_view_descriptor_p_t theViewDescriptor)
• ICS_API int ICS_view_ask_id (tag_t theViewTag, char **theViewId)
• ICS_API int ICS_view_ask_tag (const char *theViewId, tag_t *theViewTag)
• ICS_API int ICS_view_ask_documents (const char *theViewId, int *theDocumentCount, char ***theDocumentTypes, tag_t **theDocumentTags)
• ICS_API int ICS_view_import_document (const char *theViewId, const char *theDocumentType, const char *theFileName)
• ICS_API int ICS_view_export_document (const char *theViewId, const char *theDocumentType, const char *theOutputDirectory, logical overwriteExistingFiles, int *theFileCount, char ***theFileNames)
• ICS_API int ICS_view_remove_document (const char *theViewId, const char *theDocumentType)
• ICS_API int ICS_view_search (const char *theQuery, int theSortAttrId, int theOptions, int *theCount, tag_t **theTags, char ***theTypes, char ***theClassIds, char ***theViewIds, char ***theNames, int **theInstanceCounts)
• ICS_API int ICS_view_copy (const char *theClass, const char *theView, const char *theNewParent, const char *theNewId, ICS_view_type_e theNewType, int theOptions)

Defines

• #define ICS_SEARCH_THIS_CLASS_ONLY   ( 1 << 0 )
• #define ICS_SEARCH_CASE_INSENSITIVE   ( 1 << 1 )
• #define ICS_SEARCH_ORDER_BY_ID   ( 1 << 2 )
• #define ICS_SEARCH_IN_BOTH_UNIT_SYSTEMS   ( 1 << 3 )
• #define ICS_SEARCH_IN_OTHER_UNIT_SYSTEM   ( 1 << 4 )
• #define ICS_ICO_IGNORE_WRITE_PROTECTION_ERRORS   ( 1 << 0 )
• #define ICS_MAX_CLASS_ATTR_SIZE   10
• #define ICS_DBL_STR_SIZE   64
• #define ICS_REFATTR_INHERITED   1
• #define ICS_REFATTR_CLASS_LOCAL   2
• #define ICS_REFATTR_CLASSIFIED_OBJECT   1
• #define ICS_REFATTR_MASTERFORM   2
• #define ICS_REFATTR_RELATED_OBJECT   3
• #define ICS_REFATTR_ICO   4
• #define ICS_REFATTR_ITEM_ATTR   1
• #define ICS_REFATTR_PROPERTY   ( 1 << 1 )
• #define ICS_SUBCLASSES_TO_STORAGE_CLASSES   ( 1 )
• #define ICS_IGNORE_UNREADABLE_CHILDREN   ( 1 << 1 )
• #define ICS_COPY_INHERITED_ATTRIBUTES   ( 1 << 2 )
• #define ICS_DRY_RUN   ( 1 << 3 )
• #define ICS_COPY_THIS_CLASS_ONLY   ( 1 << 4 )
• #define ICS_SHARED_IS_ERROR   ( 1 << 5 )
• #define ICS_ADD_ATTRBIUTES_FROM_PARENT   ( 1 << 6 )
• #define ICS_DEFAULT_VIEW   "defaultView"
• #define ICS_IGNORE_MAPPING_ERRORS   ( 1 )
• #define ICS_ADD_ATTRIBUTE_MOVE_UP   ( 1 << 0 )
• #define ICS_CLASS_USE_VIEW_IMAGE   ( 1 << 0 )

Typedefs

• typedef enum ICS_class_flags_s ICS_class_flags_e
• typedef enum ICS_class_properties_s ICS_class_properties_e
• typedef int(* ICS_auto_compute_function_t )(tag_t, int)
• typedef struct
  ICS_auto_compute_attr_s ICS_auto_compute_attr_t
• typedef enum
  ICS_auto_compute_mode_s ICS_auto_compute_mode_e
• typedef enum ICS_unit_system_s ICS_unit_system_e
• typedef enum ICS_class_attr_flags_s ICS_class_attr_flags_e
• typedef enum ICS_view_type_s ICS_view_type_e
• typedef enum ICS_child_type_s ICS_child_type_e
• typedef enum ICS_class_share_type_s ICS_class_share_type_e
• typedef enum
  ICS_list_children_options_s ICS_list_children_options_e

Enumerations

• enum ICS_class_flags_s {
    CLASS_flag_englishUnitBase = (1 << 0), CLASS_flag_isGroup = (1 << 1), CLASS_flag_unit_system_both = (1 << 2), CLASS_flag_isStorrageClass = (1 << 4),
    CLASS_flag_isAssembly = (1 << 5)
  }
• enum ICS_class_properties_s { CLASS_prop_id = -600, CLASS_prop_parents = -603, CLASS_prop_name = -607 }
• enum ICS_auto_compute_mode_s { AUTOCOMPUTE_MODE_load = 0, AUTOCOMPUTE_MODE_create = 1, AUTOCOMPUTE_MODE_edit = 2 }
• enum ICS_unit_system_s { UNIT_SYSTEM_unspecified = -1, UNIT_SYSTEM_metric = 0, UNIT_SYSTEM_english = 1 }
• enum ICS_class_attr_flags_s {
    CLASS_ATTR_vla = (1 << 0), CLASS_ATTR_external_vla = (1 << 1), CLASS_ATTR_mandatory = (1 << 2), CLASS_ATTR_protected = (1 << 3),
    CLASS_ATTR_unique = (1 << 4), CLASS_ATTR_propagated = (1 << 5), CLASS_ATTR_localValue = (1 << 6), CLASS_ATTR_reference = (1 << 7),
    CLASS_ATTR_auto_computed = (1 << 15), CLASS_ATTR_hidden = (1 << 20), CLASS_ATTR_localizable = (1 << 22), CLASS_ATTR_use_as_facet = (1 << 31)
  }
• enum ICS_view_type_s {
    VIEW_type_subclass = 0, VIEW_type_defaultView = 1, VIEW_type_user = 2, VIEW_type_group = 3,
    VIEW_type_role = 4, VIEW_type_project = 5, VIEW_type_table = 6, VIEW_type_indexing = 7,
    VIEW_type_template_view = 100, VIEW_type_mapping_internal = 200, VIEW_type_mapping_user = 201, VIEW_type_nxlib_search_criteria = 202,
    VIEW_type_nxlib_search_result = 203, VIEW_type_nxlib_retrieve = 204
  }
• enum ICS_child_type_s {
    ICS_CHILD_type_group = (1 << 0), ICS_CHILD_type_class = (1 << 1), ICS_CHILD_type_view = (1 << 2), ICS_CHILD_type_view_no_subclass = (1 << 3),
    ICS_CHILD_type_subclass = (1 << 4), ICS_CHILD_type_template_view = (1 << 5), ICS_CHILD_type_all = ICS_CHILD_type_group | ICS_CHILD_type_class | ICS_CHILD_type_view
  }
• enum ICS_class_share_type_s {
    ICS_CLASS_SHARE_child_classes = (1 << 1), ICS_CLASS_SHARE_default_views = (1 << 2), ICS_CLASS_SHARE_specific_views = (1 << 3), ICS_CLASS_SHARE_subclasses = (1 << 4),
    ICS_CLASS_SHARE_views = ( ICS_CLASS_SHARE_default_views | ICS_CLASS_SHARE_specific_views | ICS_CLASS_SHARE_subclasses ), ICS_CLASS_SHARE_all = ( ICS_CLASS_SHARE_child_classes | ICS_CLASS_SHARE_views )
  }
• enum ICS_list_children_options_s {
    ICS_CHILDREN_NO_COUNT = 0, ICS_CHILDREN_INSTANCE_COUNT = (1 << 0), ICS_CHILDREN_CHILD_COUNT = (1 << 1), ICS_CHILDREN_VIEW_COUNT = (1 << 2),
    ICS_CHILDREN_ALL_COUNT = ICS_CHILDREN_INSTANCE_COUNT | ICS_CHILDREN_CHILD_COUNT | ICS_CHILDREN_VIEW_COUNT
  }

Functions

Class related Functions

Common return values:

ICS_err_attribute_does_not_exist
ICS_err_cannot_create_files
ICS_err_class_does_not_exist
ICS_err_could_not_open_file
ICS_err_file_already_exists
ICS_err_invalid_property
ICS_err_invalid_reference_type
ICS_err_invalid_value
ICS_err_parent_is_not_shared

• ICS_API logical ICS_class_exists (const char *theClassId)
• ICS_API int ICS_class_create (const char *theClassId, const char *theParentId, const char *theName, int theClassFlags, int theAttrCount, int *theAttrIds)
• ICS_API int ICS_class_create_unique (const char *theParentId, const char *theName, int theClassFlags, int theAttrCount, int *theAttrIds, char **theNewClassId)
• ICS_API int ICS_class_remove (const char *theClassId)
• ICS_API int ICS_class_save (const char *theClassId)
• ICS_API int ICS_class_refresh (const char *theClassId)
• ICS_API int ICS_class_cancel (const char *theClassId)
• ICS_API int ICS_class_set_property (const char *theClassId, const char *thePropertyName, const char *thePropertyValue)
• ICS_API int ICS_class_ask_property (const char *theClassId, const char *thePropertyName, char **thePropertyValue)
• ICS_API int ICS_class_add_shared_site (const char *theClassId, const char *theSharedSite, logical approveShareOfParents)
• ICS_API int ICS_class_ask_shared_sites (const char *theClassId, int *theSiteCount, char ***theSharedSites)
• ICS_API int ICS_class_set_alias_names (const char *theClassId, int theCount, const char **theLanguages, const char **theAliasNames)
• ICS_API int ICS_class_add_alias_name (const char *theClassId, const char *theLanguage, const char *theAliasName)
• ICS_API int ICS_class_ask_alias_names (const char *theClassId, int *theCount, char ***theLanguages, char ***theAliasNames)
• ICS_API int ICS_class_import_document (const char *theClassId, const char *theDocumentType, const char *theFileName)
• ICS_API int ICS_class_export_document (const char *theClassId, const char *theDocumentType, const char *theOutputDirectory, logical overwriteExistingFiles, int *theFileCount, char ***theFileNames)
• ICS_API int ICS_class_ask_document_fileId (const char *theClassId, const char *theDocumentType, char **theFileId)
• ICS_API int ICS_class_ask_documents (const char *theClassId, int *theDocumentCount, char ***theDocumentTypes, tag_t **theDocumentTags)
• ICS_API int ICS_class_remove_document (const char *theClassId, const char *theDocumentType)
• ICS_API int ICS_class_add_attributes (const char *theClassId, int theAttrCount, int *theAttrIds)
• ICS_API int ICS_class_add_attributes2 (const char *theClassId, int theAttrCount, int *theAttrIds, int theOptions)
• ICS_API int ICS_class_ask_attributes (const char *theClassId, int *theAttributeCount, tag_t **theAttributeTags, int **theAttributeIds)
• ICS_API int ICS_class_remove_attributes (const char *theClassId, int theAttrCount, int *theAttrIds)
• ICS_API int ICS_class_set_attr_property (const char *theClassId, int theAttributeId, const char *thePropertyName, const char *thePropertyValue)
• ICS_API int ICS_class_ask_attr_property (const char *theClassId, int theAttributeId, const char *thePropertyName, char **thePropertyValue)
• ICS_API int ICS_class_search (const char *theQuery, int theSortOption, int *theCount, tag_t **theTags, char ***theTypes, char ***theCIDs, char ***theNames, int **theInstancesCounts, int **theChildCounts, int **theViewCounts, int **theSubClassCounts)
• ICS_API int ICS_class_ask_parent (const char *theClassId, tag_t *theParentTag, char **theParentId)
• ICS_API int ICS_class_ask_parents (const char *theClassId, logical includeGroups, int *theParentCount, tag_t **theParentTags, char ***theParentIds)
• ICS_API int ICS_class_ask_children (const char *theClassId, int theChildTypeFilter, int *theChildCount, char ***theChildren)
• ICS_API int ICS_class_list_children (const char *theClassId, int theChildTypeFilter, int theSortOption, int *theChildCount, tag_t **theChildrenTags, char ***theChildrenIds, char ***theChildrenTypes, char ***theChildrenNames, int **theInstanceCounts, int **theChildrenCounts, int **theViewCounts)
• ICS_API int ICS_WEB_class_list_children (const char *theClassId, int theChildTypeFilter, int theSortOption, int *theChildCount, char ***theChildrenUid, char ***theChildrenIds, char ***theChildrenTypes, char ***theChildrenNames, int **theInstanceCounts, int **theChildrenCounts, int **theViewCounts)
• ICS_API int ICS_class_list_children2 (const char *theClassId, int theChildTypeFilter, int theSortOption, int theOptions, int *theChildCount, tag_t **theChildrenTags, char ***theChildrenIds, char ***theChildrenTypes, char ***theChildrenNames, int **theInstanceCounts, int **theChildrenCounts, int **theViewCounts, char ***theIconImageTickets, char ***theClassImageTickets)
• ICS_API int ICS_class_describe (const char *theClassId, char **theParent, int *theType, char **theName, char **theShortName, char **theDescription, char **theUserData1, char **theUserData2, int *theOptions, int *theInstanceCount, int *theChildrenCount, int *theViewCount)
• ICS_API int ICS_class_describe_attributes (const char *theClassId, int *theCount, int **theIds, char ***theNames, char ***theShortNames, char ***theAnnotations, int **theArraySize, int **theFormat, char ***theUnit, char ***theMinValues, char ***theMaxValues, char ***theDefaultValues, char ***theDescriptions, int **theOptions)
• ICS_API int ICS_view_describe_view (tag_t view, int *nAttributes, int **uncts, int **formats, int **nonMetricFormats, char ***attributeIds, char ***attributeNames, char ***shortNames, char ***units, char ***configBefore, char ***configField, char ***configAfter, int **flags, char ***metricMin, char ***metricMax, char ***nonMetricMin, char ***nonMetricMax, char ***metricDefaultValue, char ***nonMetricDefaultValue)
• ICS_API int ICS_class_ask_icos (const char *theClassId, logical includeFromChildren, int *theCount, tag_t **theICOTags, char ***theICOUIDs, char ***theICOIds, char ***theClassIds, tag_t **theWSOTags, char ***theWSOUIDs)
• ICS_API int ICS_class_search_icos (const char *theClassId, logical searchInChildren, int theExpressionCount, int *theAttrIds, char **theAttrExpressions, int *theCount, tag_t **theICOTags, char ***theICOUIDs, char ***theICOIds, char ***theClassIds, tag_t **theWSOTags, char ***theWSOUIDs)
• ICS_API int ICS_class_is_descendant (const char *theClassId, const char *theAncestor, logical *theVerdict)
• ICS_API int ICS_class_ask_id (tag_t theClassTag, char **theClassId)
• ICS_API int ICS_class_ask_tag (const char *theClassId, tag_t *theClassTag)
• int ICS_API ICS_class_set_attr_as_reference (const char *theClassId, int theAttributeID, int theReferenceState, int theReferenceAttributeType, int theFlags, const char *theClassName, const char *theAttrName, const char *theRelationName)
• int ICS_API ICS_class_ask_attr_reference_props (const char **theClassId, int theAttributeID, int *theReferenceAttributeState, int *theReferenceAttributeType, int *theFlags, char **theClassName, char **theAttrName, char **theRelationName)
• ICS_API int ICS_class_copy (const char *theClass, const char *theNewCidIn, const char *theNewParent, int theOptions, int theChildCountIn, const char **theOldIDsIn, const char **theNewIDsIn, char **theNewCidOut, int *theChildCountOut, char ***theOldIDsOut, char ***theNewIDsOut)
• int ICS_API ICS_class_move (const char *theClassToMove, const char *theNewParent, int *theFailedCount, char ***theFailedObjects)
• ICS_API int ICS_class_move_partfamily_templates (const char *theSourceClassId, const char *theTargetClassId, int theOptions)
• ICS_API int ICS_class_share_incl_children (const char *theClass, int theSiteCount, const char **theSites, int theOptions, logical shareParentsToo)

Classification Object (ICO) related Functions

Common Return Values:

ICS_invalid_ico - The provided ICO tag is invalid

• ICS_API int ICS_ico_create (const char *theICOId, tag_t theClassifiedObjectTag, const char *theClassId, int theAttributeCount, int *theAttributeId, const char **theAttributeValues, tag_t *theICOTag)
• ICS_API int ICS_ico_create2 (const char *theICOId, tag_t theClassifiedObjectTag, const char *theClassId, int theAttributeCount, int *theAttributeId, int *theAttributeValCounts, const char ***theAttributeValues, tag_t *theICOTag)
• ICS_API int ICS_ico_remove (tag_t theICOTag)
• ICS_API int ICS_ico_find (const char *theICOId, tag_t theClassifiedObjectTag, int theOptions, int *theCount, tag_t **theICOTags)
• ICS_API int ICS_ico_search (int theExprCount, int *theAttrIds, char **theAttrExpr, int theOptions, int *theCount, tag_t **theICOTags, char ***theICOUIDs, char ***theICOIds, char ***theClassIds, tag_t **theWSOTags, char ***theWSOUIDs)
• ICS_API int ICS_ico_search_count (int theExprCount, int *theAttrIds, char **theAttrExpr, int theOptions, int *theCount)
• ICS_API int ICS_ico_ask_classified_object (tag_t theICOTag, tag_t *theClassifiedObject)
• ICS_API int ICS_ico_ask_class (tag_t theICOTag, char **theClassId)
• ICS_API int ICS_ico_ask_class_tag (tag_t theICOTag, tag_t *theClassTag)
• ICS_API int ICS_ico_ask_named_attributes (tag_t theICOTag, int theAttributeCount, int *theAttributeIds, int **theAttributeValCounts, char ****theAttributeValues)
• ICS_API int ICS_ico_set_attributes (tag_t theICOTag, int theAttributeCount, int *theAttributeIds, int *theAttributeValCounts, const char ***theAttributeValues)
• ICS_API int ICS_ico_ask_attributes (tag_t theICOTag, int *theAttributeCount, int **theAttributeIds, int **theAttributeValCounts, char ****theAttributeValues)
• ICS_API int ICS_ico_ask_attributes_optimized (tag_t theICOTag, int *theAttributeCount, int **theAttributeIds, char ***theAttributeNames, int **theAttributeValCounts, char ****theAttributeOptimizedValues, char ****theAttributeOptimizedUnits)
• ICS_API int ICS_ico_ask_all_attributes (tag_t theICOTag, int *theAttributeCount, int **theAttributeIds, int **theAttributeValCounts, char ****theAttributeValues)
• ICS_API int ICS_ico_free_attributes (int theAttributeCount, int *theAttributeIds, int *theAttributeValCounts, char ***theAttributeValues)
• ICS_API int ICS_ico_find_values (int theExprCount, int *theAttrIds, char **theAttrExpr, int theOptions, int theAttributeId, int *theCount, char ***theValues, int **theValueCounts)
• ICS_API int ICS_ico_find_values2 (int theExprCount, int *theAttrIds, char **theAttrExpr, int theOptions, int theAttributeId, int *theCount, char ***theValues, int **theValueCounts, char ***theDisplayValues)
• ICS_API int ICS_ico_move (int theCount, const tag_t *theICOTags, const char *theNewClass, int *theErrorCount, tag_t **theUnsuccessfulICOTags, int **theErrorCodes, char ***theErrorMessages)
• ICS_API int ICS_ico_reassign_to_rev (tag_t theICOTag)
• ICS_API int ICS_ico_map (tag_t theSourceICOTag, char *theTargetItemID, char *theTargetItemName, char *theTargetItemTypeName, char *theTargetItemRevID, char *theTargetItemDescription, char *theTargetClassID, int theOptions, tag_t *theNewICOTag)
• ICS_API int ICS_class_ask_mapping_sources (char *theTargetClassID, int theMappingViewType, int *theSourceClassCount, char ***theSourceClassIDs, char ***theSourceClassNames)
• ICS_API int ICS_class_ask_mapping_targets (char *theSourceClassID, int theMappingViewType, int *theTargetClassCount, char ***theTargetClassIDs, char ***theTargetClassNames)
• ICS_API int ICS_class_create_mapping (char *theSourceClassID, char *theTargetClassID, int theMappingViewType, int theAttributeCount, int *theAttributeIds, char **theAttributeMappings)
• ICS_API int ICS_class_describe_mapping (char *theSourceClassID, char *theTargetClassID, int theMappingViewType, int *theAttributeCount, int **theAttributeIds, char ***theAttributeMappings)
• ICS_API int ICS_class_delete_mapping (char *theSourceClassID, char *theTargetClassID, int theMappingViewType)
• ICS_API int ICS_ico_create_wso (const char *theClassId, int theAttrCount, int *theAttrIds, char **theAttrValues, int theOptions, tag_t *theWSO)
• ICS_API int ICS_ico_where_used (const char *theICOId, int *theCount, tag_t **theTagsWhereUsed)

Attribute Dictionary related functions

Common return values:

ICS_err_attribute_does_not_exist
ICS_err_attribute_not_unique
ICS_err_invalid_parameter
ICS_err_invalid_property
ICS_err_invalid_value
ICS_err_missing_parameter
ICS_err_object_referenced
ICS_err_property_readonly
ICS_invalid_attribute_id

• ICS_API int ICS_attribute_create (int theAttrId, const char *theAttrName, int theAttrFormat)
• ICS_API int ICS_attribute_create_unique (const char *theAttrName, int theAttrFormat, int *theAttrId)
• ICS_API int ICS_attribute_remove (int theAttrId)
• ICS_API int ICS_attribute_set_property (int theAttrId, const char *thePropertyName, const char *thePropertyValue)
• ICS_API int ICS_attribute_ask_property (int theAttrId, const char *thePropertyName, char **thePropertyValue)
• ICS_API int ICS_attribute_ask_shared_sites (int theAttrId, int *theSiteCount, char ***theSharedSites)
• ICS_API int ICS_attribute_ask_references (int theAttrId, int *theRefCount, char ***theRefs)
• ICS_API int ICS_attribute_ask_tag (int theAttrId, tag_t *theTag)
• ICS_API int ICS_attribute_ask_id (tag_t theTag, int *theAttrId)
• int ICS_API ICS_attribute_set_as_reference (int theAttributeID, int theReferenceAttributeType, int theFlags, const char *theClassName, const char *theAttrName, const char *theRelationName)
• int ICS_API ICS_attribute_ask_reference_props (int theAttributeID, int *theReferenceAttributeType, int *theFlags, char **theClassName, char **theAttrName, char **theRelationName)
• ICS_API int ICS_attribute_search (const char *theQuery, int theSortAttrID, int theOptions, int *theCount, tag_t **theTags, int **theIDs, char ***theNames)
• ICS_API int ICS_attribute_convert_attribute_values (const char *theInputUnit, const char *theInputValue, const char *theOutputUnit, int theOutputAttributeFormat, char **theOutputValue)

KeyLOV functions

Common return values:

ICS_err_invalid_keylov_id
ICS_err_kelov_does_not_exist
ICS_err_keylov_key_not_unique
ICS_err_keylov_key_unknown
ICS_err_object_referenced

• ICS_API int ICS_keylov_create (const char *theKeyLOVId, const char *theKeyLOVName, int theOptions, int theCount, char **theKeys, char **theValues)
• ICS_API int ICS_keylov_create_unique (const char *theKeyLOVName, int theOptions, int theCount, char **theKeys, char **theValues, char **theNewId)
• ICS_API int ICS_keylov_remove (const char *theKeyLOVId)
• ICS_API int ICS_keylov_insert_entries (const char *theKeyLOVId, const char *theInsertKey, int theCount, char **theKeys, char **theValues)
• ICS_API int ICS_keylov_remove_entries (const char *theKeyLOVId, int theCount, char **theKeys)
• ICS_API int ICS_keylov_set_options (const char *theKeyLOVId, int theOptions)
• ICS_API int ICS_keylov_describe (const char *theKeyLOVId, char **theKeyLOVName, int *theOptions, int *theCount, char ***theKeys, char ***theValues, char **theOwningSite, int *theSharedSiteCount, char ***theSharedSites)
• ICS_API int ICS_keylov_ask_shared_sites (const char *theKeyLOVId, int *theSiteCount, char ***theSharedSites)
• ICS_API int ICS_keylov_ask_references (const char *theKeyLOVId, int *theRefCount, int **theRefs)
• ICS_API int ICS_keylov_ask_tag (const char *theKeyLOVId, tag_t *theTag)
• ICS_API int ICS_keylov_ask_id (tag_t theTag, char **theKeyLOVId)
• ICS_API int ICS_keylov_search (const char *theQuery, int theSortAttrID, int theOptions, int *theCount, tag_t **theTags, char ***theIDs, char ***theNames)
• ICS_API int ICS_keylov_deprecate_entries (const char *key_lov_id, int n_lov_value_keys, char **lov_value_keys, logical *deprecate_status)
• ICS_API int ICS_keylov_get_keylov (const char *key_lov_id, char **key_lov_name, int *options, int *n_lov_entries, char ***lov_keys, char ***lov_values, logical **deprecated_staus, char **owning_site, int *n_shared_sites, char ***shared_sites)
• ICS_API int ICS_keylov_is_entry_deprecated (const char *key_lov_id, const char *lov_value_key, logical *deprecate)
• ICS_API int ICS_ico_property_isLocalizable (tag_t theICOTag, const int theAttributeId, logical *isLocalizable)
• ICS_API int ICS_ico_ask_localizable_properties (tag_t theICOTag, int *theAttributeCount, int **theAttributeIds)
• ICS_API int ICS_ico_set_localized_value_strings (tag_t theICOTag, int noAttributes, int *theAttributeIds, const char *locale, int *theAttributeValCount, char ***theAttributeValues, char **localization_statuses, logical isMaster)
• ICS_API int ICS_ico_ask_localized_value_strings (tag_t theICOTag, const int theAttributeId, const char *locale, int *theAttributeValCount, char ***theAttributeValues, char **localization_statuses, logical *isMaster)
• ICS_API logical ICS_is_keylov (tag_t theTag)
• ICS_API logical ICS_is_attribute (tag_t theTag)
• ICS_API logical ICS_is_class (tag_t theTag)
• ICS_API logical ICS_is_view (tag_t theTag)
• ICS_API logical ICS_is_subclass (tag_t theTag)
• ICS_API logical ICS_is_ico (tag_t theTag)
• ICS_API int ICS_sml_import (char *file, char *importMode)
• ICS_API int ICS_ico_auto_compute (const char *theICOid, const char *theClassId, const char *theViewId, const int theUnitSystem, tag_t theWsoTag, const int theMode, const int theAttributeCount, const int *theAttributeIds, const int *theAttrValueCounts, const char ***theAttributeValues, const int *theAttributeLengths, const char **theAttributeUnits, const int *theAttributeFlags, const logical *theModifiedFlag, int *theAutoComputedCount, int **theAutoComputedIds, int **theAutoComputedValueCounts, char ****theAutoComputedValues, int **theAutoComputedLengths, char ***theAutoComputedUnits, int **theAutoComputedFlags)
• ICS_API int ICS_auto_compute_register_attrs (const char *class_id, const char *view_id, const int size, ICS_auto_compute_attr_t *auto_compute_attrs, logical toOverride)
• ICS_API int ICS_auto_compute_set_attr_values (const int theAttributeId, const int theAttrValueCount, const char **theAttributeValues, const char *theUnit)
• ICS_API int ICS_auto_compute_set_attr_value (const int theAttributeId, const char *theAttributeValue, const char *theUnit)
• ICS_API int ICS_auto_compute_set_attr_prop (const int theAttributeId, const int thePropType, const logical theValue)
• ICS_API int ICS_auto_compute_get_attr_values (const int attributeId, int *valueCount, char ***value, int *format, char **unit)
• ICS_API int ICS_auto_compute_get_attr_value (const int attributeId, char **value, int *format, char **unit)
• ICS_API int ICS_auto_compute_get_attr_prop (const int theAttributeId, int thePropType, logical *theValue)
• ICS_API int ICS_check_privilege (tag_t theInstanceTag, const char *thePrivilegeName, logical *isGrantedExt)
• ICS_API int ICS_class_remove_hierarchy (const char *theClassId, logical theRecurseOption, logical theViewsOption, logical theIcosOption, logical theWSOOption, logical theChildrenOnlyOption, logical theIgnoreOption, logical thePurgeAttrs, logical thePurgeKeyLOV, int *theFailedObjectsCount, char **theFailedObjects)
• ICS_API int ICS_class_search_libraries (int theNumSearchStrings, const char **theSearchStrings, int *theCount, tag_t **theTags, char ***theTypes, char ***theCIDs, char ***theParentCIDs, char ***theNames, int **theInstancesCounts, int **theChildCounts, char ***theLibraries)
• ICS_API int ICS_class_ask_parentinfo (int theNumCIDs, const char **theChildCIDs, int *theParentCount, tag_t **theParentTags, char ***theParentTypes, char ***theParentCIDs, char ***theNames, int **theInstancesCounts, int **theChildCounts)