T4S4  18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
ICS ITK functions

All ITK functions of group ICS supported by T4x. More...

Functions

 ICS_class_ask_icos ClassId
 This function calls the ITK pipe server function ICS_class_ask_icos to get the ico tags. More...
 
 ICS_createClassificationObject HexTcObjectTag ClassId
 This function calls the ITK pipe server function ICS_createClassificationObject to create a classification (inClass) object for a given Teamcenter object. More...
 
 ICS_findClassificationObject HexTcObjectTag
 This function calls the ITK pipe server function ICS_findClassificationObject to find a classification (inClass) object for a given Teamcenter object. More...
 
 ICS_ico_remove HexTcObjectTag
 This function calls the ITK pipe server function ICS_ico_remove to remove the ico. More...
 
 ICS_ico_set_attribute_values_via_tparray HexTcObjectTag TpArray
 This function calls the ITK pipe server function ICS_ico_set_attribute_values_via_tparray to update a set attribute of a classification (inClass) object. More...
 
 ICS_ico_set_attributes HexTcObjectTag HexAttrId HexAtrributValue1 ...
 This function calls the ITK pipe server function ICS_ico_set_attributes to set the ico attributes. More...
 
 ICS_set_attribute_value HexTcObjectTag AttributeId NewAttributeValue
 This function calls the ITK pipe server function ICS_set_attribute_value to update an attribute of a classification (inClass) object. More...
 

Detailed Description

All ITK functions of group ICS supported by T4x.

This group specifies all ITK functions of group ICS for which wrappers have been defined in T4x

Function Documentation

◆ ICS_class_ask_icos()

ITK::ICS_class_ask_icos   ClassId  

This function calls the ITK pipe server function ICS_class_ask_icos to get the ico tags.

Parameters
ClassIdstring
Returns
list ITK_ok (=0) and ICOTags or list of ITK status and error message

◆ ICS_createClassificationObject()

ITK::ICS_createClassificationObject   HexTcObjectTag ClassId  

This function calls the ITK pipe server function ICS_createClassificationObject to create a classification (inClass) object for a given Teamcenter object.

Parameters
HexTcObjectTagTeamcenter object to classify
ClassId
Returns
List of ITK_ok (=0) and classification object or list of ITK status and error message

◆ ICS_findClassificationObject()

ITK::ICS_findClassificationObject   HexTcObjectTag  

This function calls the ITK pipe server function ICS_findClassificationObject to find a classification (inClass) object for a given Teamcenter object.

Parameters
HexTcObjectTagTeamcenter object to classify
ClassId
Returns
List of ITK_ok (=0) and classification object or list of ITK status and error message

◆ ICS_ico_remove()

ITK::ICS_ico_remove   HexTcObjectTag  

This function calls the ITK pipe server function ICS_ico_remove to remove the ico.

Parameters
HexTcObjectTag,icotag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ ICS_ico_set_attribute_values_via_tparray()

ITK::ICS_ico_set_attribute_values_via_tparray   HexTcObjectTag TpArray  

This function calls the ITK pipe server function ICS_ico_set_attribute_values_via_tparray to update a set attribute of a classification (inClass) object.

Parameters
HexTcObjectTagclassification object tag
TpArraybuffer that contains the dump of the TcData buffer with all attributes to set in our internal TcData structure
Returns
ITK_ok (=0) or list of ITK status and error message

Sample code sequence

1 #
2 # Create TcDataBuffer first
3 #
4 set TcDataBuffer [::ITK::tpco_tcdcreate 1000 0]
5 #
6 # store for each attribute id the values into the tparray buffer
7 #
8 tpco_tcdstore $TcDataBuffer leave $IcoTag 1000 "value 1" 0
9 tpco_tcdstore $TcDataBuffer leave $IcoTag 1001 "value 2" 0
10 #
11 # Multi value are separated by a \n
12 #
13 tpco_tcdstore $TcDataBuffer leave $IcoTag 1002 "value 3.1\nvalue3.2" 0
14 #
15 # Export data buffer for ICS_set_attribute_values_via_tparray call
16 #
17 tpco_tcdexport $TcDataBuffer IcoValueBuffer
18 #
19 # Now we store all attributes into Tc for the given IcoTag
20 #
21 set ItkStatus [::ITK::ICS_set_attribute_values_via_tparray $IcoTag $IcoValueBuffer]
22 #
23 # MemCleanup
24 #
25 tpco_tcddelete $TcDataBuffer

◆ ICS_ico_set_attributes()

ITK::ICS_ico_set_attributes   HexTcObjectTag HexAttrId HexAtrributValue1 ...  

This function calls the ITK pipe server function ICS_ico_set_attributes to set the ico attributes.

Parameters
HexTcObjectTagico tag
HexAttrIdlong
HexAtrributValue1string
...
HexAtrributValueXstring
Returns
ITK_ok (=0) or list of ITK status and error message

◆ ICS_set_attribute_value()

ITK::ICS_set_attribute_value   HexTcObjectTag AttributeId NewAttributeValue  

This function calls the ITK pipe server function ICS_set_attribute_value to update an attribute of a classification (inClass) object.

Parameters
HexTcObjectTagclassification object tag
AttributeIdClassification attribute id
NewAttributeValueSupports single or multiple value class attribute updates with a new attribute value. To update multi value attributes the value has to be provided as a single string each value needs to be separated by a
separator (e.g. "value1\nvalue2\nvalue3")
Returns
ITK_ok (=0) or list of ITK status and error message