ITK Function Reference
(V10000.1.0.60_20160308.00)
Modules | Data Structures | Macros | Typedefs | Enumerations | Functions
Item

Modules

 ITEM Errors
 
 ITEM Messages
 

Data Structures

struct  ITEM_attached_object_s
 
struct  ITEM_attached_object_tag_s
 
struct  ITEM_deepcopy_info_s
 

Macros

#define ITEM_copy_as_object   "copy_as_object"
 
#define ITEM_copy_as_reference   "copy_as_reference"
 
#define ITEM_desc_size_c   240
 
#define ITEM_id_size_c   128
 
#define ITEM_item_class_name_c   "Item"
 
#define ITEM_ITEM_ID_PROP   "item_id"
 
#define ITEM_name_size_c   WSO_name_size_c
 
#define ITEM_no_copy   "no_copy"
 
#define ITEM_relate_to_latest   "relate_to_latest"
 
#define ITEM_rev_class_name_c   "ItemRevision"
 
#define ITEM_revise_and_relate_to_latest   "revise_and_relate_to_latest"
 
#define ITEM_revise_operation   "Revise"
 
#define ITEM_saveas_operation   "SaveAs"
 
#define ITEM_select   "select"
 
#define ITEM_system_copy   "system_copy"
 
#define ITEM_type_size_c   32
 

Typedefs

typedef struct
ITEM_attached_object_s 		ITEM_attached_object_t
 
typedef struct
ITEM_attached_object_tag_s 		ITEM_attached_object_tag_t
 
typedef enum ITEM_attachment_type_e ITEM_attachment_type_t
 
typedef struct ITEM_deepcopy_info_s ITEM_deepcopy_info_t
 

Enumerations

enum  ITEM_attachment_type_e {
  ITEM_item_master_atth, ITEM_manifestation_atth, ITEM_requirement_atth, ITEM_specification_atth,
  ITEM_reference_atth, ITEM_master_data_atth, ITEM_bom_view_atth, ITEM_bvr_atth,
  ITEM_revision_atth, ITEM_unknown_atth
}
 

Functions

TCCORE_API int ITEM_ask_attachment_name (tag_t attachment_type, char **name)
 
TCCORE_API int ITEM_ask_has_module (tag_t item, logical *is_module)
 
TCCORE_API int ITEM_ask_rev_description (tag_t rev, char rev_desc[ITEM_desc_size_c+1])
 
TCCORE_API int ITEM_ask_rev_description2 (tag_t rev, char **rev_desc)
 
TCCORE_API int ITEM_ask_rev_id (tag_t rev, char rev_id[ITEM_id_size_c+1])
 
TCCORE_API int ITEM_ask_rev_id2 (tag_t rev, char **rev_id)
 
TCCORE_API int ITEM_ask_rev_name (tag_t rev, char rev_name[ITEM_name_size_c+1])
 
TCCORE_API int ITEM_ask_rev_name2 (tag_t rev, char **rev_name)
 
TCCORE_API int ITEM_ask_rev_type (tag_t rev, char rev_type[ITEM_type_size_c+1])
 
TCCORE_API int ITEM_ask_rev_type2 (tag_t rev, char **rev_type)
 
TCCORE_API int ITEM_ask_rev_variants (tag_t rev, tag_t *variant_expression_block)
 
TCCORE_API int ITEM_attach_object_tag (tag_t item, tag_t object, tag_t attachment_type)
 
TCCORE_API int ITEM_attach_rev_object (tag_t rev, tag_t object, ITEM_attachment_type_t attachment_type)
 
TCCORE_API int ITEM_attach_rev_object_tag (tag_t rev, tag_t object, tag_t attachment_type)
 
TCCORE_API int ITEM_create_ic_baseline_rev (tag_t rev, tag_t bom_window, const char *copy_rules_key, const char *name, const char *desc, const char *id, const char *rev_id, tag_t *new_rev)
 
TCCORE_API int ITEM_detach_object_tag (tag_t item, tag_t object, tag_t attachment_type)
 
TCCORE_API int ITEM_detach_rev_object (tag_t rev, tag_t object, ITEM_attachment_type_t attachment_type)
 
TCCORE_API int ITEM_detach_rev_object_tag (tag_t rev, tag_t object, tag_t attachment_type)
 
TCCORE_API int ITEM_exit_module ()
 
TCCORE_API int ITEM_find_in_idcontext (const char *id, tag_t idcontext_tag, int *num_items, tag_t **item_tags)
 
TCCORE_API int ITEM_find_item_in_idcontext (const char *id, tag_t idcontext_tag, tag_t *item_tag)
 
TCCORE_API int ITEM_find_revs_in_idcontext (const char *id, const char *rev_id, tag_t idcontext_tag, int *num_revs, tag_t **rev_tags)
 
TCCORE_API int ITEM_id_exists (const char *id, logical *verdict)
 
TCCORE_API int ITEM_id_owners (const char *id, int *num_objs, tag_t **obj_tags)
 
TCCORE_API int ITEM_init_module ()
 
TCCORE_API int ITEM_list_all_attachments_tag (tag_t item, int *count, ITEM_attached_object_tag_t **objects)
 
TCCORE_API int ITEM_list_all_rev_attachments (tag_t rev, int *count, ITEM_attached_object_t **objects)
 
TCCORE_API int ITEM_list_attachs_of_type_tag (tag_t item, tag_t attachment_type, int *count, tag_t **tag_list)
 
TCCORE_API int ITEM_list_possible_attachments_tag (const char *obj_type, int *count, tag_t **attachment_types)
 
TCCORE_API int ITEM_list_rev_attachs_of_type (tag_t rev, ITEM_attachment_type_t relation_type, int *count, ITEM_attached_object_t **objects)
 
TCCORE_API int ITEM_perform_deepcopy_using (tag_t new_item_rev, char *operation, tag_t parent_item_rev, const int option_count, const tag_t *obj_tags, const char **copy_option, const char **option_names, const char **relation_types, int *count, tag_t **deepcopiedobjects)
 
TCCORE_API int ITEM_rev_ask_effectivity_mappings (tag_t itemrev, int *n, tag_t **mappings)
 
TCCORE_API int ITEM_rev_ask_gde_bvr (tag_t item_rev_tag, tag_t view_type, tag_t *gde_bvr_tag)
 
TCCORE_API int ITEM_rev_ask_has_module (tag_t item_rev, logical *is_module)
 
TCCORE_API int ITEM_rev_create_gde_bvr (tag_t item_rev_tag, tag_t view_type, tag_t *gde_bvr_tag)
 
TCCORE_API int ITEM_rev_delete_bvr (tag_t rev, tag_t bvr)
 
TCCORE_API int ITEM_rev_list_all_bom_view_revs (tag_t rev, int *count, tag_t **bvrs)
 
TCCORE_API int ITEM_rev_list_bom_view_revs (tag_t rev, int *count, tag_t **bvrs)
 
TCCORE_API int ITEM_set_rev_description (tag_t rev, const char *rev_desc)
 
TCCORE_API int ITEM_set_rev_id (tag_t rev, const char *rev_id)
 
TCCORE_API int ITEM_set_rev_name (tag_t rev, const char *rev_name)
 
TCCORE_API int ITEM_set_rev_variants (tag_t rev, tag_t variant_expression_block)
 
TCCORE_API int ITEM_translate_rev_mvl (tag_t from_rev, tag_t to_rev, int n_modules, char **from_modules, char **to_modules)
 
TCCORE_API int ITEM_update_rev_attachment (tag_t rev, tag_t old_object, ITEM_attachment_type_t attachment_type, tag_t new_object)
 

Item Functions

TCCORE_API int ITEM_create_item (const char *item_id, const char *item_name, const char *item_type, const char *rev_id, tag_t *item, tag_t *rev)
 
TCCORE_API int ITEM_create_item_with_masters (const char *item_id, const char *item_name, const char *item_type, const char *rev_id, tag_t item_master_form_tag, tag_t item_rev_master_form_tag, tag_t *item, tag_t *rev)
 
TCCORE_API int ITEM_create_item2 (const char *type_name, int numAttrs, char **attrNames, char **attrValues, const char *rev_id, tag_t *item, tag_t *rev)
 
TCCORE_API int ITEM_create_item_with_masters2 (const char *type_name, int numAttrs, char **attrNames, char **attrValues, const char *rev_id, tag_t item_master_tag, tag_t item_rev_master_tag, tag_t *item, tag_t *rev)
 
TCCORE_API int ITEM_save_item (tag_t item)
 
TCCORE_API int ITEM_delete_item (tag_t item)
 
TCCORE_API int ITEM_extent (int *count, tag_t **item_list)
 
TCCORE_API int ITEM_find_item (const char *search_id, tag_t *item)
 
TCCORE_API int ITEM_find (const char *item_id, int *n_items, tag_t **item_tags)
 
TCCORE_API int ITEM_find_items_by_key_attributes (int num_attributes, const char **attribute_names, const char **attribute_values, int *n_items, tag_t **item_tags)
 
TCCORE_API int ITEM_find_items_by_string (const char *av_string, int *n_items, tag_t **item_tags)
 
TCCORE_API int ITEM_find_item_revs_by_key_attributes (int num_attributes, const char **attribute_names, const char **attribute_values, const char *rev_id, int *n_items, tag_t **item_tags)
 
TCCORE_API int ITEM_find_item_revs_by_string (const char *av_string, int *n_items, tag_t **item_tags)
 
TCCORE_API int ITEM_find_item_revs_by_string_and_revid (const char *av_string, const char *revid, int *n_items, tag_t **item_tags)
 
TCCORE_API int ITEM_exists (int num_attributes, const char **attribute_names, const char **attribute_values, logical *exists)
 
TCCORE_API int ITEM_exists_in_domain (const char *type_name, const int num_attributes, const char **attribute_names, const char **attribute_values, logical *exists)
 
TCCORE_API int ITEM_rev_get_key_string (tag_t item_revision_tag, char **key_string)
 
TCCORE_API int ITEM_ask_key_string_for_item (tag_t item, char **key)
 
TCCORE_API int ITEM_ask_latest_rev (tag_t item, tag_t *rev)
 
TCCORE_API int ITEM_list_all_revs (tag_t item, int *count, tag_t **rev_list)
 
TCCORE_API int ITEM_list_bom_views (tag_t item, int *count, tag_t **bv_list)
 
TCCORE_API int ITEM_attach_object (tag_t item, tag_t object, ITEM_attachment_type_t attachment_type)
 
TCCORE_API int ITEM_detach_object (tag_t item, tag_t object, ITEM_attachment_type_t attachment_type)
 
TCCORE_API int ITEM_list_attachs_of_type (tag_t item, ITEM_attachment_type_t attachment_type, int *count, ITEM_attached_object_t **objects)
 
TCCORE_API int ITEM_list_all_attachments (tag_t item, int *count, ITEM_attached_object_t **objects)
 
TCCORE_API int ITEM_copy_item (tag_t rev, const char *new_item_id, const char *new_rev_id, tag_t *new_item, tag_t *new_rev)
 
TCCORE_API int ITEM_copy_item_with_masters (tag_t rev, const char *new_item_id, const char *new_rev_id, tag_t item_master_form_tag, tag_t item_rev_master_form_tag, tag_t *new_item, tag_t *new_rev)
 
TCCORE_API int ITEM_update_item_attachment (tag_t item, tag_t old_object, ITEM_attachment_type_t attachment_type, tag_t new_object)
 
TCCORE_API int ITEM_ask_unit_of_measure (tag_t item, tag_t *uom)
 
TCCORE_API int ITEM_set_unit_of_measure (tag_t item, tag_t uom)
 
TCCORE_API int ITEM_ask_id (tag_t item, char item_id[ITEM_id_size_c+1])
 
TCCORE_API int ITEM_ask_id2 (tag_t item, char **item_id)
 
TCCORE_API int ITEM_set_id (tag_t item, const char *item_id)
 
TCCORE_API int ITEM_ask_name (tag_t item, char item_name[ITEM_name_size_c+1])
 
TCCORE_API int ITEM_ask_name2 (tag_t item, char **item_name)
 
TCCORE_API int ITEM_set_name (tag_t item, const char *item_name)
 
TCCORE_API int ITEM_ask_description (tag_t item, char item_desc[ITEM_desc_size_c+1])
 
TCCORE_API int ITEM_ask_description2 (tag_t item, char **item_desc)
 
TCCORE_API int ITEM_set_description (tag_t item, const char *item_desc)
 
TCCORE_API int ITEM_ask_type (tag_t item, char item_type[ITEM_type_size_c+1])
 
TCCORE_API int ITEM_ask_type2 (tag_t item, char **item_type)
 

Item Revision Functions

TCCORE_API int ITEM_create_rev (tag_t item, const char *rev_id, tag_t *rev)
 
TCCORE_API int ITEM_create_rev_with_master (tag_t item, const char *rev_id, tag_t item_rev_master_form_tag, tag_t *rev)
 
TCCORE_API int ITEM_save_rev (tag_t rev)
 
TCCORE_API int ITEM_delete_rev (tag_t rev)
 
TCCORE_API int ITEM_extent_rev (int *count, tag_t **list)
 
TCCORE_API int ITEM_find_rev (const char *search_id, const char *rev_id, tag_t *rev_tag)
 
TCCORE_API int ITEM_find_revision (tag_t item, const char *rev_id, tag_t *rev_tag)
 
TCCORE_API int ITEM_find_revisions (tag_t item, const char *rev_id, int *n_revs, tag_t **rev_tags)
 
TCCORE_API int ITEM_ask_item_of_rev (tag_t rev, tag_t *item)
 
TCCORE_API int ITEM_copy_rev_using (tag_t rev, const char *new_rev_id, const int option_count, ITEM_deepcopy_info_t *user_options, tag_t *new_rev, int *count, tag_t **deep_copied_objects)
 
TCCORE_API int ITEM_copy_rev (tag_t rev, const char *new_rev_id, tag_t *new_rev_tag)
 
TCCORE_API int ITEM_copy_rev_with_master (tag_t rev, const char *new_rev_id, tag_t item_rev_master_form_tag, tag_t *new_rev_tag)
 

Item Baseline Functions

TCCORE_API int ITEM_baseline_rev (tag_t rev, const char *new_rev_id, const char *desc, const char *rel_proc_name, const char *jobName, const char *jobDescription, tag_t *new_rev_tag, int *deepCopiedObjCount, tag_t **deepCopiedObjs)
 
TCCORE_API int ITEM_dryrun_baseline (tag_t rev, const char *rel_proc_name, char **logFileName, char **fullLogFileName)
 
TCCORE_API int ITEM_rev_find_base_rev (tag_t baseline_rev, tag_t *base_rev)
 
TCCORE_API int ITEM_rev_list_baselineRevs (tag_t base_rev, const char *baselineStatusName, int *n_revs, tag_t **baseline_revs)
 

Deep Copy Functions

TCCORE_API int ITEM_perform_deepcopy (tag_t new_item_rev, char *operation, tag_t parent_item_rev, int *count, tag_t **deepcopiedobjects)
 
TCCORE_API int ITEM_perform_deepcopy_using2 (tag_t new_item_rev, char *operation, tag_t parent_item_rev, const int option_count, const tag_t *obj_tags, const char **copy_types, const char **obj_names, const char **relation_types, const char **copy_relations, int *count, tag_t **deepcopiedobjects)
 

VI Functions

TCCORE_API int ITEM_ask_is_vi (tag_t item, logical *is_vi)
 
TCCORE_API int ITEM_vi_ask_sos (tag_t item, tag_t *db_sos)
 
TCCORE_API int ITEM_vi_ask_generic_component (tag_t item, tag_t *module_item_rev)
 
TCCORE_API int ITEM_vi_ask_is_linked_to_generic (tag_t item, logical *is_linked)
 
TCCORE_API int ITEM_vi_unlink_from_generic (tag_t item)
 
TCCORE_API int ITEM_vi_find (tag_t generic_item_rev, int n, tag_t *items, char **options, int *ops, int *valueTypes, char **lowValues, char **highValues, int *n_matches, tag_t **matches)
 

ITEM Exclude List

TCCORE_API void ITEM_free_exclude_list ()
 
TCCORE_API void ITEM_build_exclude_list (int array_length, tag_t *exclude_array)
 
TCCORE_API void ITEM_get_exclude_list (int *count, tag_t **exclude_list)
 

Detailed Description

Common Return Values

Return Value Description
ITEM_cant_change_uom

Item's Unit Of Measure (UOM) is not modifiable by you. This is the basic error returned on failure. Examination of the error stack will show you one of the following errors:

ITEM_used_in_structure - Unit of measure cannot be modified as the Item is used within a structure.
ITEM_rev_is_released - Unit of measure cannot be modified as a revision of the Item has been released.

ITEM_duplicate_rev Item already has a revision with the rev ID you gave.

Macro Definition Documentation

#define ITEM_copy_as_object   "copy_as_object"

Definition at line 60 of file item.h.

#define ITEM_copy_as_reference   "copy_as_reference"

Definition at line 61 of file item.h.

#define ITEM_desc_size_c   240

Definition at line 71 of file item.h.

#define ITEM_id_size_c   128

Definition at line 68 of file item.h.

#define ITEM_item_class_name_c   "Item"

Definition at line 52 of file item.h.

#define ITEM_ITEM_ID_PROP   "item_id"

Definition at line 55 of file item.h.

#define ITEM_name_size_c   WSO_name_size_c

Definition at line 69 of file item.h.

#define ITEM_no_copy   "no_copy"

Definition at line 64 of file item.h.

#define ITEM_relate_to_latest   "relate_to_latest"

Definition at line 62 of file item.h.

#define ITEM_rev_class_name_c   "ItemRevision"

Definition at line 53 of file item.h.

#define ITEM_revise_and_relate_to_latest   "revise_and_relate_to_latest"

Definition at line 63 of file item.h.

#define ITEM_revise_operation   "Revise"

Definition at line 57 of file item.h.

#define ITEM_saveas_operation   "SaveAs"

Definition at line 58 of file item.h.

#define ITEM_select   "select"

Definition at line 65 of file item.h.

#define ITEM_system_copy   "system_copy"

Definition at line 66 of file item.h.

#define ITEM_type_size_c   32

Definition at line 70 of file item.h.

Typedef Documentation

typedef struct ITEM_attached_object_s ITEM_attached_object_t
typedef struct ITEM_attached_object_tag_s ITEM_attached_object_tag_t
typedef enum ITEM_attachment_type_e ITEM_attachment_type_t
typedef struct ITEM_deepcopy_info_s ITEM_deepcopy_info_t

Enumeration Type Documentation

enum ITEM_attachment_type_e
Enumerator
ITEM_item_master_atth 
ITEM_manifestation_atth 
ITEM_requirement_atth 
ITEM_specification_atth 
ITEM_reference_atth 
ITEM_master_data_atth 
ITEM_bom_view_atth 

Reserved for future enhancement.

ITEM_bvr_atth 

Reserved for future enhancement.

ITEM_revision_atth 

Reserved for future enhancement.

ITEM_unknown_atth 

Definition at line 73 of file item.h.

Function Documentation

TCCORE_API int ITEM_ask_attachment_name ( tag_t  attachment_type,
char **  name 
)

DEPRECATED FUNCTION

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use TCTYPE_ask_name to get the name of a GRM relation type.
Parameters
attachment_type(I)
name(OF)
TCCORE_API int ITEM_ask_description ( tag_t  item,
char  item_desc[ITEM_desc_size_c+1] 
)
Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use ITEM_ask_description2

This function will get the description of the Item.

Parameters
item(I) Tag of an Item
item_desc(O) Description of an Item
TCCORE_API int ITEM_ask_description2 ( tag_t  item,
char **  item_desc 
)

This function will get the description of the Item.

Parameters
item(I) Tag of an Item
item_desc(OF) Description of an Item
TCCORE_API int ITEM_ask_has_module ( tag_t  item,
logical *  is_module 
)

Used to determine whether or not an item has any item revisions that are modules.

Parameters
item(I) The item being queried
is_module(O) True if the item has a module, otherwise false
TCCORE_API int ITEM_ask_id ( tag_t  item,
char  item_id[ITEM_id_size_c+1] 
)
Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use ITEM_ask_id2

This function will get the Item ID of the Item.

Id in Context = NO: Returns Item.item_id.
Id in Context = YES: Returns Item.item_id.

Parameters
item(I) Tag of an Item
item_id(O) ID of an Item
TCCORE_API int ITEM_ask_id2 ( tag_t  item,
char **  item_id 
)

This function will get the Item ID of the Item.

Id in Context = NO: Returns Item.item_id.
Id in Context = YES: Returns Item.item_id.

Parameters
item(I) Tag of an Item
item_id(OF) ID of an Item
TCCORE_API int ITEM_ask_is_vi ( tag_t  item,
logical *  is_vi 
)

Used to determine whether or not an item is a variant item.

Parameters
item(I) The item being queried
is_vi(O) True if the item is a variant item, otherwise false
TCCORE_API int ITEM_ask_item_of_rev ( tag_t  rev,
tag_t *  item 
)

This function will return the tag of the Item to which the revision belongs to.

Parameters
rev(I) Tag of a revision
item(O) Tag of the Item of the specific revision tag
TCCORE_API int ITEM_ask_key_string_for_item ( tag_t  item,
char **  key 
)

Retrieves a delimited string representing the key attr/value pairs for the item.

Returns
Parameters
item(I) Tag of Item
key(OF) A delimited string representing the key attr/value pairs for the Item
TCCORE_API int ITEM_ask_latest_rev ( tag_t  item,
tag_t *  rev 
)

This function will return the latest revision of an Item.

Parameters
item(I) Tag of an existing Item
rev(O) Tag of the latest revision of Item
TCCORE_API int ITEM_ask_name ( tag_t  item,
char  item_name[ITEM_name_size_c+1] 
)
Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use ITEM_ask_name2

This function will get the name of the Item.

Parameters
item(I) Tag of an Item
item_name(O) Name of an Item
TCCORE_API int ITEM_ask_name2 ( tag_t  item,
char **  item_name 
)

This function will get the name of the Item.

Parameters
item(I) Tag of an Item
item_name(OF) Name of an Item
TCCORE_API int ITEM_ask_rev_description ( tag_t  rev,
char  rev_desc[ITEM_desc_size_c+1] 
)
Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use ITEM_ask_rev_description2

This function will get the description of the Item Revision.

Parameters
rev(I) Tag of an Item Revision
rev_desc(O) Description of an Item
TCCORE_API int ITEM_ask_rev_description2 ( tag_t  rev,
char **  rev_desc 
)

This function will get the description of the Item Revision.

Parameters
rev(I) Tag of an Item Revision
rev_desc(OF) Description of an Item
TCCORE_API int ITEM_ask_rev_id ( tag_t  rev,
char  rev_id[ITEM_id_size_c+1] 
)
Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use ITEM_ask_rev_id2

This function will get the ID of the Item Revision.

  • Id in Context = NO: Returns ItemRevision.rev_id
  • Id in Context = YES: Returns ItemRevision.rev_id
Parameters
rev(I) Tag of an Item Revision
rev_id(O) ID of the Item Revision
TCCORE_API int ITEM_ask_rev_id2 ( tag_t  rev,
char **  rev_id 
)

This function will get the ID of the Item Revision.

  • Id in Context = NO: Returns ItemRevision.rev_id
  • Id in Context = YES: Returns ItemRevision.rev_id
Parameters
rev(I) Tag of an Item Revision
rev_id(OF) ID of the Item Revision
TCCORE_API int ITEM_ask_rev_name ( tag_t  rev,
char  rev_name[ITEM_name_size_c+1] 
)
Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use ITEM_ask_rev_name2

This function will get the name of the Item Revision.

Parameters
rev(I) Tag of an Item Revision
rev_name(O) Name of the Item Revision
TCCORE_API int ITEM_ask_rev_name2 ( tag_t  rev,
char **  rev_name 
)

This function will get the name of the Item Revision.

Parameters
rev(I) Tag of an Item Revision
rev_name(OF) Name of the Item Revision
TCCORE_API int ITEM_ask_rev_type ( tag_t  rev,
char  rev_type[ITEM_type_size_c+1] 
)
Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use ITEM_ask_rev_type2

This function will get the type of the Item Revision.

Parameters
rev(I) Tag of an Item Revision
rev_type(O) Type of an Item Revision
TCCORE_API int ITEM_ask_rev_type2 ( tag_t  rev,
char **  rev_type 
)

This function will get the type of the Item Revision.

Parameters
rev(I) Tag of an Item Revision
rev_type(OF) Type of an Item Revision
TCCORE_API int ITEM_ask_rev_variants ( tag_t  rev,
tag_t *  variant_expression_block 
)

Returns the variant expression block associated with the specified Item Revision.

Parameters
rev(I) Tag of an Item Revision
variant_expression_block(O) Tag of the variant expression block
TCCORE_API int ITEM_ask_type ( tag_t  item,
char  item_type[ITEM_type_size_c+1] 
)
Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use ITEM_ask_type2

This function will get the type of the Item.

Parameters
item(I) Tag of an Item
item_type(O) Type of an Item
TCCORE_API int ITEM_ask_type2 ( tag_t  item,
char **  item_type 
)

This function will get the type of the Item.

Parameters
item(I) Tag of an Item
item_type(OF) Type of an Item
TCCORE_API int ITEM_ask_unit_of_measure ( tag_t  item,
tag_t *  uom 
)

Enquires the unit of measure in which quantities of this Item must be expressed. Units of measure are objects defined for the Teamcenter Engineering site by the system administrator.

By default, Items have no Unit of Measure (UOM). In this case this function will give NULLTAG. This implies that quantities of such Items are expressed in terms of "Each" or "Pieces". In other words they refer to a discrete number of component parts. In PSE if no specific quantity value is associated with the use of such Items, the default quantity is assumed to be "1 component".

Parameters
item(I) Tag of an Item
uom(O) Returns the tag of the unit of measure assigned to this Item (may be NULLTAG)
TCCORE_API int ITEM_attach_object ( tag_t  item,
tag_t  object,
ITEM_attachment_type_t  attachment_type 
)

DEPRECATED FUNCTION This function will attach an object to an Item with a specific attachment type.

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_create_relation, followed by GRM_save_relation to commit the resulting relation object to the database, then AOM_unlock to release its write lock.
Parameters
item(I) Tag of an existing Item. The Item and object must already be saved for this function to succeed.
object(I) Tag of the object that we want to attach to the Item
attachment_type(I) Attachment type
TCCORE_API int ITEM_attach_object_tag ( tag_t  item,
tag_t  object,
tag_t  attachment_type 
)

DEPRECATED FUNCTION

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_create_relation, followed by AOM_save to commit the resulting relation object to the database, then AOM_unlock to release its write lock.
Parameters
item(I)
object(I)
attachment_type(I)
TCCORE_API int ITEM_attach_rev_object ( tag_t  rev,
tag_t  object,
ITEM_attachment_type_t  attachment_type 
)

DEPRECATED FUNCTION This function will attach an object to the Item Revision with specified attachment type.

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_create_relation, followed by AOM_save to commit the resulting relation object to the database, then AOM_unlock to release its write lock.
Parameters
rev(I) Tag of an existing Item Revision. The Item Revision and object must have already been saved for this function to succeed.
object(I) Tag of the object that we want to attach to the Item.
attachment_type(I) Attachment type.
TCCORE_API int ITEM_attach_rev_object_tag ( tag_t  rev,
tag_t  object,
tag_t  attachment_type 
)

DEPRECATED FUNCTION

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_create_relation, followed by AOM_save to commit the resulting relation object to the database, then AOM_unlock to release its write lock.
Parameters
rev(I)
object(I)
attachment_type(I)
TCCORE_API int ITEM_baseline_rev ( tag_t  rev,
const char *  new_rev_id,
const char *  desc,
const char *  rel_proc_name,
const char *  jobName,
const char *  jobDescription,
tag_t *  new_rev_tag,
int *  deepCopiedObjCount,
tag_t **  deepCopiedObjs 
)

This ITK creates a Baseline Revision for the input Item Revision only. BOMView Revisions attached to the ItemRevision will be copied forward to the new baseline Revision as per deep copy rules. If the baseline_rev_id is empty, then the ITK would generate a Baseline Revision ID using the USER_new_revision_id_from_alt_rule ("PDR", , , , ,) user_exit. The description entered would be set as the description of the Baseline Revision. Once the creation of the Baseline Revision is completed, the Baseline Revision would undergo the release process as given by the rel_proc_name.

Parameters
rev(I) Item Revision that needs to be Baselined
new_rev_id(I) The Revision Id of the Baseline Item Revision
desc(I) Description that needs to be set on the Baseline Item Revision
rel_proc_name(I) Name of the Release Procedure through which the Baseline Revision should under go
jobName(I) Name of the Job
jobDescription(I) Description of the Job
new_rev_tag(O) Item Revision Tag of the Baseline Revision created
deepCopiedObjCount(O)
deepCopiedObjs(OF) deepCopiedObjCount
TCCORE_API void ITEM_build_exclude_list ( int  array_length,
tag_t *  exclude_array 
)
Parameters
array_length(I)
exclude_array(I)
TCCORE_API int ITEM_copy_item ( tag_t  rev,
const char *  new_item_id,
const char *  new_rev_id,
tag_t *  new_item,
tag_t *  new_rev 
)

Creates a new Item based on an existing Item. The initial revision of the new Item is based on the specified revision of the existing Item.

Parameters
rev(I) Tag of an existing revision on which to base the new Item and its initial revision
new_item_id(I) Identification string (ID) of the new Item. A null is allowed. If null, the system will automatically generate an Item ID.
new_rev_id(I) Identification string (revision ID) the initial revision of the new Item. A null is allowed. If null, the system will automatically generate a new revision ID.
new_item(O) Tag of the new Item
new_rev(O) Tag of the initial revision of the new Item
TCCORE_API int ITEM_copy_item_with_masters ( tag_t  rev,
const char *  new_item_id,
const char *  new_rev_id,
tag_t  item_master_form_tag,
tag_t  item_rev_master_form_tag,
tag_t *  new_item,
tag_t *  new_rev 
)

Creates a new Item based on an existing Item. Similar to ITEM_copy_item, except that you can pass pre-populated Item Master and Item Revision Master forms. These forms will be used for the Item and Item Revision. They can be NULLTAG.

The initial revision of the new Item is based on the specified revision of the existing Item.

Parameters
rev(I) Tag of an existing revision on which to base the new Item and its initial revision
new_item_id(I) Identification string (ID) of the new Item. A null is allowed. If null, the system will automatically generate an Item ID.
new_rev_id(I) Identification string (revision ID) the initial revision of the new Item. A null is allowed. If null, the system will automatically generate a new revision ID.
item_master_form_tag(I) Item Master form tag that will be used for the created item. Can be NULLTAG
item_rev_master_form_tag(I) Item Revision Master form tag that will be used for the created item revision. Can be NULLTAG
new_item(O) Tag of the new Item
new_rev(O) Tag of the initial revision of the new Item
TCCORE_API int ITEM_copy_rev ( tag_t  rev,
const char *  new_rev_id,
tag_t *  new_rev_tag 
)

Produces a new revision based on a specified revision of the same Item. This is the same operation as that invoked by the SaveAs->Item Revision action in Workspace.

Parameters
rev(I) Tag of an existing Item
new_rev_id(I) A null is allowed. If null, the system will generate a revision ID
new_rev_tag(O) Tag for identifying the new Item Revision in the current program
TCCORE_API int ITEM_copy_rev_using ( tag_t  rev,
const char *  new_rev_id,
const int  option_count,
ITEM_deepcopy_info_t *  user_options,
tag_t *  new_rev,
int *  count,
tag_t **  deep_copied_objects 
)

Produces a new revision based on a specified revision of the same Item. This is the same operation as that invoked by the SaveAs->Item Revision action in Workspace.

Parameters
rev(I) Tag of an existing Item
new_rev_id(I) A null is allowed. If null, the system will generate a revision ID
option_count(I) The number of objects passed as user_options
user_options(I) The deep copy options
new_rev(O) Tag for identifying the new Item Revision in the current program
count(O) Count of deep copied objects
deep_copied_objects(OF) Tags for newly created objects during deep copy
TCCORE_API int ITEM_copy_rev_with_master ( tag_t  rev,
const char *  new_rev_id,
tag_t  item_rev_master_form_tag,
tag_t *  new_rev_tag 
)

Produces a new revision based on a specified revision of the same Item. Similar to ITEM_copy_rev, except that you can pass pre-populated Item Revision Master form. This form will be used for Item Revision. It can be NULLTAG.

This is the same operation as that invoked by the SaveAs->Item Revision action in Workspace.

Parameters
rev(I) Tag of an existing Item Revision
new_rev_id(I) A null is allowed. If null, the system will generate a revision ID
item_rev_master_form_tag(I) Item Revision Master form tag that will be used for the created item revision. Can be NULLTAG
new_rev_tag(O) Tag for identifying the new Item Revision in the current program
TCCORE_API int ITEM_create_ic_baseline_rev ( tag_t  rev,
tag_t  bom_window,
const char *  copy_rules_key,
const char *  name,
const char *  desc,
const char *  id,
const char *  rev_id,
tag_t *  new_rev 
)
Parameters
rev(I)
bom_window(I)
copy_rules_key(I)
name(I)
desc(I)
id(I)
rev_id(I)
new_rev(O)
TCCORE_API int ITEM_create_item ( const char *  item_id,
const char *  item_name,
const char *  item_type,
const char *  rev_id,
tag_t *  item,
tag_t *  rev 
)
Deprecated:
This function is deprecated and will be removed from Tc11. From Tc9.0 onwards, please use generic creation of BusinessObject(i.e createBusinessObject or TCTYPE_create_object ).

This function creates a new Item with the given name and identification string.

Restrictions:

For a type other than null to be specified, that type must be defined by the site using the install_types utility. If item_type is null, the default type is Item. The item_name will be used as the revision's name.

Note
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.
Parameters
item_id(I) Item identification number. No two Items can have the same identification string. A null is allowed. If null, the system will automatically generate an Item ID.
item_name(I) Item name. A common name or short description of the Item.
item_type(I) A null is allowed for this argument. It can be used to specify a defined Item type.
rev_id(I) Identification string (revision ID) of the Item Revision being created. A null is allowed. If null, the system will automatically generate a revision ID
item(O) Tag for identifying the Item in the current program
rev(O) Tag for identifying the Item Revision in the current program
TCCORE_API int ITEM_create_item2 ( const char *  type_name,
int  numAttrs,
char **  attrNames,
char **  attrValues,
const char *  rev_id,
tag_t *  item,
tag_t *  rev 
)
Deprecated:
This function is deprecated and will be removed from Tc11. From Tc9.0 onwards, please use generic creation of BusinessObject(i.e createBusinessObject or TCTYPE_create_object ).

The ITEM_create_item2() function facilitates creation of an Item with the given input attributes. Attribute Names and their corresponding Attribute values would be passed as input to the ITK along with the attribute count. After validating the input properties this method sets the Attribute Names with the corresponding Attribute values. Following attributes names are passed as input to the ITEM_create_item2 ITK. type_name, Type of Item to be created numAttrs, Number of input attributes attrNames, Names of input attributes attrValues, Values for the input attributes rev_id, Id for the revision

Note
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.
Parameters
type_name(I) Type of Item to be created
numAttrs(I) Number of input attributes
attrNames(I) Names of input attributes
attrValues(I) Values for the input attributes
rev_id(I) Id for the revision
item(O) The created item tag
rev(O) The created item revision tag
TCCORE_API int ITEM_create_item_with_masters ( const char *  item_id,
const char *  item_name,
const char *  item_type,
const char *  rev_id,
tag_t  item_master_form_tag,
tag_t  item_rev_master_form_tag,
tag_t *  item,
tag_t *  rev 
)
Deprecated:
This function is deprecated and will be removed from Tc11. From Tc9.0 onwards, please use generic creation of BusinessObject(i.e createBusinessObject or TCTYPE_create_object ).

Creates an Item. Similar to ITEM_create_item, except that you can pass pre-populated Item Master and Item Revision Master forms. These forms will be used for the Item and Item Revision. They can be NULLTAG.

Note
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.
Parameters
item_id(I) Item identification number. No two Items can have the same identification string. A null is allowed. If null, the system will automatically generate an Item ID
item_name(I) Item name. A common name or short description of the Item
item_type(I) A null is allowed for this argument. It can be used to specify a defined Item type
rev_id(I) Identification string (revision ID) of the Item Revision being created. A null is allowed. If null, the system will automatically generate a revision ID
item_master_form_tag(I) Item Master form tag that will be used for the created item. Can be NULLTAG
item_rev_master_form_tag(I) Item Revision Master form tag that will be used for the created item revision. Can be NULLTAG
item(O) Tag for identifying the Item in the current program
rev(O) Tag for identifying the Item Revision in the current program
TCCORE_API int ITEM_create_item_with_masters2 ( const char *  type_name,
int  numAttrs,
char **  attrNames,
char **  attrValues,
const char *  rev_id,
tag_t  item_master_tag,
tag_t  item_rev_master_tag,
tag_t *  item,
tag_t *  rev 
)
Deprecated:
This function is deprecated and will be removed from Tc11. From Tc9.0 onwards, please use generic creation of BusinessObject(i.e createBusinessObject or TCTYPE_create_object ).

The ITEM_create_item_with_masters2 function creates an Item, similar to ITEM_create_item2 but with pre-populated Item Master and Item Revision Master forms. Item Master and Item Revision Master forms could be passed as arguments to ITEM_create_item_with_masters2 function. These forms will be used for the created Item and Item Revision. If the value for Item Master and Item Revision Master forms are NULL then this function creates an ITEM similar to ITEM_create_item2(). Following arguments are passed to this ITK. 

type_name             Type of Item to be created
numAttrs              Number of input attributes
attrNames             Names of input attributes
attrValues            Values for the input attributes
rev_id                Id for the revision
item_master_tag       Item Master form tag that will be used for the created item
item_rev_master_tag   Item Rev Master form tag that will be used for the created Item Rev
Note
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.
Parameters
type_name(I) Type of Item to be created
numAttrs(I) Number of input attributes
attrNames(I) Names of input attributes
attrValues(I) Values for the input attributes
rev_id(I) Id for the revision
item_master_tag(I) Item Master form tag that will be used for the created item
item_rev_master_tag(I) Item Rev Master form tag that will be used for the created Item Rev
item(O) The created item tag
rev(O) The created item revision tag
TCCORE_API int ITEM_create_rev ( tag_t  item,
const char *  rev_id,
tag_t *  rev 
)
Deprecated:
This function is deprecated and will be removed from Tc11. From Tc9.0 onwards, please use generic creation of BusinessObject(i.e createBusinessObject or TCTYPE_create_object ).

This function creates a new revision of the specified Item.

Note
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object. This function creates an "initial" revision in the same state as the first revision you get on creating a new Item. If you want to create a new revision based on an existing revision, use ITEM_copy_rev.
Parameters
item(I) Tag of an existing Item
rev_id(I) A null is allowed. If null, the system will generate a revision ID.
rev(O) Tag for identifying the new Item Revision in the current program.
TCCORE_API int ITEM_create_rev_with_master ( tag_t  item,
const char *  rev_id,
tag_t  item_rev_master_form_tag,
tag_t *  rev 
)
Deprecated:
This function is deprecated and will be removed from Tc11. From Tc9.0 onwards, please use generic creation of BusinessObject(i.e createBusinessObject or TCTYPE_create_object ).

Creates an Item Revision. Similar to ITEM_create_rev, except that you can pass pre-populated Item Revision Master form. This form will be used for Item Revision. It can be NULLTAG.

Note
This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.
Parameters
item(I) Tag of an existing item
rev_id(I) A null is allowed. If null, the system will generate a revision ID
item_rev_master_form_tag(I) Item Revision Master form tag that will be used for the created item revision
rev(O) Tag for identifying the Item Revision in the current program
TCCORE_API int ITEM_delete_item ( tag_t  item)

This function will delete an Item from the database. Additionally, it will delete all Item revisions and remove all attachments. The attached objects will not be deleted, except for the Item and revision master forms.

Parameters
item(I) Tag for identifying the Item in the current program
TCCORE_API int ITEM_delete_rev ( tag_t  rev)

This function will delete the given revision of an Item. This removes all attachments to the revision. The attached objects themselves will not be deleted, except for the master form.

Parameters
rev(I) Tag for identifying the Item Revision in the current program
TCCORE_API int ITEM_detach_object ( tag_t  item,
tag_t  object,
ITEM_attachment_type_t  attachment_type 
)

DEPRECATED FUNCTION This function will disassociate the object from the Item with the specified attachment type.

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_find_relation to locate the relation object (passing relation_type equivalent to attachment_type), then delete the relation using AOM_delete.
Parameters
item(I) Tag of an existing Item
object(I) Tag of the object that we want to detach from the Item
attachment_type(I) Attachment type
TCCORE_API int ITEM_detach_object_tag ( tag_t  item,
tag_t  object,
tag_t  attachment_type 
)

DEPRECATED FUNCTION

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_find_relation to locate the relation object (passing relation_type equivalent to attachment_type), then delete the relation using AOM_delete.
Parameters
item(I)
object(I)
attachment_type(I)
TCCORE_API int ITEM_detach_rev_object ( tag_t  rev,
tag_t  object,
ITEM_attachment_type_t  attachment_type 
)

DEPRECATED FUNCTION This function will disassociate the object from the Item Revision only for the specified attachment type.

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_find_relation to locate the relation object (passing relation_type equivalent to attachment_type), then delete the relation using AOM_delete.
Parameters
rev(I) Tag of an existing Item Revision
object(I) Tag of an object that you want to detach from the Item
attachment_type(I) Attachment type
TCCORE_API int ITEM_detach_rev_object_tag ( tag_t  rev,
tag_t  object,
tag_t  attachment_type 
)

DEPRECATED FUNCTION

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_find_relation to locate the relation object (passing relation_type equivalent to attachment_type), then delete the relation using AOM_delete.
Parameters
rev(I)
object(I)
attachment_type(I)
TCCORE_API int ITEM_dryrun_baseline ( tag_t  rev,
const char *  rel_proc_name,
char **  logFileName,
char **  fullLogFileName 
)

This ITK creates a does a dryrun of baseline creation for the input Item Revision. It does not create the baseline but runs through all the pre-conditions, user error checks And places the results in the filename pointed by the logFileName, which is placed at the location pointed to, by the fullLogFileName. If there is any error, the ITK returns the error code, which on the top of the error stack.

Parameters
rev(I) Item Revision that needs to be Baselined
rel_proc_name(I) Name of the Release Procedure through which the Baseline Revision should under go
logFileName(OF) Name of the LogFile Generated
fullLogFileName(OF) FullPath of the output logfile, including the logfilename
TCCORE_API int ITEM_exists ( int  num_attributes,
const char **  attribute_names,
const char **  attribute_values,
logical *  exists 
)
Parameters
num_attributes(I) number of attributes
attribute_names(I) Attribute Names
attribute_values(I) Attribute Values
exists(O) true if exists, false otherwise
TCCORE_API int ITEM_exists_in_domain ( const char *  type_name,
const int  num_attributes,
const char **  attribute_names,
const char **  attribute_values,
logical *  exists 
)

Checks if an internal type(e.g. "Item", "Part" etc.) with the input attribute/value pair is unique in a multifield key (MFK) domain corresponding to the specified internal type name.

This function:

  1. Obtains the MFK domain for the provided internal type name (e.g. "Item").
  2. For each provided internal attribute for the type (e.g. "item_id"), checks if the attribute value is unique in the MFK domain.
  3. If all the attribute values are unique, the value of the output parameter "exists" is false. Otherwise, it is true.

This function returns:

If any of the values provided to the parameters "type_name", "attribute_names", "attribute_values" are invalid, no error will be returned and the output parameter "exists" will be false.

Parameters
type_name(I) Internal type_name. It is used to find associated MFK domain.
num_attributes(I) Specifies the number of attributes (or properties) for the given type, for which the uniqueness will be checked.
attribute_names(I) Internal attribute (or property) names (e.g. "item_id", "object_name")
attribute_values(I) Internal attribute (or property) Values . These values uniqueness will be checked in MFK domain.
exists(O) Status of the attributes values uniqueness. The returned value will be true if the value already exists in the MFK domain, false otherwise.
TCCORE_API int ITEM_exit_module ( )
TCCORE_API int ITEM_extent ( int *  count,
tag_t **  item_list 
)

This function will get the list of all the Items in the database.

Parameters
count(O) Total number of Items in the database
item_list(OF) count List of tags for all the Items in the database
TCCORE_API int ITEM_extent_rev ( int *  count,
tag_t **  list 
)

This function will get the list of all the Item revisions in the database.

Parameters
count(O) Total number of Item Revision in the database
list(OF) count List of tags for all the Item Revision in the database
TCCORE_API int ITEM_find ( const char *  item_id,
int *  n_items,
tag_t **  item_tags 
)

This function searches the database for all Items with IDs that match the given string. Wildcards may be used. The search will always be case insensitive.

  • Id in Context = NO: Case insensitive search with wildcards in item_id.
  • Id in Context = YES: Case insensitive search with wildcards in item_id. If you want to find in a single context, use new function ITEM_find_in_idcontext. Providing null tag as context tag, this function will find an item with given id in all contexts as well as item_id.
Parameters
item_id(I) String to match IDs against
n_items(O) Number of matching Items found
item_tags(OF) n_items Array of tags of found Items
TCCORE_API int ITEM_find_in_idcontext ( const char *  id,
tag_t  idcontext_tag,
int *  num_items,
tag_t **  item_tags 
)

Returns all the items that have the given alternate id in context. Uses case-insensitive search and allows wildcards in id. If idcontext_tag is null, it assumes a search across all alternate identifiers of Items in any context as well as Items.

Parameters
id(I) Id to be searched for. May include wild cards.
idcontext_tag(I) Tag of an IdContext or NULLTAG
num_items(O) Number of items for the given id and IdContext
item_tags(OF) num_items An array of tags to found Items
TCCORE_API int ITEM_find_item ( const char *  search_id,
tag_t *  item 
)

Retrieves the tag of an Item based on an input value, which can be:

  • the value of its property Item ID ("item_id"). If the value of the preference "TC_MFK_DEFAULT_DOMAIN" is specified, the search is executed against that domain.
  • the value of its property Part Identifier ("fnd0PartIdentifier").



In both cases, the search is case insensitive and the value cannot contain any wild card.
For searching using a specific context, use the ITEM_find_item_in_idcontext function.

This function returns:

Parameters
search_id(I) Either the ID ("item_id") or the Part Identifier ("fnd0PartIdentifier") of the Item to find
item(O) Tag of the found Item
TCCORE_API int ITEM_find_item_in_idcontext ( const char *  id,
tag_t  idcontext_tag,
tag_t *  item_tag 
)

Similar to ITEM_find_in_idcontext except if more than one item found, it returns an error.

Parameters
id(I) Id to be searched for. May include wild cards.
idcontext_tag(I) Tag of an IdContext or NULLTAG
item_tag(O) Tag of found Item
TCCORE_API int ITEM_find_item_revs_by_key_attributes ( int  num_attributes,
const char **  attribute_names,
const char **  attribute_values,
const char *  rev_id,
int *  n_items,
tag_t **  item_tags 
)

This function searches the database for all ItemRevisions and returns a list of ItemRevision tags identified by the given attribute name/value pairs. The attributes must be the unique key attributes of the Item class, which are defined in the list of MultiFieldKey Constant.

For COTS Item, the default key attribute is "item_id". This attribute must be used as input to the ITK. However, other attributes can still be used as inputs as long as they are defined as MultiFieldKey attributes.

Parameters
num_attributes(I) number of attributes
attribute_names(I) Attribute Names
attribute_values(I) Attribute Values
rev_id(I) Revision ID
n_items(O) Number of matching Items found
item_tags(OF) n_items Array of tags of found Items
TCCORE_API int ITEM_find_item_revs_by_string ( const char *  av_string,
int *  n_items,
tag_t **  item_tags 
)

This function searches the database for all ItemRevisions and returns a list of ItemRevision tags identified by the given string containing attribute-value pairs in the following format: 

attr_1=value_1,attr_2=value_2,...,attr_n=value_n

All attributes in the attribute-value pair string must the unique key attributes of the Item class, which are defined in the list of MultiFieldKey Constant. For COTS Item, the default key attribute is "item_id". This attribute must be used as input to the ITK. However, other attributes can still be used as inputs as long as they are defined as MultiFieldKey attributes.

Also, the last attribute-value pair in the string must be: rev_id=<revision name>.

The input parameter av_string contains delimited Item attribute-value pairs, and must in the format of: 

 attr_1=value1,attr_2=value2,...

The default delimiter and separator used in the attribute-value pairs are "," and "=". However, user can define own delimiter and separator using the preference: TC_KEY_STRING_DELIMITER_VALUES.

Parameters
av_string(I) delimited Item attribute-value pair string
n_items(O) Number of matching ItemsRevisions found
item_tags(OF) n_items Array of tags of found Items
TCCORE_API int ITEM_find_item_revs_by_string_and_revid ( const char *  av_string,
const char *  revid,
int *  n_items,
tag_t **  item_tags 
)

This function searches the database for all ItemRevisions and returns a list of ItemRevision tags identified by the given string containing attribute-value pairs. The attributes must be the unique key attributes of the Item class, which are defined in the list of MultiFieldKey Constant. For COTS Item, the default key attribute is "item_id". This attribute must be used as input to the ITK. However, other attributes can still be used as inputs as long as they are defined as MultiFieldKey attributes.

The input parameter av_string contains delimited Item attribute-value pairs, and must in the format of: 

 attr_1=value1,attr_2=value2,...

The default delimiter and separator used in the attribute-value pairs are "," and "=". However, user can define own delimiter and separator using the preference: TC_KEY_STRING_DELIMITER_VALUES.

Parameters
av_string(I) delimited Item attribute-value pair string
revid(I) delimited Item attribute-value pair string
n_items(O) Number of matching ItemsRevisions found
item_tags(OF) n_items Array of tags of found Items
TCCORE_API int ITEM_find_items_by_key_attributes ( int  num_attributes,
const char **  attribute_names,
const char **  attribute_values,
int *  n_items,
tag_t **  item_tags 
)

This function searches the database for all Items and returns a list of item tags identified by the given attribute name/value pairs. The attributes must be the unique key attributes of the item class. Currently, only "item_id" attribute should be used.

Parameters
num_attributes(I) number of attributes
attribute_names(I) Attribute Names
attribute_values(I) Attribute Values
n_items(O) Number of matching Items found
item_tags(OF) n_items Array of tags of found Items
TCCORE_API int ITEM_find_items_by_string ( const char *  av_string,
int *  n_items,
tag_t **  item_tags 
)
Parameters
av_string(I) delimited Item attribute-value pair string
n_items(O) Number of matching Items found
item_tags(OF) n_items Array of tags of found Items
TCCORE_API int ITEM_find_rev ( const char *  search_id,
const char *  rev_id,
tag_t *  rev_tag 
)

Retrieves the tag of an Item Revision based on an input value, which can be:

  • the value of its property Item ID ("item_id"). If the value of the preference "TC_MFK_DEFAULT_DOMAIN" is specified, the search is executed against that domain.
  • the value of its property Part Identifier ("fnd0PartIdentifier").


If tag of the item is known, then use ITEM_find_revision for performance improvement.

For searching in a single id context, use the ITEM_find_revs_in_idcontext.

This function returns:

Parameters
search_id(I) Either the ID ("item_id") or the Part Identifier ("fnd0PartIdentifier") of the Item to find
rev_id(I) Item Revision ID
rev_tag(O) Tag of the Item Revision
TCCORE_API int ITEM_find_revision ( tag_t  item,
const char *  rev_id,
tag_t *  rev_tag 
)

This function will return the tag of a specific Item Revision. It should be used in preference to ITEM_find_rev when you already have the tag of the Item.

If more than one match (case insensitive) is found, an error is returned. Use ITEM_find_revisions in this case.

  • Id in Context = NO: Case insensitive search of rev_id given Item tag.
  • Id in Context = YES: Case insensitive search of rev_id given Item tag.
Parameters
item(I) Tag of the Item
rev_id(I) Item Revision ID
rev_tag(O) Tag of the Item Revision
TCCORE_API int ITEM_find_revisions ( tag_t  item,
const char *  rev_id,
int *  n_revs,
tag_t **  rev_tags 
)

This function searches the database for all Item Revisions (of the given Item) with IDs that match the given string. Wildcards may be used. The search will always be case insensitive.

  • Id in Context = NO: Case insensitive search of rev_id given Item tag.
  • Id in Context = YES: Case insensitive search of rev_id given Item tag.
Parameters
item(I) Tag of the Item
rev_id(I) Item Revision ID
n_revs(O) Number of matching Revisions found
rev_tags(OF) n_revs Array of tags of found Revisions
TCCORE_API int ITEM_find_revs_in_idcontext ( const char *  id,
const char *  rev_id,
tag_t  idcontext_tag,
int *  num_revs,
tag_t **  rev_tags 
)

Retrieves all tags of supplemental revisions (Identifiers) based on Inputs:

  • the value of its property Item id ("item_id") in the specified ID context.
  • the value of its property Item Revision Id ("rev_id") in the specified ID context.


The search is case-insensitive and allows wildcards in IDs.
If the parameter "idcontext_tag" is set to NULLTAG, the search is carried out across all alternate identifiers of Items as well as in Items themselves.

Parameters
id(I) Id for an item
rev_id(I) Id for an item revision
idcontext_tag(I) Tag of an IdContext or NULLTAG
num_revs(O) Number of item revisions with the given id, rev_id, and IdContext
rev_tags(OF) num_revs An array of tags to supplemental revisions (Identifiers)
TCCORE_API void ITEM_free_exclude_list ( )
TCCORE_API void ITEM_get_exclude_list ( int *  count,
tag_t **  exclude_list 
)
Parameters
count(O)
exclude_list(OF) count
TCCORE_API int ITEM_id_exists ( const char *  id,
logical *  verdict 
)

Checks if any item exists with the given id. If Id in Context is not implemented, it checks for Items as well as all alternate identifiers of Items. If it is implemented, it checks only the Items.

Parameters
id(I) Id for an item
verdict(O) TRUE if an Item exists, otherwise FALSE
TCCORE_API int ITEM_id_owners ( const char *  id,
int *  num_objs,
tag_t **  obj_tags 
)

Returns all objects that have the given id. If "Id In Context" is not implemented, then the Items and alternate Identifiers are searched and returned. Otherwise, only Items are searched and returned.

Parameters
id(I) Id for an object
num_objs(O) Number of objects for the given id
obj_tags(OF) num_objs An array of tags to Items and/or Alternate Identifiers
TCCORE_API int ITEM_init_module ( )

This function initializes the Item module. You must call it before calling any other ITEM functions.

TCCORE_API int ITEM_list_all_attachments ( tag_t  item,
int *  count,
ITEM_attached_object_t **  objects 
)

DEPRECATED FUNCTION This function will return all objects attached to the Item.

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_list_relations, passing primary_object=item, secondary_object=NULLTAG, relation_type=NULLTAG and user_data=NULLTAG, or GRM_list_secondary_objects, passing primary_object=item and relation_type=NULLTAG.
Parameters
item(I) Tag of an existing Item
count(O) Number of attachments found
objects(OF) count Objects attached to the Item. The tag of each object and its attachment type can be obtained within the structure defined by ITEM_attached_object_t.
TCCORE_API int ITEM_list_all_attachments_tag ( tag_t  item,
int *  count,
ITEM_attached_object_tag_t **  objects 
)

DEPRECATED FUNCTION

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. Use GRM_list_secondary_objects_only to list objects attached by GRM relation. Use ITEM_list_all_revs to list revisions of item. Use ITEM_list_bom_views to list bom views of item.
Parameters
item(I)
count(O)
objects(OF) count
TCCORE_API int ITEM_list_all_rev_attachments ( tag_t  rev,
int *  count,
ITEM_attached_object_t **  objects 
)

DEPRECATED FUNCTION This function will return all objects attached to the Item Revision.

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_list_relations, passing primary_object=rev, secondary_object=NULLTAG, relation_type=NULLTAG and user_data=NULLTAG, or GRM_list_secondary_objects, passing primary_object=rev and relation_type=NULLTAG.
Parameters
rev(I) Item Revision tag
count(O) Number of objects attached to the Item Revision
objects(OF) count List of objects related to the Item Revision
TCCORE_API int ITEM_list_all_revs ( tag_t  item,
int *  count,
tag_t **  rev_list 
)

This function will return all Item Revisions attached to a specified Item. All tags returned by this function will be sorted by the Item Revision creation date.

Parameters
item(I) Tag of an existing Item
count(O) Total number of revisions of the Item
rev_list(OF) count Tag list of all the revisions of the Item
TCCORE_API int ITEM_list_attachs_of_type ( tag_t  item,
ITEM_attachment_type_t  attachment_type,
int *  count,
ITEM_attached_object_t **  objects 
)

DEPRECATED FUNCTION This function will return all objects attached to the Item of specific attachment type.

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_list_secondary_objects_only, passing relation type tag equivalent to attachment_type.
Parameters
item(I) Tag of an existing Item
attachment_type(I) Type of attachment
count(O) Number of objects attached to the Item
objects(OF) count Objects attached to the Item. The tag of each object and its attachment type can be obtained within the structure defined by ITEM_attached_object_t.
TCCORE_API int ITEM_list_attachs_of_type_tag ( tag_t  item,
tag_t  attachment_type,
int *  count,
tag_t **  tag_list 
)

DEPRECATED FUNCTION

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. Use GRM_list_secondary_objects_only to list objects attached by GRM relation. Use ITEM_list_all_revs to list revisions of item. Use ITEM_list_bom_views to list bom views of item.
Parameters
item(I)
attachment_type(I)
count(O)
tag_list(OF) count
TCCORE_API int ITEM_list_bom_views ( tag_t  item,
int *  count,
tag_t **  bv_list 
)

This function will return the tags of all bom views related to the Item.

Parameters
item(I) Tag of an existing Item
count(O) Number of bom view found for the Item
bv_list(OF) count Tag list of all the bom views for the Item
TCCORE_API int ITEM_list_possible_attachments_tag ( const char *  obj_type,
int *  count,
tag_t **  attachment_types 
)

DEPRECATED FUNCTION

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. This function gives an erroneous hardcoded list of relation types and class ids. There is no replacement for this function, it is thought most unlikely to be used.
Parameters
obj_type(I)
count(O)
attachment_types(OF) count
TCCORE_API int ITEM_list_rev_attachs_of_type ( tag_t  rev,
ITEM_attachment_type_t  relation_type,
int *  count,
ITEM_attached_object_t **  objects 
)

DEPRECATED FUNCTION This function will return all objects related to the Item with the specific attachment type.

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_list_secondary_objects_only, passing relation type tag equivalent to attachment_type.
Parameters
rev(I) Item Revision tag
relation_type(I) Type of attachment
count(O) Number of objects attached to the Item Revision
objects(OF) count List of objects attached to the Item Revision
TCCORE_API int ITEM_perform_deepcopy ( tag_t  new_item_rev,
char *  operation,
tag_t  parent_item_rev,
int *  count,
tag_t **  deepcopiedobjects 
)

This ITK Performs the Deep copy of the attachments Based on the deep copy rules specified using the Business Modeler deep copy rule application. This ITK will get the rules from the database and then after processing them performs the deep copy operation.

Parameters
new_item_rev(I) The Item Revision Tag to which attachments to be deep copied
operation(I) The Type of operation:
ITEM_revise_operation
ITEM_saveas_operation
parent_item_rev(I) The Item Revision through which is revised to create the new_item_rev
count(O) Number of deep copied objects
deepcopiedobjects(OF) count Array of deep copied objects
TCCORE_API int ITEM_perform_deepcopy_using ( tag_t  new_item_rev,
char *  operation,
tag_t  parent_item_rev,
const int  option_count,
const tag_t *  obj_tags,
const char **  copy_option,
const char **  option_names,
const char **  relation_types,
int *  count,
tag_t **  deepcopiedobjects 
)
Parameters
new_item_rev(I) The Item Revision Tag to which attachments to be deep copied
operation(I) The Type of operation:
ITEM_revise_operation
ITEM_saveas_operation
parent_item_rev(I) The Item Revision through which is revised to create the new_item_rev
option_count(I)
obj_tags(I) Tags of the objects that need to be copied or not be copied
copy_option(I) Copy options such as strings defined by ITEM_copy_as_object, ITEM_no_copy
option_names(I) User supplied names for the objects
relation_types(I) Names of the relation types
count(O) Number of deep copied objects
deepcopiedobjects(OF) count Array of deep copied objects
TCCORE_API int ITEM_perform_deepcopy_using2 ( tag_t  new_item_rev,
char *  operation,
tag_t  parent_item_rev,
const int  option_count,
const tag_t *  obj_tags,
const char **  copy_types,
const char **  obj_names,
const char **  relation_types,
const char **  copy_relations,
int *  count,
tag_t **  deepcopiedobjects 
)
Parameters
new_item_rev(I) The Item Revision Tag to which attachments to be deep copied
operation(I) The Type of operation:
ITEM_revise_operation
ITEM_saveas_operation
parent_item_rev(I) The Item Revision through which is revised to create the new_item_rev
option_count(I)
obj_tags(I) Tags of the objects that need to be copied or not be copied
copy_types(I) Copy options such as strings defined by ITEM_copy_as_object, ITEM_no_copy
obj_names(I) User supplied names for the objects
relation_types(I) Names of the relation types
copy_relations(I) relation_count Carry forward the Properties on the Relation
count(O) Number of deep copied objects
deepcopiedobjects(OF) count Array of deep copied objects
TCCORE_API int ITEM_rev_ask_effectivity_mappings ( tag_t  itemrev,
int *  n,
tag_t **  mappings 
)
Parameters
itemrev(I)
n(O)
mappings(OF) n
TCCORE_API int ITEM_rev_ask_gde_bvr ( tag_t  item_rev_tag,
tag_t  view_type,
tag_t *  gde_bvr_tag 
)

This function return the GDE BOMViewRevision of the specified view_type for a given Item Revision.

Parameters
item_rev_tag(I) Tag of the item revision under which the GDE BomViewRevision should be created
view_type(I) Tag of the view_type to be associated with the new GDE BomViewRevision
gde_bvr_tag(O) Tag of the GDE BomViewRevision. If no GDE BOMViewRevision is found NULLTAG is returned.
TCCORE_API int ITEM_rev_ask_has_module ( tag_t  item_rev,
logical *  is_module 
)

Used to determine whether or not an item revision has a module.

Parameters
item_rev(I) The item rev being queried
is_module(O) True if the item rev has a module, otherwise false
TCCORE_API int ITEM_rev_create_gde_bvr ( tag_t  item_rev_tag,
tag_t  view_type,
tag_t *  gde_bvr_tag 
)
Deprecated:
This function is deprecated and will be removed from Tc11. From Tc9.0 onwards, please use generic creation of BusinessObject(i.e createBusinessObject or TCTYPE_create_object ).

This function creates a GDE BOMViewRevision of a BOMView, with no occurrences. The GDEBOMViewRevision created is made an attribute of the specified parent Item Revision. This Item Revision must be a revision of the Item that is the parent of the view_type.

The new BOMView Revision is not saved; it can be saved to the database using AOM_save. Note that the parent Item Revision is modified and must also be saved

Parameters
item_rev_tag(I) Tag of the item revision under which the GDE BomViewRevision should be created
view_type(I) Tag of the view_type to be associated with the new GDE BomViewRevision
gde_bvr_tag(O) Tag of the newly created GDE BomViewRevision
TCCORE_API int ITEM_rev_delete_bvr ( tag_t  rev,
tag_t  bvr 
)

Removes the (PS) BOMViewRevision from the Item Revision and deletes it. If that leaves the corresponding BOMView with no BOMViewRevisions, then the BOMView is removed from the Item and deleted too.

Parameters
rev(I) Item Revision tag
bvr(I) BOMViewRevision tag
TCCORE_API int ITEM_rev_find_base_rev ( tag_t  baseline_rev,
tag_t *  base_rev 
)

This ITK returns the base item revision with which the baseline_rev is having the IMAN_baseline relation. If no revision is found, i.e., the input baseline_rev is not a Baseline Revision, then NULLTAG is returned as the base_rev.

Parameters
baseline_rev(I) The Baseline Item Revision Tag
base_rev(O) The base Revision of the given Baseline Item Revision
TCCORE_API int ITEM_rev_get_key_string ( tag_t  item_revision_tag,
char **  key_string 
)
Parameters
item_revision_tag(I) Tag of Item Revision
key_string(OF) A delimited string representing the key attr/value pairs for the Itemm
TCCORE_API int ITEM_rev_list_all_bom_view_revs ( tag_t  rev,
int *  count,
tag_t **  bvrs 
)

This function will return all the BOMViewRevision, including GDE BOMViewRevisions, for a given Item Revision.

Parameters
rev(I) Tag of the item revision under which the GDE BomViewRevision should be created
count(O) Number of BOM Views Revision attached to the above Item Revision
bvrs(OF) count Tags of BOMView Revisions (including GDE BOMViewRevisions) for the Item Revision
TCCORE_API int ITEM_rev_list_baselineRevs ( tag_t  base_rev,
const char *  baselineStatusName,
int *  n_revs,
tag_t **  baseline_revs 
)

This ITK lists all the various Baseline Revisions that the base_rev has with the given baseline release status (baselineStatusName). If an empty baselineStatusName is sent, then it lists all the Baseline Revisions for the given base revision. The memory for the baseline_revs is allocated by the ITK and needs to be MEM_free()d.

Parameters
base_rev(I) Tag of the Item Revision for which the list of Baselines is requested
baselineStatusName(I) The release status name of the Baseline Revisions that are requested. If empty, then all the Baseline Revisions are returned.
n_revs(O) Number of Baseline Revisions matching the specified criteria.
baseline_revs(OF) n_revs The list of memory allocated Baseline Revisions
TCCORE_API int ITEM_rev_list_bom_view_revs ( tag_t  rev,
int *  count,
tag_t **  bvrs 
)

This function will return all objects attached to the Item Revision.

Parameters
rev(I) Item Revision tag
count(O) Number of BOM Views attached to the Item Revision
bvrs(OF) count BOMView revisions for the Item Revision
TCCORE_API int ITEM_save_item ( tag_t  item)

This function saves an Item in the database.

Restrictions:

An Item must be saved before attachments can be made to it.

Parameters
item(I) Tag for identifying the Item to be saved
TCCORE_API int ITEM_save_rev ( tag_t  rev)

This function will save an Item Revision.

Parameters
rev(I) Tag for identifying the Item Revision to be saved
TCCORE_API int ITEM_set_description ( tag_t  item,
const char *  item_desc 
)

This function will set the description of the Item.

Parameters
item(I) Tag of an Item
item_desc(I) Description of an Item
TCCORE_API int ITEM_set_id ( tag_t  item,
const char *  item_id 
)

This function will set the ID of the Item.

  • Id in Context = NO: Ensure case insensitive uniqueness against all Item.item_id and Identifier.id.
  • Id in Context = YES: Ensure case insensitive uniqueness against all Item.item_id.

Ensure case insensitive uniqueness across all Items (item_id attribute) and alternate identifiers of items (idfr_id attribute) if Id in Context is not implemented.

Parameters
item(I) Tag of an Item
item_id(I) ID of an Item
TCCORE_API int ITEM_set_name ( tag_t  item,
const char *  item_name 
)

This function will set the name of the Item.

Parameters
item(I) Tag of an Item
item_name(I) Name of an Item
TCCORE_API int ITEM_set_rev_description ( tag_t  rev,
const char *  rev_desc 
)

This function will set the description of the Item Revision.

Parameters
rev(I) Tag of an Item Revision
rev_desc(I) Description of an Item
TCCORE_API int ITEM_set_rev_id ( tag_t  rev,
const char *  rev_id 
)

This function will set the ID of the Item Revision.

  • Id in Context = NO: Ensure case insensitive uniqueness of rev_id among all peer revisions of given ItemRevision.
  • Id in Context = YES: Ensure case insensitive uniqueness of rev_id among all peer revisions of given ItemRevision.
Parameters
rev(I) Tag of an Item Revision
rev_id(I) ID of the Item Revision
TCCORE_API int ITEM_set_rev_name ( tag_t  rev,
const char *  rev_name 
)

This function will set the name of the Item Revision.

Parameters
rev(I) Tag of an Item Revision
rev_name(I) Name of the Item Revision
TCCORE_API int ITEM_set_rev_variants ( tag_t  rev,
tag_t  variant_expression_block 
)

Sets the variant expression block associated with the specified Item Revision. A NULLTAG block clears the currently set value.

Parameters
rev(I) Tag of an Item Revision
variant_expression_block(I) Tag of the variant expression block
TCCORE_API int ITEM_set_unit_of_measure ( tag_t  item,
tag_t  uom 
)

Sets the unit of measure in which quantities of this Item must be expressed. Units of measure are objects defined for the Teamcenter Engineering site by the system administrator.

By default, Items have no UOM. In this case this function will give NULLTAG. This implies that quantities of such Items are expressed in terms of "Each" or "Pieces". In other words they refer to a discrete number of component parts. In PSE if no specific quantity value is associated with the use of such Items, the default quantity is assumed to be "1 component".

Parameters
item(I) Tag of an Item
uom(I) Tag of the unit of measure to be assigned to this Item (may be NULLTAG)
TCCORE_API int ITEM_translate_rev_mvl ( tag_t  from_rev,
tag_t  to_rev,
int  n_modules,
char **  from_modules,
char **  to_modules 
)

Modular options are scoped by an item id. This function helps translate MVL text to subsitute new item id (this helps in scenarios like SaveAs where options in new structure should be scoped by new item id) Along with MVL text, an ItemRevision also has references to PSOption objects. These references should also mimic the scoping by Item, hence copies of PSOption objects are created for the new revision (to_rev).

Parameters
from_rev(I)
to_rev(I)
n_modules(I)
from_modules(I) n_modules
to_modules(I) n_modules
TCCORE_API int ITEM_update_item_attachment ( tag_t  item,
tag_t  old_object,
ITEM_attachment_type_t  attachment_type,
tag_t  new_object 
)

DEPRECATED FUNCTION This function replaces an old object that is attached to the Item with a new object.

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. The behavior of this function can be reproduced in the following way:
  1. Locate the existing relation object with GRM_find_relation.
  2. Delete the existing relation using AOM_delete.
  3. Create a new relation object to connect item to to new_object using GRM_create_relation.
  4. Save and unlock the new relation using AOM_save and AOM_unlock.
Parameters
item(I) Tag of the Item
old_object(I) Tag of the old object
attachment_type(I) Type of attachment
new_object(I) Tag of the new object
TCCORE_API int ITEM_update_rev_attachment ( tag_t  rev,
tag_t  old_object,
ITEM_attachment_type_t  attachment_type,
tag_t  new_object 
)

DEPRECATED FUNCTION This function replaces the old object that is attached to an Item Revision with a new object.

Deprecated:
This function is deprecated, it will be removed from Teamcenter V12.0. The behavior of this function can be reproduced in the following way:
  1. Locate the existing relation object with GRM_find_relation.
  2. Delete the existing relation using AOM_delete.
  3. Create a new relation object to connect item to to new_object using GRM_create_relation.
  4. Save and unlock the new relation using AOM_save and AOM_unlock.
Parameters
rev(I) Tag of the Item Revision
old_object(I) Tag of the old object
attachment_type(I) Type of attachment
new_object(I) Tag of the new object
TCCORE_API int ITEM_vi_ask_generic_component ( tag_t  item,
tag_t *  module_item_rev 
)

Provides the module stored within a variant item. A variant item�s module is the generic component it instantiates.

Parameters
item(I) The item being queried
module_item_rev(O) The VI�s generic component (module). NULLTAG if the item is not a VI.
TCCORE_API int ITEM_vi_ask_is_linked_to_generic ( tag_t  item,
logical *  is_linked 
)

States whether or not a link is maintained between a variant item and its generic component. A linked VI cannot have structure changes made to it if those changes make it fundamentally different to the generic structure it instantiates.

Parameters
item(I) The item being queried
is_linked(O) True if the item is a VI that maintains a link to its generic component,
false if the item is not a VI or if it is a VI that does not require structure validation
TCCORE_API int ITEM_vi_ask_sos ( tag_t  item,
tag_t *  db_sos 
)

Provides the saved configuration stored within a variant item. The saved configuration describes how a variant item instantiates the generic component it originates from.

Parameters
item(I) The item being queried
db_sos(O) The VI�s saved configuration (stored option set). NULLTAG if the item is not a VI
TCCORE_API int ITEM_vi_find ( tag_t  generic_item_rev,
int  n,
tag_t *  items,
char **  options,
int *  ops,
int *  valueTypes,
char **  lowValues,
char **  highValues,
int *  n_matches,
tag_t **  matches 
)

Searches for variant items for the given generic component based on a set of option value criteria. Criteria for different options are ANDed together (e.g. "option1 = 5 and option2 = 10"). Criteria for the same option are ORed together (e.g. "option1 = 5 or option1 = 8").

Parameters
generic_item_rev(I) The generic component
n(I) Number of search criteria. Setting n to 0 will return all VIs of the generic component.
items(I) n Array of items against which the following options are defined
options(I) n Array of options that are being queried
ops(I) n Array of query operators. Defined in bom_tokens.h:
BOM_DB_SOS_OP_LIKE - Like (string matching with wildcards)
BOM_DB_SOS_OP_NOT_LIKE - Not like
BOM_DB_SOS_OP_EQ - Equals
BOM_DB_SOS_OP_NE - Not equals
BOM_DB_SOS_OP_LT - Less than
BOM_DB_SOS_OP_GT - Greater than
BOM_DB_SOS_OP_LTEQ - Less than or equal
BOM_DB_SOS_OP_GTEQ - Greater than or equal
BOM_DB_SOS_OP_IN - Inside range
BOM_DB_SOS_OP_OUT - Outside range
valueTypes(I) n Array of option value type definitions. Defined in bom_tokens.h:
BOM_DB_SOS_LOGICAL
BOM_DB_SOS_INTEGER
BOM_DB_SOS_DOUBLE
BOM_DB_SOS_STRING
lowValues(I) n Array of values to match. Passed as strings, converted internally to previously defined value type.
highValues(I) n Array of upper bound values when using range operators
n_matches(O) Number of matching VIs found
matches(OF) n_matches Array of matching VI's
TCCORE_API int ITEM_vi_unlink_from_generic ( tag_t  item)

Unlinks a variant item from its generic component. An unlinked VI can have structure that is different from its generic component.

Restrictions:

This action is not possible if the item is not a variant item

This action is permanent and not reversible. As soon as a VI is unlinked, this new VI state is saved to the database. It is not possible to unlink a VI and then relink it.

Parameters
item(I) The variant item that is to be unlinked