Data Structures
struct	ICS_auto_compute_attr_s

struct	ICS_keylov_descriptor_s

struct	ICS_view_attribute_descriptor_s

struct	ICS_view_descriptor_s

Macros
#define	ICS_ADD_ATTRBIUTES_FROM_PARENT ( 1 << 6 )

#define	ICS_ADD_ATTRIBUTE_MOVE_UP ( 1 << 0 )

#define	ICS_CLASS_USE_VIEW_IMAGE ( 1 << 0 )

#define	ICS_COPY_INHERITED_ATTRIBUTES ( 1 << 2 )

#define	ICS_COPY_THIS_CLASS_ONLY ( 1 << 4 )

#define	ICS_DBL_STR_SIZE 64

#define	ICS_DEFAULT_VIEW "defaultView"

#define	ICS_DRY_RUN ( 1 << 3 )

#define	ICS_ICO_IGNORE_WRITE_PROTECTION_ERRORS ( 1 << 0 )

#define	ICS_IGNORE_MAPPING_ERRORS ( 1 )

#define	ICS_IGNORE_UNREADABLE_CHILDREN ( 1 << 1 )

#define	ICS_MAX_CLASS_ATTR_SIZE 10

#define	ICS_REFATTR_CLASS_LOCAL 2

#define	ICS_REFATTR_CLASSIFIED_OBJECT 1

#define	ICS_REFATTR_ICO 4

#define	ICS_REFATTR_INHERITED 1

#define	ICS_REFATTR_ITEM_ATTR 1

#define	ICS_REFATTR_MASTERFORM 2

#define	ICS_REFATTR_PROPERTY ( 1 << 1 )

#define	ICS_REFATTR_RELATED_OBJECT 3

#define	ICS_SEARCH_CASE_INSENSITIVE ( 1 << 1 )

#define	ICS_SEARCH_IN_BOTH_UNIT_SYSTEMS ( 1 << 3 )

#define	ICS_SEARCH_IN_OTHER_UNIT_SYSTEM ( 1 << 4 )

#define	ICS_SEARCH_ORDER_BY_ID ( 1 << 2 )

#define	ICS_SEARCH_THIS_CLASS_ONLY ( 1 << 0 )

#define	ICS_SHARED_IS_ERROR ( 1 << 5 )

#define	ICS_SUBCLASSES_TO_STORAGE_CLASSES ( 1 )

Typedefs
typedef struct ICS_auto_compute_attr_s	ICS_auto_compute_attr_t

typedef int(*	ICS_auto_compute_function_t )(tag_t, int)

typedef enum ICS_auto_compute_mode_s	ICS_auto_compute_mode_e

typedef enum ICS_child_type_s	ICS_child_type_e

typedef enum ICS_class_attr_flags_s	ICS_class_attr_flags_e

typedef enum ICS_class_flags_s	ICS_class_flags_e

typedef enum ICS_class_properties_s	ICS_class_properties_e

typedef enum ICS_class_share_type_s	ICS_class_share_type_e

typedef struct ICS_keylov_descriptor_s *	ICS_keylov_descriptor_p_t

typedef struct ICS_keylov_descriptor_s	ICS_keylov_descriptor_t

typedef enum ICS_list_children_options_s	ICS_list_children_options_e

typedef enum ICS_unit_system_s	ICS_unit_system_e

typedef enum ICS_view_type_s	ICS_view_type_e

Enumerations
enum	ICS_auto_compute_mode_s { AUTOCOMPUTE_MODE_load = 0, AUTOCOMPUTE_MODE_create = 1, AUTOCOMPUTE_MODE_edit = 2 }

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_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 << 30) }

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_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 }

enum	ICS_unit_system_s { UNIT_SYSTEM_unspecified = -1, UNIT_SYSTEM_metric = 0, UNIT_SYSTEM_english = 1 }

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 }

Variables
int	ICS_auto_compute_attr_s::attr_deps [ICS_MAX_CLASS_ATTR_SIZE]

int	ICS_keylov_descriptor_s::attribute_id

int	ICS_view_descriptor_s::attributeCount

ICS_view_attribute_descriptor_p_t	ICS_view_descriptor_s::attributes

int	ICS_auto_compute_attr_s::auto_compute_attr_id

ICS_auto_compute_function_t	ICS_auto_compute_attr_s::auto_compute_function

char *	ICS_view_descriptor_s::classId

char *	ICS_view_attribute_descriptor_s::configOptions

char *	ICS_view_attribute_descriptor_s::defautValue

logical *	ICS_keylov_descriptor_s::deprecation_status

int	ICS_keylov_descriptor_s::flags

int	ICS_view_attribute_descriptor_s::flags

int	ICS_view_attribute_descriptor_s::format

int	ICS_view_attribute_descriptor_s::id

char *	ICS_keylov_descriptor_s::keylov_id

char *	ICS_keylov_descriptor_s::keylov_name

tag_t	ICS_keylov_descriptor_s::keylov_tag

char **	ICS_keylov_descriptor_s::keys

char *	ICS_view_attribute_descriptor_s::maxValue

char *	ICS_view_attribute_descriptor_s::minValue

char *	ICS_view_attribute_descriptor_s::name

char *	ICS_view_descriptor_s::name

int	ICS_auto_compute_attr_s::num_attr_deps

int	ICS_keylov_descriptor_s::num_shared_sites

int	ICS_view_descriptor_s::options

char *	ICS_keylov_descriptor_s::owning_site

char *	ICS_view_attribute_descriptor_s::postConfigOptions

char *	ICS_view_attribute_descriptor_s::preConfigOptions

char *	ICS_keylov_descriptor_s::selected_key

char **	ICS_keylov_descriptor_s::shared_sites

char *	ICS_view_attribute_descriptor_s::shortName

int	ICS_view_descriptor_s::type

char *	ICS_view_attribute_descriptor_s::unit

char *	ICS_view_descriptor_s::unitSystem

char *	ICS_view_attribute_descriptor_s::userData1

char *	ICS_view_descriptor_s::userData1

char *	ICS_view_attribute_descriptor_s::userData2

char *	ICS_view_descriptor_s::userData2

int	ICS_keylov_descriptor_s::value_count

char **	ICS_keylov_descriptor_s::values

char *	ICS_view_descriptor_s::viewId

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_ids (unsigned int theCount, const tag_t theClasses, char **theClassIds)

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)

ICS_API int	ICS_class_ask_attr_dep_config (tag_t class_tag, int attr_count, int attr_ids, char dependency_attributes, char *dependency_configurations)

ICS_API int	ICS_class_ask_attr_dep_config_by_id (const char class_id, int attr_count, int attr_ids, char dependency_attributes, char **dependency_configurations)

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)

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)

ICS_API int	ICS_class_attr_ask_dep_keylovs (const char class_id, int selected_attr, const char selected_value, int ui_attr_count, const int ui_attr_ids, const char ui_attr_values, int changed_attr_count, ICS_keylov_descriptor_p_t **changed_keylovs)

ICS_API int	ICS_ask_common_attributes_used_as_facets (int class_ids_count, const char *class_ids, int attribute_count, int attribute_ids, int attribute_metric_formats, int attribute_non_metric_formats, char *attribute_names)

ICS_API int	ICS_ask_indexable_attributes (int attribute_count, int attribute_ids, int attribute_metric_formats, int attribute_non_metric_formats, char attribute_names, char attribute_metric_units, char **attribute_non_metric_units)

ICS_API int	ICS_ask_dependent_classified_WSO (const tag_t theWSOTag, tag_t *theDependentClassifiedWSO)

Detailed Description

Common return values:

ICS_err_attribute_does_not_exist
ICS_err_attribute_not_unique
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_value
ICS_err_invalid_property
ICS_err_invalid_reference_type
ICS_err_parent_is_not_shared

Macro Definition Documentation

#define ICS_ADD_ATTRBIUTES_FROM_PARENT ( 1 << 6 )

Add attributes from new parent class to copy of view

Definition at line 306 of file ics2.h.

#define ICS_ADD_ATTRIBUTE_MOVE_UP ( 1 << 0 )

if this option is passed to the function ICS_class_add_attributes() the function will try to remove the atrribute from any descendant and update the instances accordingly

Definition at line 321 of file ics2.h.

#define ICS_CLASS_USE_VIEW_IMAGE ( 1 << 0 )

Definition at line 323 of file ics2.h.

#define ICS_COPY_INHERITED_ATTRIBUTES ( 1 << 2 )

Copy the class including its inherited attributes.

Definition at line 289 of file ics2.h.

#define ICS_COPY_THIS_CLASS_ONLY ( 1 << 4 )

Copy the class only, not the hierarchy.

Definition at line 299 of file ics2.h.

#define ICS_DBL_STR_SIZE 64

Definition at line 79 of file ics2.h.

#define ICS_DEFAULT_VIEW "defaultView"

Definition at line 309 of file ics2.h.

#define ICS_DRY_RUN ( 1 << 3 )

Don't actually copy the class / migrate the subclasses, only do the initial checks.

Definition at line 294 of file ics2.h.

#define ICS_ICO_IGNORE_WRITE_PROTECTION_ERRORS ( 1 << 0 )

Definition at line 75 of file ics2.h.

#define ICS_IGNORE_MAPPING_ERRORS ( 1 )

Don't stop moving part family templates if source attributes are mapped that do not exist in the target.

Definition at line 314 of file ics2.h.

#define ICS_IGNORE_UNREADABLE_CHILDREN ( 1 << 1 )

Copy the class even if it has unreadable children.

Definition at line 284 of file ics2.h.

#define ICS_MAX_CLASS_ATTR_SIZE 10

Definition at line 77 of file ics2.h.

#define ICS_REFATTR_CLASS_LOCAL 2

Specifies that a Classification class attribute uses the Reference Attribute definition that is set locally in the Classification class.

Definition at line 244 of file ics2.h.

#define ICS_REFATTR_CLASSIFIED_OBJECT 1

Reference Attribute type "classified object" (property or attribute of the classified object)

Definition at line 249 of file ics2.h.

#define ICS_REFATTR_ICO 4

Reference Attribute type "ico" (attribute of a different ico).

Definition at line 264 of file ics2.h.

#define ICS_REFATTR_INHERITED 1

Specifies that a Classification class attribute uses the Reference Attribute definition that is set in the Classification dictionary.

Definition at line 238 of file ics2.h.

#define ICS_REFATTR_ITEM_ATTR 1

The Reference Attribute value is read from the classified item OR (if the classified object is an item revision) from the item of the classified item revision

Definition at line 270 of file ics2.h.

#define ICS_REFATTR_MASTERFORM 2

Reference Attribute type "master form" (property or attribute of the master form of the classified object).

Definition at line 254 of file ics2.h.

#define ICS_REFATTR_PROPERTY ( 1 << 1 )

The Reference Attribute specifies a TC property (not a POM attribute)

Definition at line 274 of file ics2.h.

#define ICS_REFATTR_RELATED_OBJECT 3

Reference Attribute type "related object" (property or attribute of an object that is related to the classified object).

Definition at line 259 of file ics2.h.

#define ICS_SEARCH_CASE_INSENSITIVE ( 1 << 1 )

This option allows to specify that strings will be searched case insensitive. Case sensitive is the default.

Definition at line 49 of file ics2.h.

#define ICS_SEARCH_IN_BOTH_UNIT_SYSTEMS ( 1 << 3 )

This value can be used as a value for theOptions parameter in ICS_ico_search(). This option specifies that the search result will contain metric and non-metric instances. By default only metric or non-metric will be found depending on the active unit system.

Definition at line 65 of file ics2.h.

#define ICS_SEARCH_IN_OTHER_UNIT_SYSTEM ( 1 << 4 )

This value can be used as a value for theOptions parameter in ICS_ico_search(). This option specifies that the search result will contain only instances of the other unit system than the active one.

Definition at line 71 of file ics2.h.

#define ICS_SEARCH_ORDER_BY_ID ( 1 << 2 )

This value can be used as a value for theOptions parameter in ICS_ico_search(). This option specifies that the search result is sorted by the object id. The default behaviour is, that the search result is sorted by attributes, if attributes are given. If no attributes are given, the search result is sorted by the object id by default.

Definition at line 58 of file ics2.h.

#define ICS_SEARCH_THIS_CLASS_ONLY ( 1 << 0 )

This value can be used as a value for theOptions parameter in ICS_ico_search(). In case a class id is passed in as a search criteria, this option will restrict the search to the specified class only. The default behavior will searach in all classes below the given one as well.

Definition at line 43 of file ics2.h.

#define ICS_SHARED_IS_ERROR ( 1 << 5 )

Definition at line 301 of file ics2.h.

#define ICS_SUBCLASSES_TO_STORAGE_CLASSES ( 1 )

Internal use only.

Definition at line 279 of file ics2.h.

Typedef Documentation

typedef struct ICS_auto_compute_attr_s ICS_auto_compute_attr_t

typedef int(* ICS_auto_compute_function_t)(tag_t, int)

Definition at line 101 of file ics2.h.

typedef enum ICS_auto_compute_mode_s ICS_auto_compute_mode_e

Defines the list of available auto compute modes

typedef enum ICS_child_type_s ICS_child_type_e

Defines the list of availabe types for ICS_ask_children

typedef enum ICS_class_attr_flags_s ICS_class_attr_flags_e

Defines valid values for the flags property of the class attributes

typedef enum ICS_class_flags_s ICS_class_flags_e

Defines valid values which can be used for theClassFlags parameter of ICS_class_create

typedef enum ICS_class_properties_s ICS_class_properties_e

typedef enum ICS_class_share_type_s ICS_class_share_type_e

ICS_class_share_type_e defines the list of availabe types for ICS_class_share_incl_children

typedef struct ICS_keylov_descriptor_s * ICS_keylov_descriptor_p_t

typedef struct ICS_keylov_descriptor_s ICS_keylov_descriptor_t

Defines the structure to hold configured KeyLOV description for a specific class attribute.

typedef enum ICS_list_children_options_s ICS_list_children_options_e

Defines the options for the ITK function ICS_class_list_children2.

typedef enum ICS_unit_system_s ICS_unit_system_e

Defines the list of possible values for the unit system

typedef struct ICS_view_attribute_descriptor_s * ICS_view_attribute_descriptor_p_t

typedef struct ICS_view_attribute_descriptor_s ICS_view_attribute_descriptor_t

typedef struct ICS_view_descriptor_s * ICS_view_descriptor_p_t

typedef struct ICS_view_descriptor_s ICS_view_descriptor_t

typedef enum ICS_view_type_s ICS_view_type_e

Defines the list of available view types

Enumeration Type Documentation

enum ICS_auto_compute_mode_s

Defines the list of available auto compute modes

Enumerator
AUTOCOMPUTE_MODE_load	manipulate attribute properties based on the input values and the custom logic in place This mode will not manipulate any attribute values as this is used during loading, and the values are already available in the database
AUTOCOMPUTE_MODE_create	perform all the operations in the custom logic to manipulate attribute values as well as properties based on the default values
AUTOCOMPUTE_MODE_edit	perform all the operations in the custom logic to manipulate attribute values as well as properties based on the updated values

Definition at line 136 of file ics2.h.

enum ICS_child_type_s

Defines the list of availabe types for ICS_ask_children

Enumerator
ICS_CHILD_type_group
ICS_CHILD_type_class
ICS_CHILD_type_view	All type of views including subclasses
ICS_CHILD_type_view_no_subclass	Real views only
ICS_CHILD_type_subclass	Subclasses only
ICS_CHILD_type_template_view	Template views only
ICS_CHILD_type_all

Definition at line 200 of file ics2.h.

enum ICS_class_attr_flags_s

Defines valid values for the flags property of the class attributes

Enumerator
CLASS_ATTR_vla
CLASS_ATTR_external_vla
CLASS_ATTR_mandatory
CLASS_ATTR_protected
CLASS_ATTR_unique
CLASS_ATTR_propagated
CLASS_ATTR_localValue
CLASS_ATTR_reference
CLASS_ATTR_auto_computed
CLASS_ATTR_hidden
CLASS_ATTR_localizable
CLASS_ATTR_use_as_facet

Definition at line 159 of file ics2.h.

enum ICS_class_flags_s

Defines valid values which can be used for theClassFlags parameter of ICS_class_create

Enumerator
CLASS_flag_englishUnitBase
CLASS_flag_isGroup
CLASS_flag_unit_system_both
CLASS_flag_isStorrageClass
CLASS_flag_isAssembly

Definition at line 86 of file ics2.h.

enum ICS_class_properties_s

Enumerator
CLASS_prop_id	G
CLASS_prop_parents	G
CLASS_prop_name	GS

Definition at line 94 of file ics2.h.

enum ICS_class_share_type_s

ICS_class_share_type_e defines the list of availabe types for ICS_class_share_incl_children

Enumerator
ICS_CLASS_SHARE_child_classes
ICS_CLASS_SHARE_default_views
ICS_CLASS_SHARE_specific_views	user, group, and role views (specified in the preference ICS_share_viewtypes)
ICS_CLASS_SHARE_subclasses	subclasses only
ICS_CLASS_SHARE_views
ICS_CLASS_SHARE_all

Definition at line 213 of file ics2.h.

enum ICS_list_children_options_s

Defines the options for the ITK function ICS_class_list_children2.

Enumerator
ICS_CHILDREN_NO_COUNT
ICS_CHILDREN_INSTANCE_COUNT	Get the instance count for each child
ICS_CHILDREN_CHILD_COUNT	Get the children count for each child
ICS_CHILDREN_VIEW_COUNT	Get the view count
ICS_CHILDREN_ALL_COUNT

Definition at line 225 of file ics2.h.

enum ICS_unit_system_s

Defines the list of possible values for the unit system

Enumerator
UNIT_SYSTEM_unspecified
UNIT_SYSTEM_metric
UNIT_SYSTEM_english

Definition at line 150 of file ics2.h.

enum ICS_view_type_s

Defines the list of available view types

Enumerator
VIEW_type_subclass	Leagacy type view where instances are stored in
VIEW_type_defaultView	Default view with fixed Name "defaultView" will be created automatically if it does not exist
VIEW_type_user
VIEW_type_group
VIEW_type_role	Currently not supported
VIEW_type_project
VIEW_type_table
VIEW_type_indexing
VIEW_type_template_view
VIEW_type_mapping_internal
VIEW_type_mapping_user
VIEW_type_nxlib_search_criteria
VIEW_type_nxlib_search_result
VIEW_type_nxlib_retrieve

Definition at line 179 of file ics2.h.

Function Documentation

ICS_API int ICS_ask_common_attributes_used_as_facets	(	int	class_ids_count,
		const char **	class_ids,
		int *	attribute_count,
		int **	attribute_ids,
		int **	attribute_metric_formats,
		int **	attribute_non_metric_formats,
		char ***	attribute_names
	)

Retrieves the information about the 'common' attributes for the input classes.

Deprecated:: This function is for internal use only and will be removed from TC12.

The attributes searched must:

belong to the 'Search Index View'
have 'Used as facet' flag set

Returns

ITK_ok on success
No results (attribute count equals to 0) will be returned in case of invalid inputs.

Parameters

class_ids_count	(I) The Class ID count.
class_ids	(I) The Class IDs for which the attributes are to be found.
attribute_count	(O) The count of the matching attributes found.
attribute_ids	(OF) attribute_count The IDs of the matching attributes.
attribute_metric_formats	(OF) attribute_count The metric format values of the attributes. The attribute format defines the type of value that can be stored for the attribute. For additional information about the attribute format definition, refer ICS_describe_format.
attribute_non_metric_formats	(OF) The non-metric format values of the attributes.
attribute_names	(OF) attribute_count The attribute names.The output string array is SM-packed, hence should be freed by calling MEM_free on the container only.

ICS_API int ICS_ask_dependent_classified_WSO	(	const tag_t	theWSOTag,
		tag_t *	theDependentClassifiedWSO
	)

Retrieves the dependent classified workspace object.

Returns

ITK_ok on success
SML_ERR_MISSING_PARAMETER in case of invalid input.

ICS_API int ICS_ask_indexable_attributes	(	int *	attribute_count,
		int **	attribute_ids,
		int **	attribute_metric_formats,
		int **	attribute_non_metric_formats,
		char ***	attribute_names,
		char ***	attribute_metric_units,
		char ***	attribute_non_metric_units
	)

Retrieves the information about the "indexable" attributes in the system.
The attributes searched and returned must belong to the 'Search Index' view.

Deprecated:: This function is for internal use only and will be removed from TC12.

Returns

ITK_ok on success
POM enquiry related error otherwise.

Parameters

attribute_count	(O) The count of the matching attributes found.
attribute_ids	(OF) attribute_count The IDs of the matching attributes.
attribute_metric_formats	(OF) attribute_count The metric format values of the attributes. The attribute format defines the type of value that can be stored for the attribute. For additional information about the attribute format definition, refer ICS_describe_format.
attribute_non_metric_formats	(OF) The non-metric format values of the attributes.
attribute_names	(OF) attribute_count The attribute names.The output string array is packed, hence should be freed by calling MEM_free on the container only.
attribute_metric_units	(OF) attribute_count The metric unit value for attributes.The output string array is packed, hence should be freed by calling MEM_free on the container only.
attribute_non_metric_units	(OF) attribute_count The non metric unit value for attributes.The output string array is packed, hence should be freed by calling MEM_free on the container only.

ICS_API int ICS_attribute_ask_id	(	tag_t	theTag,
		int *	theAttrId
	)

Returns the Attribute Id for the given tag

Parameters

theTag	(I) The Tag
theAttrId	(O) The Attribute Id

ICS_API int ICS_attribute_ask_property	(	int	theAttrId,
		const char *	thePropertyName,
		char **	thePropertyValue
	)

Returns the value for the specified property of an existing attribute

Parameters

theAttrId	(I) The unique identifier of the attribute
thePropertyName	(I) The specified property. For possible values see ICS_attribute_set_property and additionally: ID FORMAT1 FORMAT2 COMMENT
thePropertyValue	(OF) The value of the given property

int ICS_API ICS_attribute_ask_reference_props	(	int	theAttributeID,
		int *	theReferenceAttributeType,
		int *	theFlags,
		char **	theClassName,
		char **	theAttrName,
		char **	theRelationName
	)

Call this function to ask the reference attribute properties of an attribute given by its attribute ID in the Classification dictionary.
Returns ICS_invalid_attribute_id if no attribute with the given attribute ID exists.

Parameters

theAttributeID	(I) Attribute ID of the attribute from which you want to read the reference attribute definition. The parameter must specify an existing attribute ID.
theReferenceAttributeType	(O) One of the following values: 0 - normal attribute ICS_REFATTR_CLASSIFIED_OBJECT - a property or attribute of the classified object ICS_REFATTR_MASTERFORM - a property or attribute of the Masterform of the classified item or item revision ICS_REFATTR_RELATED_OBJECT - a property or attribute of an object that is related (via an IMAN Relation) to the classified object ICS_REFATTR_ICO - an attribute of a different ICO
theFlags	(O) 0 or a combination of: ICS_REFATTR_PROPERTY: this flag is set if an IMAN property is defined - if it is not set then a POM attribute is defined ICS_REFATTR_ITEM_ATTR: this flag is set if a reference attribute of an item is defined. This means that if the classified object is an item revision the reference attribute value will be read from the item (or its masterform / an object that is related to the item) of the classified item revision.
theClassName	(OF) Depending on theReferenceAttributeType this parameter specifies one the following values: ICS_REFATTR_CLASSIFIED_OBJECT: Classification class where the referenced ICO is stored. ICS_REFATTR_MASTERFORM: IMAN Type of the classified object / its item if ICS_REFATTR_ITEM_ATTR is set in the flags (the parameter may be NULL to specify that different IMAN Types are allowed) ICS_REFATTR_CLASSIFIED_OBJECT: POM Class / IMAN Type of the classified object / its item if ICS_ITEM_ATTR is set in the flags (the parameter may be NULL to specify that different IMAN Types are allowed) ICS_REFATTR_RELATED_OBJECT: POM Class / IMAN Type of the related object (The second alternatives are valid if ICS_REFATTR_PROPERTY is set in theFlags)
theAttrName	(OF) Depending on theReferenceAttributeType this parameter specifies the following value: ICS_REFATTR_CLASSIFIED_OBJECT: name of the POM Attribute / IMAN Property where the value of the reference attribute will be read from ICS_REFATTR_MASTERFORM: name of the POM Attribute / IMAN Property where the value of the reference attribute will be read from (the POM Attribute / IMAN Property is found in the Masterform of the classified object / its item) ICS_REFATTR_CLASSIFIED_OBJECT: Attribute ID of the attribute that will be displayed as "key attribute" of the referenced ICO ICS_REFATTR_RELATED_OBJECT: name of the POM Attribute / IMAN Property where the value of the reference attribute will be read from (this POM Attribute / IMAN Property is found in the related object) (The second alternatives are valid if ICS_REFATTR_PROPERTY is set in theFlags)
theRelationName	(OF) If theReferenceAttributeType is ICS_REFATTR_RELATED_OBJECT: name of the IMAN Relation with which the related object is attached to the classified object (may be NULL to specify that any relation is possible). For all other Reference Attribute types this parameter is set to NULL.

ICS_API int ICS_attribute_ask_references	(	int	theAttrId,
		int *	theRefCount,
		char ***	theRefs
	)

Returns all classes where this attribute is used

Parameters

theAttrId	(I) The unique identifier of the attribute
theRefCount	(O) The number of classes where this attribute is used
theRefs	(OF) theRefCount The classes where this attribute is used

ICS_API int ICS_attribute_ask_shared_sites	(	int	theAttrId,
		int *	theSiteCount,
		char ***	theSharedSites
	)

Returns the count and the values of the shared sites

Parameters

theAttrId	(I) The unique identifier of the attribute
theSiteCount	(O) The number of shared sites
theSharedSites	(OF) theSiteCount The shared sites. Need to be freed using MEM_free

ICS_API int ICS_attribute_ask_tag	(	int	theAttrId,
		tag_t *	theTag
	)

Returns the tag for the given Attribute Id

Parameters

theAttrId	(I) The Attribute Id
theTag	(O) The Tag

ICS_API int ICS_attribute_convert_attribute_values	(	const char *	theInputUnit,
		const char *	theInputValue,
		const char *	theOutputUnit,
		int	theOutputAttributeFormat,
		char **	theOutputValue
	)

This function convert the attribute value from one unit to another unit.

Parameters

theInputUnit	(I) The input unit
theInputValue	(I) The input value
theOutputUnit	(I) The output unit
theOutputAttributeFormat	(I) The attribute format
theOutputValue	(OF)The output value

ICS_API int ICS_attribute_create	(	int	theAttrId,
		const char *	theAttrName,
		int	theAttrFormat
	)

Creates a new attribute with the given name and format.

Parameters

theAttrId	(I) Unique identifier of the attribute. A value between -999 to 999 is not possible.
theAttrName	(I) Optional name of the attribute
theAttrFormat	(I) The format of the attribute. For additional information about the attribute format definition refer ICS_describe_format.

ICS_API int ICS_attribute_create_unique	(	const char *	theAttrName,
		int	theAttrFormat,
		int *	theAttrId
	)

ICS_attribute_creates a new unique attribute with the given name and format.

Parameters

theAttrName	(I) The Attribute Name
theAttrFormat	(I) The Format (!= 0) for the attribute
theAttrId	(O) the newly created unique attribute id (>= 1000)

ICS_API int ICS_attribute_remove ( int theAttrId )

Removes the attribute identified by theAttrId permanently from the database

Parameters

theAttrId (I) The unique identifier of the attribute

ICS_API int ICS_attribute_search	(	const char *	theQuery,
		int	theSortAttrID,
		int	theOptions,
		int *	theCount,
		tag_t **	theTags,
		int **	theIDs,
		char ***	theNames
	)

This function returns all dictionary attributes that match the given search criteria values.
The input to all output parameter except theCount can be NULL to indicate that the output should not be returned.

Parameters

theQuery	(I) the query: (unct) (op) (value), e.g. "-401 = attributename". Supported values for unct are: -400 Attribute ID -401 Name -402 Short Name -403 Default Annotation -404 Format 1 -405 Unit 1 -406 Format 2 -407 Unit 2
theSortAttrID	(I) specifies the ID to be used for sorting the result, Possible value is one of the supported values for unct in theQuery
theOptions	(I) search options, supported is ICS_SEARCH_CASE_INSENSITIVE to search without case sensitivity, when searching for IDs -401, -402, -403, -405 and -407
theCount	(O) Number of attributes found
theTags	(OF) theCount Tags of the attributes found
theIDs	(OF) theCount Ids of the attributes
theNames	(OF) theCount Names of the attributes

int ICS_API ICS_attribute_set_as_reference	(	int	theAttributeID,
		int	theReferenceAttributeType,
		int	theFlags,
		const char *	theClassName,
		const char *	theAttrName,
		const char *	theRelationName
	)

Call this function to define an attribute - given by its attribute ID in the Classification dictionary

as reference attribute.
Returns ITK_ok or different kinds of errors, for example trying to set a Reference Attribute type that does not exist.

Note: Use 0 as theReferenceAttributeType to define the attribute to be a "normal" attribute (non reference attribute).

Parameters

theAttributeID	(I) Attribute ID of the attribute that you want to define as reference attribute. The parameter must specify an existing attribute ID.
theReferenceAttributeType	(I) One of the following values: 0 - non reference attribute (in this case the subsequent parameters are not used) ICS_REFATTR_CLASSIFIED_OBJECT - a property or attribute of the classified object ICS_REFATTR_MASTERFORM - a property or attribute of the Masterform of the classified item or item revision ICS_REFATTR_RELATED_OBJECT - a property or attribute of an object that is related (via an IMAN Relation) to the classified object ICS_REFATTR_ICO - an attribute of a different ICO
theFlags	(I) Set to 0 or any combination of: ICS_REFATTR_PROPERTY: set this flag if you want to define an IMAN property - do not set it if you want to define a POM Attribute ICS_REFATTR_ITEM_ATTR: set this flag if you want to define a reference attribute of an item. This means that if the classified object is an item revision the reference attribute value will be read from the item (or its masterform / an object that is related to the item) of the classified item revision.
theClassName	(I) Depending on theReferenceAttributeType specify the following value: ICS_REFATTR_CLASSIFIED_OBJECT: Classification class where the referenced ICO is stored (parameter must not be NULL). ICS_REFATTR_MASTERFORM: IMAN Type of the classified object / its item if ICS_REFATTR_ITEM_ATTR is set in the flags (the parameter may be NULL to specify that different IMAN Types are allowed) ICS_REFATTR_CLASSIFIED_OBJECT: POM Class / IMAN Type of the classified object (its item if ICS_REFATTR_ITEM_ATTR is set in the flags) (the parameter may be NULL to specify that different IMAN Types are allowed) ICS_REFATTR_RELATED_OBJECT: POM Class / IMAN Type of the related object (the parameter must not be NULL) (The second alternatives are valid if ICS_REFATTR_PROPERTY is specified in parameter theFlags)
theAttrName	(I) This parameter must not be NULL. Depending on theReferenceAttributeType specify the following value: ICS_REFATTR_CLASSIFIED_OBJECT: name of the POM Attribute / IMAN Property where the value of the reference attribute will be read from ICS_REFATTR_MASTERFORM: name of the POM Attribute / IMAN Property where the value of the reference attribute will be read from (the POM Attribute / IMAN Property is found in the Masterform of the classified object / its item) ICS_REFATTR_CLASSIFIED_OBJECT: Attribute ID of the attribute that will be displayed as "key attribute" of the referenced ICO ICS_REFATTR_RELATED_OBJECT: name of the POM Attribute / IMAN Property where the value of the reference attribute will be read from (this POM Attribute / IMAN Property is found in the related object) (The second alternatives are valid if ICS_PROPERTY is specified in theFlags)
theRelationName	(I) If theReferenceAttributeType is ICS_REFATTR_RELATED_OBJECT then this parameter specifies the name of the IMAN Relation with which the related object is attached to the classified object (may be NULL to specify that any relation is possible). For all other Reference Attribute types this parameter is not used.

ICS_API int ICS_attribute_set_property	(	int	theAttrId,
		const char *	thePropertyName,
		const char *	thePropertyValue
	)

Sets the value for the specified property of an existing attribute

Parameters

theAttrId	(I) The unique identifier of the attribute
thePropertyName	(I) The specified property. Possible values are: NAME SHORT_NAME REFERENCE UNIT1 UNIT2 FLAGS USER1 USER2 DEFAULT_VALUE DEFAULT_VALUE2 DESCRIPTION
thePropertyValue	(I) The value for the specified property

ICS_API int ICS_auto_compute_get_attr_prop	(	const int	theAttributeId,
		int	thePropType,
		logical *	theValue
	)

This API is to be used for writing the custom program to be registered with BMF_ICS_exec_custom_attribute_logic operation in BMIDE. The method is used for retreiving the property value of the attribute id

Parameters

theAttributeId	(I) attribute id
thePropType	(I) property type of the attribute
theValue	(O) true/false for the specified property

ICS_API int ICS_auto_compute_get_attr_value	(	const int	attributeId,
		char **	value,
		int *	format,
		char **	unit
	)

This API is to be used for writing the custom program to be registered with BMF_ICS_exec_custom_attribute_logic operation in BMIDE. The method is used for retreiving the value of the attribute

Parameters

attributeId	(I) attribute id
value	(OF) value of the attribute id
format	(O) The attribute format
unit	(OF) value of the unit

ICS_API int ICS_auto_compute_get_attr_values	(	const int	attributeId,
		int *	valueCount,
		char ***	value,
		int *	format,
		char **	unit
	)

This API is to be used for writing the custom program to be registered with BMF_ICS_exec_custom_attribute_logic operation in BMIDE. The method is used for retreiving the values of the attribute. This API is to be used with attributes with an array of values.

Parameters

attributeId	(I) attribute id
valueCount	(O) Attribute Value count
value	(OF) valueCount array of values for the attribute
format	(O) The attribute format
unit	(OF) valueCount value of the unit

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
	)

This API is to be used for writing the custom program to be registered with BMF_ICS_exec_custom_attribute_logic operation in BMIDE. Register the attribute dependencies for auto-computed attributes.

Parameters

class_id	(I) Class Id
view_id	(I) View Id
size	(I) No of Attributes
auto_compute_attrs	(I) Array of attribute structures
toOverride	(I) Flag to indicate overiding of the parent class registration

ICS_API int ICS_auto_compute_set_attr_prop	(	const int	theAttributeId,
		const int	thePropType,
		const logical	theValue
	)

This API is to be used for writing the custom program to be registered with BMF_ICS_exec_custom_attribute_logic operation in BMIDE. Set the auto computed attribute property

Parameters

theAttributeId	(I) Attribute Id
thePropType	(I) Property Type
theValue	(I) Property Value

ICS_API int ICS_auto_compute_set_attr_value	(	const int	theAttributeId,
		const char *	theAttributeValue,
		const char *	theUnit
	)

This API is to be used for writing the custom program to be registered with BMF_ICS_exec_custom_attribute_logic operation in BMIDE. Set the auto computed attribute value

Parameters

theAttributeId	(I) Attribute Id
theAttributeValue	(I) Attribute Value
theUnit	(I) Attribute Unit System

ICS_API int ICS_auto_compute_set_attr_values	(	const int	theAttributeId,
		const int	theAttrValueCount,
		const char **	theAttributeValues,
		const char *	theUnit
	)

This API is to be used for writing the custom program to be registered with BMF_ICS_exec_custom_attribute_logic operation in BMIDE. Set the auto computed attribute values. This API to be used with attributes with an array of values.

Parameters

theAttributeId	(I) Attribute Id
theAttrValueCount	(I) Attribute Value Count
theAttributeValues	(I) Attribute Value Array
theUnit	(I) Attribute Unit System

ICS_API int ICS_check_privilege	(	tag_t	theInstanceTag,
		const char *	thePrivilegeName,
		logical *	isGrantedExt
	)

This API is used for checking the privialge of the Inclass object like Class,Subclass,Class Attributes,View Attributes based on the ACL information configured in the classification Admin

Parameters

theInstanceTag	(I) Instance Tag
thePrivilegeName	(I) The name of the privilage to be checked
isGrantedExt	(O) true/false for the specified privilage

ICS_API int ICS_class_add_alias_name	(	const char *	theClassId,
		const char *	theLanguage,
		const char *	theAliasName
	)

Add a new alias name to existing list of alias names

Note: This function requires a subsequent call to ICS_class_save() to commit the changes to the database

Parameters

theClassId	(I) The unique id of an existing class
theLanguage	(I) The number of alias names to set
theAliasName	(I) The alias name

ICS_API int ICS_class_add_attributes	(	const char *	theClassId,
		int	theAttrCount,
		int *	theAttrIds
	)

Adds the given attributes to an existing class
Note: this function returns SML_ERR_NO_INSTANCE_FOUND if the class does not exist

Parameters

theClassId	(I) The unique id of an existing class
theAttrCount	(I) The number of attributes to add to the class valid range is 0 to 100
theAttrIds	(I) The attribute id's to be added to the class. The Attributes must exist in the dictionary.

ICS_API int ICS_class_add_attributes2	(	const char *	theClassId,
		int	theAttrCount,
		int *	theAttrIds,
		int	theOptions
	)

Extends ICS_class_add_attributes by adding theOptions paramter.

Parameters

theClassId	(I) The unique id of an existing class.
theAttrCount	(I) The number of attributes to add to the class valid range is 0 to 100
theAttrIds	(I) The attribute id's to be added to the class. The Attributes must exist in the dictionary.
theOptions	(I) Possible values are: ICS_ADD_ATTRIBUTE_MOVE_UP: Will remove the attribute to add in any descendant and update the ICOs accordingly. This will only work for local classes/hierarchies

ICS_API int ICS_class_add_shared_site	(	const char *	theClassId,
		const char *	theSharedSite,
		logical	approveShareOfParents
	)

Adds the given shared site.

Note: This function requires a subsequent call to ICS_class_save() to commit the changes to the database

Parameters

theClassId	(I) The unique id of an existing class
theSharedSite	(I) The name of the shared site
approveShareOfParents	(I) A class can only be shared, if its parents are shared. false: if the parents are not shared theSharedSite will not be added true: if the parents are not shared theSharedSite will be added to the specified class and its parents

ICS_API int ICS_class_ask_alias_names	(	const char *	theClassId,
		int *	theCount,
		char ***	theLanguages,
		char ***	theAliasNames
	)

returns all alias names of the class.

Parameters

theClassId	(I) The unique id of an existing class
theCount	(OF) The number of alias names to set
theLanguages	(OF) The optional language identifiers of the alias names. Might be ""
theAliasNames	(OF) The alias names

ICS_API int ICS_class_ask_attr_dep_config	(	tag_t	class_tag,
		int *	attr_count,
		int **	attr_ids,
		char ***	dependency_attributes,
		char ***	dependency_configurations
	)

Retrieves the dependency configuration settings of the attributes for the given class.

Returns

ITK_ok on success
POM enquiry related error otherwise.

Parameters

class_tag	(I) The tag of the class
attr_count	(O) The number of class attributes containing dependency settings
attr_ids	(OF) attr_count The class attribute IDs
dependency_attributes	(OF) attr_count The dependency attribute values. The output string array is SM-packed, hence should be freed by calling MEM_free on the container only.
dependency_configurations	(OF) attr_count The dependency configuration values. The output string array is SM-packed, hence should be freed by calling MEM_free on the container only.

ICS_API int ICS_class_ask_attr_dep_config_by_id	(	const char *	class_id,
		int *	attr_count,
		int **	attr_ids,
		char ***	dependency_attributes,
		char ***	dependency_configurations
	)

Retrieves the dependency configuration settings of the attributes for the given class.

Returns

ITK_ok on success
#POM enquiry related error otherwise.

Parameters

class_id	(I) The ID of the class
attr_count	(O) The number of class attributes containing dependency settings
attr_ids	(OF) attr_count The class attribute IDs
dependency_attributes	(OF) attr_count The dependency attribute values
dependency_configurations	(OF) attr_count The dependency configuration values

ICS_API int ICS_class_ask_attr_property	(	const char *	theClassId,
		int	theAttributeId,
		const char *	thePropertyName,
		char **	thePropertyValue
	)

Asks for the value of the property in the specified attribute of the class

Parameters

theClassId	(I) The unique id of an existing class
theAttributeId	(I) The id of the attribute to set the property in
thePropertyName	(I) The id of the property to ask. For possible values see ICS_class_set_attr_property() and additionally SMINDEX, DBINDEX, CID, _NAME, _FORMAT, LOCAL_USER1, LOCAL_USER2
thePropertyValue	(OF) The value for the property. Needs to be freed using MEM_free.

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
	)

Call this function to ask the reference attribute properties of an attribute in a certain Classification class (given by the Class ID and the attribute ID).

Parameters

theClassId	(I) Class ID of the Classification class in which the attribute is used.
theAttributeID	(I) Attribute ID of the Classification class attribute from which you want to read the reference attribute definition. The parameter must specify an attribute ID of an attribute that is used in Classification class theClassId.
theReferenceAttributeState	(O) 0 - non reference attribute ICS_REFATTR_INHERITED - the Reference Attribute definition is taken from the Classification dictionary (in this case the subsequent parameters are set to the values defined in the Classification dictionary) ICS_REFATTR_CLASS_LOCAL - the Reference Attribute definition is specified locally in the Classification class
theReferenceAttributeType	(O) One of the following values: ICS_REFATTR_CLASSIFIED_OBJECT - a property or attribute of the classified object ICS_REFATTR_MASTERFORM - a property or attribute of the Masterform of the classified item or item revision ICS_REFATTR_RELATED_OBJECT - a property or attribute of an object that is related (via an IMAN Relation) to the classified object ICS_REFATTR_ICO - an attribute of a different ICO
theFlags	(O) 0 or any combination of: ICS_REFATTR_PROPERTY: this flag is set if an IMAN property is defined - if it is not set then a POM attribute is defined ICS_REFATTR_ITEM_ATTR: this flag is set if a reference attribute of an item is defined. This means that if the classified object is an item revision the reference attribute value will be read from the item (or its masterform / an object that is related to the item) of the classified item revision.
theClassName	(OF) Depending on theReferenceAttributeType this parameter specifies one the following values: ICS_REFATTR_CLASSIFIED_OBJECT: Classification class where the referenced ICO is stored. ICS_REFATTR_MASTERFORM: IMAN Type of the classified object / its item if ICS_REFATTR_ITEM_ATTR is set in the flags (the parameter may be NULL to specify that different IMAN Types are allowed) ICS_REFATTR_CLASSIFIED_OBJECT: POM Class / IMAN Type of the classified object / its item if ICS_REFATTR_ITEM_ATTR is set in the flags (the parameter may be NULL to specify that different IMAN Types are allowed) ICS_REFATTR_RELATED_OBJECT: POM Class / IMAN Type of the related object (The second alternatives are valid if ICS_REFATTR_PROPERTY is set in theFlags)
theAttrName	(OF) Depending on theReferenceAttributeType this parameter specifies the following value: ICS_REFATTR_CLASSIFIED_OBJECT: name of the POM Attribute / IMAN Property where the value of the reference attribute will be read from ICS_REFATTR_MASTERFORM: name of the POM Attribute / IMAN Property where the value of the reference attribute will be read from (the POM Attribute / IMAN Property is found in the Masterform of the classified object / its item) ICS_REFATTR_CLASSIFIED_OBJECT: Attribute ID of the attribute that will be displayed as "key attribute" of the referenced ICO ICS_REFATTR_RELATED_OBJECT: name of the POM Attribute / IMAN Property where the value of the reference attribute will be read from (this POM Attribute / IMAN Property is found in the related object) (The second alternatives are valid if ICS_REFATTR_PROPERTY is set in theFlags)
theRelationName	(OF) If theReferenceAttributeType is ICS_REFATTR_RELATED_OBJECT: name of the IMAN Relation with which the related object is attached to the classified object (may be NULL to specify that any relation is possible). For all other Reference Attribute types this parameter is set to NULL.

ICS_API int ICS_class_ask_attributes	(	const char *	theClassId,
		int *	theAttributeCount,
		tag_t **	theAttributeTags,
		int **	theAttributeIds
	)

Returns all attributes of the given class

Parameters

theClassId	(I) The unique id of an existing class
theAttributeCount	(O) The attribute count
theAttributeTags	(O) The tags of attributes
theAttributeIds	(OF) theAttributeCount

ICS_API int ICS_class_ask_children	(	const char *	theClassId,
		int	theChildTypeFilter,
		int *	theChildCount,
		char ***	theChildren
	)

Returns the children for the specified class of an existing class

Parameters

theClassId	(I) The unique id of an existing class
theChildTypeFilter	(I) The following values from ICS_child_type_e: ICS_CHILD_type_class ICS_CHILD_type_view
theChildCount	(O) The number of classes returned
theChildren	(OF) theChildCount The list of unique id's of the childern null if theChildCount == 0. Needs to be freed using MEM_free

ICS_API int ICS_class_ask_document_fileId	(	const char *	theClassId,
		const char *	theDocumentType,
		char **	theFileId
	)

Parameters

theClassId	(I) The unique id of an existing class
theDocumentType	(I) For possible values see ICS_class_import_document()
theFileId	(OF)

ICS_API int ICS_class_ask_documents	(	const char *	theClassId,
		int *	theDocumentCount,
		char ***	theDocumentTypes,
		tag_t **	theDocumentTags
	)

Returns the types and tags of all documents according to the dataset of the given class

All parameters ecept for theClassId accept NULL pointer to indicate that this parameter should not be returned

Parameters

theClassId	(I) The unique id of an existing class
theDocumentCount	(O) The number of named references
theDocumentTypes	(OF) theDocumentCount The reference names of the documents
theDocumentTags	(OF) theDocumentCount The tags of the documents

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
	)

Returns all instances (ICOs) of the given class

The following parameters accept NULL pointer to indicate that this parameter should not be returned:

theICOTags, theICOUIDs, theICOIds, theClassId, theWSOTag

Parameters

theClassId	(I) The unique id of an existing class
includeFromChildren	(I)
theCount	(O) The number of ICO tags returned
theICOTags	(OF) theCount The list of ICOs of the given class
theICOUIDs	(OF) theCount
theICOIds	(OF) theCount The IDs of the ICOs
theClassIds	(OF) theCount The class ids of the ICOs
theWSOTags	(OF) theCount The tags of the objects the ICOs are classifying
theWSOUIDs	(OF) theCount

ICS_API int ICS_class_ask_id	(	tag_t	theClassTag,
		char **	theClassId
	)

If theClassTag is a valid class, returns the id of the class

Parameters

theClassTag	(I) The tag of the Class
theClassId	(OF) The Id of the Class

ICS_API int ICS_class_ask_ids	(	unsigned int	theCount,
		const tag_t *	theClasses,
		char ***	theClassIds
	)

Retrieves the class IDs of a list of classes.

Note: Any invalid entry in theClasses will be represented by an empty string in the output array theClassIds.

Returns

ITK_ok on success
SML_ERR_INVALID_VALUE if theCount is 0 or if all the members of theClasses are invalid.

Parameters

theCount	(I) Number of classes
theClasses	(I) theCount Classes
theClassIds	(OF) theCount IDs corresponding to the given classes. The array is packed, which means that the memory is deallocated by calling MEM_free on the container only.

ICS_API int ICS_class_ask_mapping_sources	(	char *	theTargetClassID,
		int	theMappingViewType,
		int *	theSourceClassCount,
		char ***	theSourceClassIDs,
		char ***	theSourceClassNames
	)

Determine the source classes that have been mapped to the given target class.

Parameters

theTargetClassID	(I) ID of a class to map ICOs to
theMappingViewType	(I) Type of mappings to return
theSourceClassCount	(O) Count of mapping source classes
theSourceClassIDs	(OF) theSourceClassCount The Ids of source class
theSourceClassNames	(OF) theSourceClassCount The names of source Class

ICS_API int ICS_class_ask_mapping_targets	(	char *	theSourceClassID,
		int	theMappingViewType,
		int *	theTargetClassCount,
		char ***	theTargetClassIDs,
		char ***	theTargetClassNames
	)

Determine the target classes that the given source class has been mapped to.

Parameters

theSourceClassID	(I) ID of the class to map ICOs from
theMappingViewType	(I) Type of mappings to return
theTargetClassCount	(O) Count of mapping target classes
theTargetClassIDs	(OF) theTargetClassCount The Ids of target class
theTargetClassNames	(OF) theTargetClassCount The names of target Class

ICS_API int ICS_class_ask_parent	(	const char *	theClassId,
		tag_t *	theParentTag,
		char **	theParentId
	)

Returns the tag and the id of the parent of the given class
Note: this function returns SML_ERR_NO_INSTANCE_FOUND if the class does not exist

Parameters

theClassId	(I) The unique id of an existing class
theParentTag	(O) The tag of the Parent
theParentId	(OF) The Parent's Id

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
	)

Returns the information about all the parents found by theChildCIDs

Parameters

theNumCIDs	(I) Number of the child classes
theChildCIDs	(I) Array of child class IDs
theParentCount	(O) The number of parents found
theParentTags	(OF) theParentCount Tags of the parents found
theParentTypes	(OF) theParentCount Types of the parent classes Posible values are: Group, Class, StorageClass
theParentCIDs	(OF) theParentCount Class IDs of the Parent classes
theNames	(OF) theParentCount Names of the parent classes
theInstancesCounts	(OF) Number of instances stored in the class and any child class
theChildCounts	(OF) Number of children of the classes

ICS_API int ICS_class_ask_parents	(	const char *	theClassId,
		logical	includeGroups,
		int *	theParentCount,
		tag_t **	theParentTags,
		char ***	theParentIds
	)

Returns the parents for the specified class of an existing class
Note: this function returns SML_ERR_NO_INSTANCE_FOUND if the class does not exist

Parameters

theClassId	(I) The unique id of an existing class
includeGroups	(I) False : only parents of type class (where the given class inherits from) are returned True : the groups up to and including SAM are returned as well
theParentCount	(O) The number of classes returned
theParentTags	(OF) theParentCount The list of unique id's of the parents null if theParentCount == 0 Needs to be freed using MEM_free
theParentIds	(OF) theParentCount The list of unique id's of the parents null if theParentCount == 0 Needs to be freed using MEM_free

ICS_API int ICS_class_ask_property	(	const char *	theClassId,
		const char *	thePropertyName,
		char **	thePropertyValue
	)

Returns the value for the specified property of an existing class

Parameters

theClassId	(I) The unique id of an existing class
thePropertyName	(I) The id of the property to set. Possible values: CID, ISAGROUP, NUM_SHARED_SITES, ATTR_COUNT also see ICS_class_set_property()
thePropertyValue	(OF) The value for the property needs to be freed using MEM_free

ICS_API int ICS_class_ask_shared_sites	(	const char *	theClassId,
		int *	theSiteCount,
		char ***	theSharedSites
	)

Returns the count and the values of the shared sites

Parameters

theClassId	(I) The unique id of an existing class
theSiteCount	(O) The number of shared sites
theSharedSites	(OF) theSiteCount The shared sides. Need to be freed using MEM_free

ICS_API int ICS_class_ask_tag	(	const char *	theClassId,
		tag_t *	theClassTag
	)

If theClassId is a valid class, returns the POM tag of the class
Note: this function returns SML_ERR_NO_INSTANCE_FOUND if the class does not exist

Parameters

theClassId	(I) The Id of the Class
theClassTag	(O) The tag of the Class

ICS_API int ICS_class_attr_ask_dep_keylovs	(	const char *	class_id,
		int	selected_attr,
		const char *	selected_value,
		int	ui_attr_count,
		const int *	ui_attr_ids,
		const char **	ui_attr_values,
		int *	changed_attr_count,
		ICS_keylov_descriptor_p_t **	changed_keylovs
	)

Retrieves the information about dependent attributes in the given class when the selected attribute value has changed.
Values are returned for all given UI attributes that have changed in the parameters selected_attr / selected_value.

The class_id parameter must be a valid class ID and not NULL
All other input values can be set as follows:

USE CASE	selected_attr	selected_value	ui_attr_count	ui_attr_ids	ui_attr_values
User has selected a value	valid attr ID	valid value	UI attr count	UI attr IDs	UI attr values
User has deselected a value	valid attr ID	"" or NULL	UI attr count	UI attr IDs	UI attr values
Initial view	0	0	UI attr count	UI attr IDs	NULL or empty UI attr values
Edit Mode	0	0	UI attr count	UI attr IDs	ICO values (currently displayed in the view)

Returns

ITK_ok on success
SML_ERR_NO_INSTANCE_FOUND if the class does not exist.
SML_ERR_ATTR_NOT_IN_CLASS if the selected attribute is not in the class

Parameters

class_id	(I) Class ID, must not be NULL
selected_attr	(I) The selected attribute
selected_value	(I) The selected value
ui_attr_count	(I) Number of attributes in the UI
ui_attr_ids	(I) UI attribute IDs
ui_attr_values	(I) UI attribute values
changed_attr_count	(O) Number of changed keylovs
changed_keylovs	(OF) changed_attr_count The changed Keylovs

ICS_API int ICS_class_cancel ( const char * theClassId )

This has the same functionality as ICS_class_refresh()

Parameters

theClassId (I) The unique id of the class

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
	)

The following function copies theClass to a new Classification class with theNewCid ID and theNewParent parent; afterwards the descendants whose IDs are contained within theOldIDs are copied under the new Class with the IDs specified in theNewIDs.

The function fails if one of the following error conditions is met:

theNewParent is a descendant of theClass
theOldIDs contains IDs of Classes/Views that either aren't descendants of theClass or their immediate parent is not in theOldIDs
theNewIDs contains IDs that are not unique.
theClass has unreadable descendants (this check is only executed if ICS_IGNORE_UNREADABLE_CHILDREN is not specified in theOptions)
theNewParent is not writable

Moreover a warning is logged if

theClass is shared (the shared sites are not copied!)
theClass or one of its descendants to copy has part family templates attached (part family templates can only be attached to ONE Classification class - and they are not moved to the copies)

If these checks succeed and theClass itself is successfully copied, then further errors during the subsequent copy operation are logged to the syslog file but do not lead to a rollback.

Parameters

theClass	(I) The ID of the Classification class to be copied
theNewCidIn	(I) The ID of the Classification class that is created as a copy of theClass
theNewParent	(I) The ID of the Classification class under which the copy of theClass is created
theOptions	(I) options - valid values are: ICS_COPY_THIS_CLASS_ONLY - only copy theClass (no descendants are copied. If this option is not specified and theChildCount is 0, then all descendants of theClass are copied under the new Class and the IDs for the copies are automatically generated. ICS_IGNORE_UNREADABLE_CHILDREN - no error if theClass has unreadable descendants ICS_COPY_INHERITED_ATTRIBUTES - the copy of theClass will contain all attributes of theClass (local and inherited attributes). If this option is not specified, then only the local attributes of theClass are copied to the new Class. ICS_DRY_RUN - only executes the checks but does not actually copy any objects
theChildCountIn	(I) Count of the descendants of theClass that shall be copied together with theClass.
theOldIDsIn	(I) IDs of the descendants to copy. theOldIDs must containthe IDs as CID (for Classification classes) or CID::SID (for Classification views).
theNewIDsIn	(I) IDs of the copies. theNewIDs must contain the IDs of the objects to be created as NEW_CID (for Classification classes) or NEW_SID (for Classification Views).
theNewCidOut	(OF) The ID of the Classification class that is created as a copy of theClass.
theChildCountOut	(O) Count of the descendants that were successfully copied.
theOldIDsOut	(OF) theChildCountOut IDs of the descendants the ware successfully copied. theOldIDsOut contain the IDs as CID (for Classification classes) or CID::SID (for Classification views).
theNewIDsOut	(OF) theChildCountOut IDs of the copies. theNewIDs contain the IDs of the objects that were created as NEW_CID (for Classification classes) or NEW_SID (for Classification Views).

ICS_API int ICS_class_create	(	const char *	theClassId,
		const char *	theParentId,
		const char *	theName,
		int	theClassFlags,
		int	theAttrCount,
		int *	theAttrIds
	)

Creates a new class as child of the given parent. The class is immediately created in the database.

Parameters

theClassId	(I) The unique id of the new class
theParentId	(I) The unique id of the existing parent this should belong to
theName	(I) The display name of the new class
theClassFlags	(I) Flags to configure the class
theAttrCount	(I) The number of attributes to add to the class valid range is 0 to 100
theAttrIds	(I) The attribute id's to be added to the class. The attributes must exist in the dictionary.

ICS_API int ICS_class_create_mapping	(	char *	theSourceClassID,
		char *	theTargetClassID,
		int	theMappingViewType,
		int	theAttributeCount,
		int *	theAttributeIds,
		char **	theAttributeMappings
	)

Define a mapping between the given source and target class, as well as the attribute mappings to the target class? attributes.

Parameters

theSourceClassID	(I) ID of class to map ICOs from
theTargetClassID	(I) ID of class to map ICOs to
theMappingViewType	(I) Mapping view type to create
theAttributeCount	(I) Count of mapped attributes
theAttributeIds	(I) theAttributeCount The attribute Ids
theAttributeMappings	(I) theAttributeCount The attribute mappings

ICS_API int ICS_class_create_unique	(	const char *	theParentId,
		const char *	theName,
		int	theClassFlags,
		int	theAttrCount,
		int *	theAttrIds,
		char **	theNewClassId
	)

Creates a new class as child of the given parent. A new id for this class will be generated and returned.

Parameters

theParentId	(I) the unique id of the existing parent this should belong to
theName	(I) the 'display' Name of the new class
theClassFlags	(I) Flags to configure the class
theAttrCount	(I) the number of attributes to add to the class valid range is 0 to 100
theAttrIds	(I) the attribute id's to be added to the class. The Attributes must exist in the dictionary.
theNewClassId	(OF) the new generated unique id of the new class

ICS_API int ICS_class_delete_mapping	(	char *	theSourceClassID,
		char *	theTargetClassID,
		int	theMappingViewType
	)

Delete the mapping between the given source and target class, if one exists.

Parameters

theSourceClassID	(I) ID of the mapping?s source class
theTargetClassID	(I) ID of the mapping?s target class
theMappingViewType	(I) Type of mapping view to delete

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
	)

Returns the most important information about a class

Note: If theClassId has the format xxx::yyy it is treated as a legacy SMLSubClass

Parameters

theClassId	(I) The unique id of an existing class
theParent	(OF) The id of the parent class or group
theType	(O) Group, Class, StorageClass
theName	(OF) The display name for the class
theShortName	(OF) An optional short version of theName
theDescription	(OF) A user oriented description of the class
theUserData1	(OF) Customer specific values not used by UGS
theUserData2	(OF) Customer specific values not used by UGS
theOptions	(O) Bit encoded values from ICS_class_flags_e
theInstanceCount	(O) The number of instances stored in this class or any of its children
theChildrenCount	(O) The number of children of this class
theViewCount	(O) The number of views defined for this class

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
	)

Note: The Attributes returned by this function are filtered through the view defined for the user of this call

Parameters

theClassId	(I) The unique id of an existing class
theCount	(O) The number of attributes of this class
theIds	(OF) theCount The attribute id
theNames	(OF) theCount The display name
theShortNames	(OF) theCount The short version of the display name
theAnnotations	(OF) theCount The annotation
theArraySize	(OF) theCount 1 for non vla attributes, > 1 for vla attribute
theFormat	(OF) theCount The internal format definition. Use ICS_describe_format() to get details.
theUnit	(OF) theCount
theMinValues	(OF) theCount Minimum allowed value ( valid for integer and float attributes)
theMaxValues	(OF) theCount Maximum allowed value ( valid for integer and float attributes)
theDefaultValues	(OF) theCount Default value for new Instances
theDescriptions	(OF) theCount The attribute description from the dictionary
theOptions	(OF) theCount Bit encoded values from ICS_class_attr_flags_e

ICS_API int ICS_class_describe_mapping	(	char *	theSourceClassID,
		char *	theTargetClassID,
		int	theMappingViewType,
		int *	theAttributeCount,
		int **	theAttributeIds,
		char ***	theAttributeMappings
	)

If a mapping exists between the given source and target class, return the target class? attributes as well as their corresponding attribute mappings.

Parameters

theSourceClassID	(I) ID of class to map ICOs from
theTargetClassID	(I) ID of class to map ICOs to
theMappingViewType	(I) Requested mapping view type
theAttributeCount	(O) Count of mapped attributes
theAttributeIds	(OF) theAttributeCount The attribute Ids
theAttributeMappings	(OF) theAttributeCount The attribute mappings

ICS_API logical ICS_class_exists ( const char * theClassId )

Checks whether a class with the given classId exists in the database

Return values:

true : class exists
false : a class with this id does not exist

Parameters

theClassId (I) The unique id of an existing class

ICS_API int ICS_class_export_document	(	const char *	theClassId,
		const char *	theDocumentType,
		const char *	theOutputDirectory,
		logical	overwriteExistingFiles,
		int *	theFileCount,
		char ***	theFileNames
	)

Exports all documents of the given type attached to this class

Parameters

theClassId	(I) The unique id of an existing class
theDocumentType	(I) For possible values see ICS_class_import_document()
theOutputDirectory	(I) The directory name to put the files into
overwriteExistingFiles	(I)
theFileCount	(O) The number of files exported
theFileNames	(OF) theFileCount the names of the files put into theOutputDirectory

ICS_API int ICS_class_import_document	(	const char *	theClassId,
		const char *	theDocumentType,
		const char *	theFileName
	)

Imports a document for this class. An existing image will be overwritten. A document can be the class image or icon or any other type of document.

Parameters

theClassId	(I) The unique id of an existing class
theDocumentType	(I) Possible values are: Image Icon
theFileName	(I) The name of the file to be imported

ICS_API int ICS_class_is_descendant	(	const char *	theClassId,
		const char *	theAncestor,
		logical *	theVerdict
	)

Determines whether theClassId is a descendant of theAncestor. This will cover classes and parents.
Note: this function returns SML_ERR_NO_INSTANCE_FOUND if the class does not exist

Parameters

theClassId	(I)
theAncestor	(I)
theVerdict	(O)

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
	)

Returns the children for the specified class of an existing class

The following parameters accept NULL pointer to indicate that this parameter should not be returned:

theChildCount, theChildernTags, theChildrenIds, theChildrenTypes

Note: The legacy objects SMLClass and SMLSubClass are treated as class and storageClass

Parameters

theClassId	(I) The unique id of an existing class
theChildTypeFilter	(I) The following values from ICS_child_type_e: ICS_CHILD_type_class ICS_CHILD_type_view
theSortOption	(I)
theChildCount	(O) The number of classes returned
theChildrenTags	(OF) theChildCount The POM tags of the children
theChildrenIds	(OF) theChildCount The unique id's of the childern
theChildrenTypes	(OF) theChildCount The types of the children Group Class StorrageClass View
theChildrenNames	(OF) The (display) names of the children
theInstanceCounts	(OF) The number of instances stored in the class and all its descendents
theChildrenCounts	(OF) The number of child classes for each child
theViewCounts	(OF) The number of view for each child

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
	)

Returns the children for the specified class of an existing class

The following parameters accept NULL pointer to indicate that this parameter should not be returned:

theChildCount, theChildernTags, theChildrenIds, theChildrenTypes

Note: The legacy objects SMLClass and SMLSubClass are treated as class and storageClass

Parameters

theClassId	(I) The unique id of an existing class
theChildTypeFilter	(I) The following values from ICS_child_type_e: ICS_CHILD_type_class ICS_CHILD_type_view
theSortOption	(I)
theOptions	(I) The options for the children search: #0 ICS_CHILDREN_INSTANCE_COUNT ICS_CHILDREN_CHILD_COUNT ICS_CHILDREN_VIEW_COUNT ICS_CHILDREN_ALL_COUNT
theChildCount	(O) The number of classes returned
theChildrenTags	(OF) theChildCount The POM tags of the children
theChildrenIds	(OF) theChildCount The unique id's of the childern
theChildrenTypes	(OF) theChildCount The types of the children Group Class StorrageClass View
theChildrenNames	(OF) theChildCount The (display) names of the children
theInstanceCounts	(OF) theChildCount The number of instances stored in the class and all its descendents
theChildrenCounts	(OF) theChildCount The number of child classes for each child
theViewCounts	(OF) theChildCount The number of view for each child
theIconImageTickets	(OF) theChildCount The icon image ticket for each child
theClassImageTickets	(OF) theChildCount The class image ticket for each child

int ICS_API ICS_class_move	(	const char *	theClassToMove,
		const char *	theNewParent,
		int *	theFailedCount,
		char ***	theFailedObjects
	)

The following function moves theClassToMove under theNewParent. The operation will be done the following way:

The id of the class will be changed to theClassToMove
The class will be copied to a new class with id theClassToMove and under theNewParent.
The part family templates that are attached to and the ICOs that are stored in the class are moved to the copy. When this is done the class children and views (in other words: all descendants of the class) will be processed in the same way. If something goes wrong there will not be a rollback. Moreover the operation will continue even if an error occured. As many objects as possible will be moved. After the objects have been renamed and copied the old objects will be deleted. The function will fail completely if:
theNewParent is a descendant of theClassToMove
theClassToMove has unreadable children
theClassToMove is not writable
theNewParent is not locally owned
theNewParent is a class but theClassToMove is a group
theClassToMove is shared

Parameters

theClassToMove	(I) The ID of the Classification class to be moved
theNewParent	(I) The ID of the Classification class under which the theClassToMove is moved
theFailedCount	(O) The number of objects that could not be moved (in case of classes only the top level object is counted)
theFailedObjects	(OF) theFailedCount The IDs of the objects that could not be moved

ICS_API int ICS_class_move_partfamily_templates	(	const char *	theSourceClassId,
		const char *	theTargetClassId,
		int	theOptions
	)

ICS_API int ICS_class_refresh ( const char * theClassId )

Reloads the class definition from the database. All changes made be any function call that requires the use of ICS_class_save() will be lost.

Parameters

theClassId (I) The unique id of the class

ICS_API int ICS_class_remove ( const char * theClassId )

Permanently removes the class from the database

Note: Classes can only be removed if the are not referenced by child classes, views, or instances

Parameters

theClassId (I) The unique id of an existing class

ICS_API int ICS_class_remove_attributes	(	const char *	theClassId,
		int	theAttrCount,
		int *	theAttrIds
	)

Remove the given attributes from the class.

Note: Attributes can only be removed under certain restrictions.

Parameters

theClassId	(I) The unique id of an existing class
theAttrCount	(I) The number of attributes to remove from the class
theAttrIds	(I) The attribute IDs to be removed from the class

ICS_API int ICS_class_remove_document	(	const char *	theClassId,
		const char *	theDocumentType
	)

Remove all images assigned to this class

Parameters

theClassId	(I) The unique id of an existing class
theDocumentType	(I) For possible values see ICS_class_import_document()

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
	)

Removes the class and its hierarchy with the given parameters

Parameters

theClassId	(I) class id
theRecurseOption	(I) theRecurseOption for child elements
theViewsOption	(I) Option to remove views
theIcosOption	(I) Option to remove Icos
theWSOOption	(I) Option to remove WSO
theChildrenOnlyOption	(I) Option to remove the ChildrenOnly
theIgnoreOption	(I) theIgnoreOption
thePurgeAttrs	(I) thePurgeAttrs
thePurgeKeyLOV	(I) thePurgeKeyLOV
theFailedObjectsCount	(O) the number of failed objects count
theFailedObjects	(OF) theFailedObjectsCount the failed class id's

ICS_API int ICS_class_save ( const char * theClassId )

Saves unsaved modifications to the database. All functions that require a call to this function are explicitly marked.

Parameters

theClassId (I) The unique id of the class

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
	)

Parameters

theQuery	(I) Expression of type attributeId operator value Supported values for attributeId are: -600 class id -607 class name -601 class type -608 short name -602 group id -612 user data 1 -613 user data 2 8 attribute id 3 attribute name
theSortOption	(I) Attribute Id to sort by
theCount	(O) Number classes found
theTags	(OF) Tgas of the classes found
theTypes	(OF) theCount Types of the classe
theCIDs	(OF) theCount Ids of the classe
theNames	(OF) theCount Names of the classes
theInstancesCounts	(OF) Number of instances stored in the class and any child class
theChildCounts	(OF) Number of children of the class
theViewCounts	(OF) Number of views of the class
theSubClassCounts	(OF) Number of subclasses of the class

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
	)

Parameters

theClassId	(I)
searchInChildren	(I)
theExpressionCount	(I)
theAttrIds	(I)
theAttrExpressions	(I)
theCount	(O)
theICOTags	(OF) theCount
theICOUIDs	(OF) theCount
theICOIds	(OF) theCount
theClassIds	(OF) theCount
theWSOTags	(OF) theCount
theWSOUIDs	(OF) theCount

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
	)

Returns the information about the libraries found by theSearchStrings

Parameters

theNumSearchStrings	(I) Number of search strings
theSearchStrings	(I) Array of search strings
theCount	(O) Number of classes found
theTags	(OF) theCount Tags of the classes found
theTypes	(OF) theCount Types of the classes
theCIDs	(OF) theCount Ids of the classes
theParentCIDs	(OF) theCount Parent ids of the classes
theNames	(OF) theCount Names of the classes
theInstancesCounts	(OF) Number of instances stored in the class and any child class
theChildCounts	(OF) Number of children of the classes
theLibraries	(OF) theCount library values for classes

ICS_API int ICS_class_set_alias_names	(	const char *	theClassId,
		int	theCount,
		const char **	theLanguages,
		const char **	theAliasNames
	)

Set the alias names for the class. Any previously existing alis names will be overwitten. This function can be used to remove all alias names by setting theCount = 0

Note: This function requires a subsequent call to ICS_class_save() to commit the changes to the database

Parameters

theClassId	(I) The unique id of an existing class
theCount	(I) The number of alias names to set
theLanguages	(I) The optional language identifiers of the alias names. Need to be at least an empty string (not NULL)
theAliasNames	(I) The alias names

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
	)

Call this function to define an attribute ? given by the ID of the Classification class and its attribute ID - as reference attribute.

Note: Use 0 as theReferenceState to define the attribute to be a normal attribute (non reference attribute).; This function requires a subsequent call to ICS_class_save() to commit the changes to the database.

Parameters

theClassId	(I) Class ID of the Classification class where you want to define the reference attribute. The parameter must specify an existing class ID.
theAttributeID	(I) Attribute ID of the attribute that you want to define as reference attribute. The parameter must specify the attribute ID of an attribute that is used in Classification class theClassId.
theReferenceAttributeType	(I) 0 - non reference attribute ICS_REFATTR_INHERITED - the Reference Attribute definition from the Classification dictionary will be used ICS_REFATTR_CLASS_LOCAL - set a Reference Attribute definition for the attribute locally in this class (only in this case the following parameters are used) (I) One of the following values: ICS_REFATTR_CLASSIFIED_OBJECT - a property or attribute of the classified object ICS_REFATTR_MASTERFORM - a property or attribute of the Masterform of the classified item or item revision ICS_REFATTR_RELATED_OBJECT - a property or attribute of an object that is related (via an IMAN Relation) to the classified object ICS_REFATTR_ICO - an attribute of a different ICO
theFlags	(I) Set to 0 or any combination of: ICS_REFATTR_PROPERTY: set this flag if you want to define an IMAN property - do not set it if you want to define a POM Attribute ICS_REFATTR_ITEM_ATTR: set this flag if you want to define a reference attribute of an item. This means that if the classified object is an item revision the reference attribute value will be read from the item (or its masterform / an object that is related to the item) of the classified item revision.
theClassName	(I) Depending on theReferenceAttributeType specify the following value: ICS_REFATTR_CLASSIFIED_OBJECT: Classification class where the referenced ICO is stored (the parameter must not be NULL). ICS_REFATTR_MASTERFORM: IMAN Type of the classified object / its item if ICS_REFATTR_ITEM_ATTR is set in the flags (the parameter may be NULL to specify that different IMAN Types are allowed) ICS_REFATTR_CLASSIFIED_OBJECT: POM Class / IMAN Type of the classified object / its item if ICS_ITEM_ATTR is set in the flags (the parameter may be NULL to specify that different IMAN Types are allowed) ICS_REFATTR_RELATED_OBJECT: POM Class / IMAN Type of the related object (the parameter must not be NULL) (The second alternatives are valid if ICS_REFATTR_PROPERTY is specified in theFlags)
theAttrName	(I) This parameter must not be NULL. Depending on theReferenceAttributeType specify the following value: ICS_REFATTR_CLASSIFIED_OBJECT: name of the POM Attribute / IMAN Property where the value of the reference attribute will be read from ICS_REFATTR_MASTERFORM: name of the POM Attribute / IMAN Property where the value of the reference attribute will be read from (the POM Attribute / IMAN Property is found in the Masterform of the classified object / its item) ICS_REFATTR_CLASSIFIED_OBJECT: Attribute ID of the attribute that will be displayed as "key attribute" of the referenced ICO ICS_REFATTR_RELATED_OBJECT: name of the POM Attribute / IMAN Property where the value of the reference attribute will be read from (this POM Attribute / IMAN Property is found in the related object) (The second alternatives are valid if ICS_REFATTR_PROPERTY is specified in theFlags)
theRelationName	(I) If theReferenceAttributeType is ICS_REFATTR_RELATED_OBJECT: name of the IMAN Relation with which the related object is attached to the classified object (may be NULL to specify that any relation is possible). For all other Reference Attribute types this parameter is not used.

ICS_API int ICS_class_set_attr_property	(	const char *	theClassId,
		int	theAttributeId,
		const char *	thePropertyName,
		const char *	thePropertyValue
	)

Sets the property value for the property in the specified attribute of the class

Note: This function requires a subsequent call to ICS_class_save() to commit the changes to the database; If you want to set the ATTRIBUTEID please use the following ITK functions:
ICS_class_remove_attributes() and ICS_class_add_attributes()

Parameters

theClassId	(I) The unique id of an existing class
theAttributeId	(I) The id of the attribute to set the property in.
thePropertyName	(I) The id of the property to set Possible values are: ANNOTATION, MIN, MAX, FLAGS, MANDATORY, PROTECTED, UNIQUE, PROPAGATED, ARRAY_SIZE, ARRAY, EXTERNAL_ARRAY, REFERENCE, LOCAL_VALUE, USER1, USER2
thePropertyValue	(I) The value for the property

ICS_API int ICS_class_set_property	(	const char *	theClassId,
		const char *	thePropertyName,
		const char *	thePropertyValue
	)

Sets the given property value for the specified property

Note: This function requires a subsequent call to ICS_class_save() to commit the changes to the database

Parameters

theClassId	(I) The unique id of an existing class
thePropertyName	(I) The id of the property to set. Possible values are: PARENT, NAME, SHORT_NAME, FLAGS UNITSYSTEM, ABSTRACT, ISASSEMBLY MULTIINST, USER1, USER2
thePropertyValue	(I) The value for the property

ICS_API int ICS_class_share_incl_children	(	const char *	theClass,
		int	theSiteCount,
		const char **	theSites,
		int	theOptions,
		logical	shareParentsToo
	)

The following function shares theClass to theSites and afterwards shares the following objects:

class children (and their children and so on) if theOptions contains ICS_CLASS_SHARE_child_classes
subclasses (also the subclasses of class children if ICS_CLASS_SHARE_child_classes is specified ) if ICS_CLASS_SHARE_subclass is specified i theOptions
default views (also the default views of class children if ICS_CLASS_SHARE_child_classes is specified ) if ICS_CLASS_SHARE_default_view is specified in theOptions
user, role and group views (also these types of views of class children if ICS_CLASS_SHARE_child_classes is specified ) if ICS_CLASS_SHARE_specific_view is specified in theOptions (the preference ICS_share_viewtypes is evaluated to find out which of these types will be shared)

It is no error to specify sites to which theClass is already shared (this enables you share the children of theClass although theClass itself is already shared). The function fails if theClass's parent is not shared to at least one of theSites and shareParentsToo is false. If theClass is successfully shared then no error is returned (but logged in the syslog file) if sharing any of the children fails.

Parameters

theClass	(I) the class to be shared
theSiteCount	(I) the count of the sites to which the class (and possibly children) will be shared
theSites	(I) the names of the sites to which the class (and possibly children) will be shared
theOptions	(I) specifies which of the children of theClass will be shared (see above).
shareParentsToo	(I) If true then the parents of theClass will be shared to theSites, too.

ICS_API int ICS_ico_ask_all_attributes	(	tag_t	theICOTag,
		int *	theAttributeCount,
		int **	theAttributeIds,
		int **	theAttributeValCounts,
		char ****	theAttributeValues
	)

Returns all attributes of the given ICO without using a view

Parameters

theICOTag	(I) The Tag of the ICO
theAttributeCount	(O) The attribute count
theAttributeIds	(OF) theAttributeCount The attribute Ids
theAttributeValCounts	(OF) theAttributeCount The attribute value count
theAttributeValues	(OF) theAttributeCount The attribute values

ICS_API int ICS_ico_ask_attributes	(	tag_t	theICOTag,
		int *	theAttributeCount,
		int **	theAttributeIds,
		int **	theAttributeValCounts,
		char ****	theAttributeValues
	)

Returns all attributes of the given ICO

Note: Only those attributes are retuned which are accessible through the user specific view.

Parameters

theICOTag	(I) The Tag of the ICO
theAttributeCount	(O) The attribute count
theAttributeIds	(OF) theAttributeCount The attribute Ids
theAttributeValCounts	(OF) theAttributeCount The count of Attribute values
theAttributeValues	(OF) theAttributeCount The attribute values

ICS_API int ICS_ico_ask_attributes_optimized	(	tag_t	theICOTag,
		int *	theAttributeCount,
		int **	theAttributeIds,
		char ***	theAttributeNames,
		int **	theAttributeValCounts,
		char ****	theAttributeOptimizedValues,
		char ****	theAttributeOptimizedUnits
	)

Returns all attributes with their optimized units ans values of the given ICO For the attributes that are numeric and optimization flag is turned "on" , optimized units ans values are returned For other attributes, storage units ans values are returned

Note: Only those attributes are retuned which are accessible through the user specific view.

Parameters

theICOTag	(I) The Tag of the ICO
theAttributeCount	(O) The attribute count
theAttributeIds	(OF) theAttributeCount The attribute Ids
theAttributeNames	(OF) theAttributeCount The attribute names
theAttributeValCounts	(OF) theAttributeCount The attribute value count
theAttributeOptimizedValues	(OF) theAttributeCount The attribute values
theAttributeOptimizedUnits	(OF) theAttributeCount The attribute units

ICS_API int ICS_ico_ask_class	(	tag_t	theICOTag,
		char **	theClassId
	)

Returns the class id of the class the ICO is stored in

If the ICO is stored in a (legacy) sml-subclass theClassId has the following format:

classid::subclassid

Parameters

theICOTag	(I) The Tag of the ICO
theClassId	(OF) The Id of the Class

ICS_API int ICS_ico_ask_class_tag	(	tag_t	theICOTag,
		tag_t *	theClassTag
	)

Returns the tag of the class the ICO is stored in

Parameters

theICOTag	(I) The Tag of the ICO
theClassTag	(O) The tag of the Class

ICS_API int ICS_ico_ask_classified_object	(	tag_t	theICOTag,
		tag_t *	theClassifiedObject
	)

Returns the tag of the worksoace object the ICO classifies

Parameters

theICOTag	(I) The Tag of the ICO
theClassifiedObject	(OF) The Classified WSO

ICS_API int ICS_ico_ask_localizable_properties	(	tag_t	theICOTag,
		int *	theAttributeCount,
		int **	theAttributeIds
	)

Returns the list of localizable ICO attributes

Parameters

theICOTag	(I) The ICO Tag
theAttributeCount	(O) The Attribute count
theAttributeIds	(OF) theAttributeCount The Localizable Attribute Ids

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
	)

Asks one or more values of a string property. The property can be single-valued or multi-valued (i.e., array or list).

Parameters

theICOTag	(I) The ICO Tag
theAttributeId	(I) Attribute Id of the ICO
locale	(I) The locale of the property value
theAttributeValCount	(O) Number of values returned.
theAttributeValues	(OF) theAttributeValCount The num values of the property. This must be a list or array of constant chars.
localization_statuses	(OF) theAttributeValCount The list of localization statuses each applicable to the corresponding property value in the values array.
isMaster	(O) specifies if the locale specified as input is the master locale for each property value in the values array.

ICS_API int ICS_ico_ask_named_attributes	(	tag_t	theICOTag,
		int	theAttributeCount,
		int *	theAttributeIds,
		int **	theAttributeValCounts,
		char ****	theAttributeValues
	)

Returns the values of the given attributes

Parameters

theICOTag	(I) The Tag of the ICO
theAttributeCount	(I) The attribute count
theAttributeIds	(I) The attributes
theAttributeValCounts	(OF) theAttributeCount The count of attribute values
theAttributeValues	(OF) theAttributeCount The attribute values

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
	)

Auto-compute attribute values for classification object (ICO) based on custom program registered with BMF_ICS_exec_custom_attribute_logic operation in BMIDE

Parameters

theICOid	(I) ICO id
theClassId	(I) Class id
theViewId	(I) View id
theUnitSystem	(I) Unit System of the ICO
theWsoTag	(I) Workspace object tag that is being classified
theMode	(I) AutoCompute operation mode
theAttributeCount	(I) The number of attributes
theAttributeIds	(I) Array of attribute ids
theAttrValueCounts	(I) Array of attribute value count
theAttributeValues	(I) Array of attribute values
theAttributeLengths	(I) Array of attribute array sizes
theAttributeUnits	(I) Array of attribute units
theAttributeFlags	(I) Array of attribute flags
theModifiedFlag	(I) Array of flags specifying the updated attributes
theAutoComputedCount	(O) The number of auto computed attributes
theAutoComputedIds	(OF) theAutoComputedCount Array of auto computed attribute ids
theAutoComputedValueCounts	(OF) theAutoComputedCount Array of attribute value count
theAutoComputedValues	(OF) theAutoComputedCount Array of auto computed attribute values
theAutoComputedLengths	(OF) theAutoComputedCount Array of attribute array sizes
theAutoComputedUnits	(OF) theAutoComputedCount Array of auto computed attribute units
theAutoComputedFlags	(OF) theAutoComputedCount Array of auto computed attribute flags

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
	)

Create a new ICO

Parameters

theICOId	(I) The id of the ICO. Will be ignored i theClassifiedObjectTag is != NULLTAG
theClassifiedObjectTag	(I) The WSO to classify with the new ICO
theClassId	(I) The id of the class the ICo should be stored in
theAttributeCount	(I) The number of attribute id/values given
theAttributeId	(I) The attribute ids
theAttributeValues	(I) The values for the listed Attributes
theICOTag	(O) The Tag of the created ICO

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
	)

Parameters

theICOId	(I) The id of the ICO. Will be ignored i theClassifiedObjectTag is != NULLTAG
theClassifiedObjectTag	(I) The WSO to classify with the new ICO
theClassId	(I) The id of the class the ICo should be stored in
theAttributeCount	(I) The number of attribute id/values given
theAttributeId	(I) The attribute ids
theAttributeValCounts	(I) The attribute value count
theAttributeValues	(I) The values for the listed Attributes
theICOTag	(O) The Tag of the created ICO

ICS_API int ICS_ico_create_wso	(	const char *	theClassId,
		int	theAttrCount,
		int *	theAttrIds,
		char **	theAttrValues,
		int	theOptions,
		tag_t *	theWSO
	)

Creates a new Item in inClass. The function is called by inClass Server before the save action of an ICO. The Classification Server provides the necessary Data as input (arrays) parameter for the call. These are the Classification Class ID and the attributes from the Dialog appearing when pressing the Save Button if the ICS_create_wso_on_save is set to "yes". The first thing to be done by the interface is to generate the attributes defined by the mapping preferences. Then it must check the validity and existence of the attributes according to the preferences. If all checks are done and don't result in a roll back, the workspace object (Item/Item Revision) will be created. Once the WSO is created the relevant Seed Data will be copied and related to the WSO according to the Seed Part.

Parameters

theAttrCount	(I) The unique Id of the Class
theAttrIds	(I) The count of the attributes
theAttrValues	(I) The attribute Ids
theOptions	(I) The attribute values
theWSO	(I) Placeholder for future use (O) Tag of the WSO

ICS_API int ICS_ico_find	(	const char *	theICOId,
		tag_t	theClassifiedObjectTag,
		int	theOptions,
		int *	theCount,
		tag_t **	theICOTags
	)

Find the ICO identified by its id and/or classified object tag e.g.

find ICO with a given ID ( ignore WSO tag )
ICS_ico_find( id, wsoTag, 0, &count, &icoTags );

Find ICO for given WSO tag ( ignoring id )
ICS_ico_find( "", wsoTag, 1, &count, &icoTags );

Find ICO with given id where WSO is null tag
ICS_ico_find( id, NULLTAG, 1, &count, &icoTags );

Parameters

theICOId	(I) The id of the ICO
theClassifiedObjectTag	(I) The classified WSO
theOptions	(I) 0 or 1. If 0, then ICO will be searched only using theICOId. The value of theClassifiedObjectTag will be ignored, even if specified. If 1, the ICOs will be searched using theICOId and theClassifiedObjectTag both
theCount	(O) No of ICOs found
theICOTags	(OF) theCount Tags of ICOs found

ICS_API int ICS_ico_find_values	(	int	theExprCount,
		int *	theAttrIds,
		char **	theAttrExpr,
		int	theOptions,
		int	theAttributeId,
		int *	theCount,
		char ***	theValues,
		int **	theValueCounts
	)

Search the distinct list of values in the given context for theAttributeId The function will search for all ICOs using the given criteria (theAttrIds/theAttrExpr)

Parameters

theExprCount	(I) The count of expressions
theAttrIds	(I) The attribute Ids
theAttrExpr	(I) Array of expressions
theOptions	(I) Placeholder for future use
theAttributeId	(I) The attribute Id for which the values are being returned
theCount	(O) the value count
theValues	(OF) theCount The values
theValueCounts	(OF) theCount The count of values

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
	)

Search the distinct list of values in the given context for theAttributeId The function will search for all ICOs using the given criteria (theAttrIds/theAttrExpr) In addition to ICS_ico_find_values() this function returns a display value

Parameters

theExprCount	(I) The count of expressions
theAttrIds	(I) The attribute Ids
theAttrExpr	(I) Array of expressions
theOptions	(I)
theAttributeId	(I)
theCount	(O) The value count
theValues	(OF) theCount The values
theValueCounts	(OF) theCount The value count
theDisplayValues	(OF) theCount The display values

ICS_API int ICS_ico_free_attributes	(	int	theAttributeCount,
		int *	theAttributeIds,
		int *	theAttributeValCounts,
		char ***	theAttributeValues
	)

Returns all attributes of the given ICO without using a view

Parameters

theAttributeCount	(I) The attribute count
theAttributeIds	(I) The attributes
theAttributeValCounts	(I) The attribute value count
theAttributeValues	(I) The attribute values

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
	)

Map the source ICO identified by theSourceICOTag to the new target item and ICO identified by theTargetItemID. The target ICO will be created in the Classification class having theTargetClassID.

Parameters

theSourceICOTag	(I) The tag of the ICO to be mapped
theTargetItemID	(I) The ID of the new target item
theTargetItemName	(I) The new target item's name
theTargetItemTypeName	(I) The name of the target item type
theTargetItemRevID	(I) The ID of the new item Revision
theTargetItemDescription	(I) The new target item's decription
theTargetClassID	(I) The ID of the class to map to
theOptions	(I) Options to the mapping process
theNewICOTag	(O) The new target ICO

ICS_API int ICS_ico_move	(	int	theCount,
		const tag_t *	theICOTags,
		const char *	theNewClass,
		int *	theErrorCount,
		tag_t **	theUnsuccessfulICOTags,
		int **	theErrorCodes,
		char ***	theErrorMessages
	)

moves ICO to the given new class

Parameters

theCount	(I) The count
theICOTags	(I) The tags of the ICO
theNewClass	(I) The destination class
theErrorCount	(O) The count of errors
theUnsuccessfulICOTags	(OF) theErrorCount The tags of ICOs failed to move
theErrorCodes	(OF) theErrorCount The error codes
theErrorMessages	(OF) theErrorCount The error messages

ICS_API int ICS_ico_property_isLocalizable	(	tag_t	theICOTag,
		const int	theAttributeId,
		logical *	isLocalizable
	)

Returns true if the ICO attribute is localizable

Parameters

theICOTag	(I) The ICO Tag
theAttributeId	(I) The Attribute id
isLocalizable	(O) is Localizable

ICS_API int ICS_ico_reassign_to_rev ( tag_t theICOTag )

Checks if the provided Classification Object (ICO) classifies an item. If yes, it modifies the internal data structures such that after completion the ICO will classify the item's latest revision instead of the item itself.

Return values:

ITK_ok - The ICO does not classify an item, or it was successfully reassigned to the item's latest revision

Parameters

theICOTag (I) The tag of the ICO to be reassociated

ICS_API int ICS_ico_remove ( tag_t theICOTag )

Remove the ICO identified by theICOTag from the database

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
	)

This function executes the POM enquiry resulting from the theAttrIds and theAttrExpr. theOptions affects the search, the following values can be used: ICS_SEARCH_THIS_CLASS_ONLY, ICS_SEARCH_CASE_INSENSITIVE, ICS_SEARCH_ORDER_BY_ID and/or ICS_SEARCH_IN_BOTH_UNIT_SYSTEMS.

The out parameters accept NULL pointer to indicate that this parameter should not be returned. If not specified by theOptions, the out parameters are sorted by the values for the given search attributes. If no search attributes are gives, then they are sorted by theICOIds.

Note: For more compilcated queries use the ICS_enquiry_ functions (ics_enquiry.h)

Parameters

theExprCount	(I) The number of attributss
theAttrIds	(I) theExprCount Array of attributes to search for
theAttrExpr	(I) theExprCount A search string for each attribute in theAttrIds
theOptions	(I) The enquiry options: ICS_SEARCH_THIS_CLASS_ONLY to limit search results to the class with the unique ID, theClassId. ICS_SEARCH_CASE_INSENSITIVE to search without case sensitivity. ICS_SEARCH_ORDER_BY_ID to sort the result by object ids. ICS_SEARCH_IN_BOTH_UNIT_SYSTEMS to search in both unit systems. If this option is used then you need to specify the active unitsystem -630 = 0/1 (metric/non-metric) as theAttrIds & theAttrExpr. This determines in which unit system the returned attribute values are displayed
theCount	(O) The number of found ICOs.
theICOTags	(OF) theCount The tags of the found ICOs.
theICOUIDs	(OF) theCount The UIDs of the found ICOs.
theICOIds	(OF) theCount The IDs of the found ICOs.
theClassIds	(OF) theCount The Class IDs of the found ICOs.
theWSOTags	(OF) theCount The workspace object tags of the found ICOs.
theWSOUIDs	(OF) theCount The workspace object UIDs of the found ICOs.

ICS_API int ICS_ico_search_count	(	int	theExprCount,
		int *	theAttrIds,
		char **	theAttrExpr,
		int	theOptions,
		int *	theCount
	)

This function executes the POM enquiry resulting from the theAttrIds and theAttrExpr. theOptions affects the search, the following values can be used: ICS_SEARCH_THIS_CLASS_ONLY, ICS_SEARCH_CASE_INSENSITIVE and/or ICS_SEARCH_ORDER_BY_ID.

The out parameters accept NULL pointer to indicate that this parameter should not be returned. If not specified by theOptions, the out parameters are sorted by the values for the given search attributes. If no search attributes are gives, then they are sorted by theICOIds.

Note: For more compilcated queries use the ICS_enquiry_ functions (ics_enquiry.h)

Parameters

theExprCount	(I) The number of attributss
theAttrIds	(I) theExprCount Array of attributes to search for
theAttrExpr	(I) theExprCount A search string for each attribute in theAttrIds
theOptions	(I) The enquiry options: ICS_SEARCH_THIS_CLASS_ONLY to limit search results to the class with the unique ID, theClassId. ICS_SEARCH_CASE_INSENSITIVE to search without case sensitivity. ICS_SEARCH_ORDER_BY_ID to sort the result by object ids.
theCount	(O) The number of found ICOs.

ICS_API int ICS_ico_set_attributes	(	tag_t	theICOTag,
		int	theAttributeCount,
		int *	theAttributeIds,
		int *	theAttributeValCounts,
		const char ***	theAttributeValues
	)

Sets all attributes of the given ICO

Parameters

theICOTag	(I) The Tag of the ICO
theAttributeCount	(I) The attribute count
theAttributeIds	(I) The attributes
theAttributeValCounts	(I) The count of attribute values
theAttributeValues	(I) The attribute values

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
	)

Sets one or more values on a string property.

Parameters

theICOTag	(I) The ICO Tag
noAttributes	(I) The Attribute count
theAttributeIds	(I) List of attribute Id
locale	(I) locale for which the value need to set
theAttributeValCount	(I) Array of number of values
theAttributeValues	(I) List of value array
localization_statuses	(I) Array of localisation
isMaster	(I) Flag to Indicate wether the locale is master

ICS_API int ICS_ico_where_used	(	const char *	theICOId,
		int *	theCount,
		tag_t **	theTagsWhereUsed
	)

Returns the tag of the ICOs whare the given ICO is used

Parameters

theICOId	(I) The id of the ICO to find where used
theCount	(O) The number of references found
theTagsWhereUsed	(OF) theCount The list of ICO where the ICO is used

ICS_API logical ICS_is_attribute ( tag_t theTag )