Main Page | Modules | Files | Functions | Code Elements | Data Structures | Deprecated

Properties

Detailed Description

A property is a piece of information kept about an object of a particular type.

Modules

Property functions that get their value from the Property Descriptor

There is a duplicate PROPDESC_ function for each of these.

Properties User Interface

This section defines ITK to support specifically to support User Interface (UIF) functionality on properties.

Defines

Functions

Define Documentation

#define PROP_DISPLAY_ACTUAL_NAMES   2

Definition at line 33 of file prop.h.

#define PROP_DISPLAY_PRESENTATION_NAMES   1

Definition at line 32 of file prop.h.

#define PROP_NAME_DISPLAY_PREF   "PROP_Show_Actual_Names"

Definition at line 30 of file prop.h.

Function Documentation

PROPERTY_API int PROP_ask_composite_property ( tag_t  component,
const char *  composite_property,
char **  value 
)

This call returns the Composite Property value for an Teamcenter Engineering component.

A Composite Property of an object defines a path to associated objects, with potentially multiple levels of indirection, resulting in an evaluation of a regular property on that or these associated object(s).

The syntax of a composite property is:

[objectTypeName.][referenceProperty[(criteriaProperty=criteriaValue[,criteriaProperty=criteriaValue]):][referenceProperty[(criteriaProperty=criteriaValue[,criteriaProperty=criteriaValue])]:]]property

where:

  • objectTypeName is a regular Teamcenter Engineering object type name (e.g. UGMASTER).
  • referenceProperty is either a typed_reference, untyped_reference, typed_relation, or an untyped_relation.
  • criteriaProperty can be any valid Composite Property (recursion). If specified it is taken as a criteria list in case the above referenceProperty is ambiguous.
  • property is any regular Teamcenter Engineering property name.
  • the notation "[" indicates optional elements, and is not part of Composite Property itself.
Examples:
  • object_type evaluates the regular property 'object_type'. This illustrates that each regular property is also a perfectly valid Composite Property.
  • item_master_tag:product_year evaluates the property 'product_year' on the ItemRevision Master of an Item Revision.
  • item_tag:item_master_tag:Project_ID evaluates the property Project_ID on the Item Master of the Item of an Item Revision.
  • item_tag:IMAN_master_form(object_type=MyCustomItemForm):MyCustomProperty evaluates the property MyCustomProperty of all objects in the IMAN_master_form pseudo folder of the Item of an Item Revision, that have the object type "MyCustomItemForm", returning all values in a comma separated list.
  • ItemRevision Master.revision_list:item_master_tag:Project_ID evaluates the property Project_ID on each Item Revision of a given Item. In case 3 Item Revision share the same Project ID 3200, these duplicated values are shown as '3200 (x3)'. A list of values is separated by a comma and a blank character. The prefix ItemRevision Master indicates that the ultimate physical property is actually on an object of type ItemRevision Master.

Restrictions:

Each intermediate step in the chain of properties references the next related object(s) in the path. Except for the last property, they must by specified by either a:

  • typed_reference
  • untyped_reference
  • typed_relation
  • untyped_relation
Parameters:
component  (I) Component for which the Composite Property is to be evaluated
composite_property  (I) Composite Property to evaluate
value  (OF) Returned property value

PROPERTY_API int PROP_ask_composite_property_objs ( tag_t  component,
const char *  composite_property,
int *  n_related_components,
tag_t **  related_components 
)

This call returns an array of related Teamcenter Engineering components pointed to be a Composite Property value for a given Teamcenter Engineering component. See also PROP_ask_composite_property().

Restrictions:

Each intermediate step in the chain of properties references the next related object(s) in the path. Except for the last property, they must by specified by either a

  • typed_reference
  • untyped_reference
  • typed_relation
  • untyped_relation
Parameters:
component  (I) Component for which the Composite Property is to be evaluated
composite_property  (I) Composite Property to evaluate
n_related_components  (O) The number of returned components in related_components
related_components  (OF) n_related_components The array of components pointed to by the Composite Property

PROPERTY_API int PROP_ask_descriptor ( tag_t  prop_tag,
tag_t *  prop_desc_tag 
)

Asks descriptor for a property.

Deprecated:
This function is not supported after Version 10.0. Use AOM_ask_descriptor instead.
Parameters:
prop_tag  (I) The tag of the property
prop_desc_tag  (O) The descriptor for the property

PROPERTY_API int PROP_ask_lov ( tag_t  prop_tag,
tag_t *  lov_tag 
)

Returns the property's LOV tag if there is a LOV attached to the property. A NULL value is returned otherwise. It will look all the way up the Type hierarchy for any LOV association.

Deprecated:
This function is not supported after Version 10.0. Use AOM_ask_lov instead.
Parameters:
prop_tag  (I) Tag of the property
lov_tag  (O) Tag of the LOV

PROPERTY_API int PROP_ask_max_num_elements ( tag_t  prop_tag,
int *  maxnumelem 
)

Asks maximum number of elements for a property.

Deprecated:
This function is not supported after Version 10.0. Use AOM_ask_max_num_elements instead.
Parameters:
prop_tag  (I) The tag of the property
maxnumelem  (O) The maximum number of elements for the property. Will be 1 for a single-valued property, -1 for a list property and a positive integer for an array property.

PROPERTY_API int PROP_ask_max_string_length ( tag_t  prop_tag,
int *  maxstrlen 
)

Asks maximum string length for a property. The property must be type PROP_string.

Deprecated:
This function is not supported after Version 10.0. Use AOM_ask_max_string_length instead.
Parameters:
prop_tag  (I) The tag of the property
maxstrlen  (O) The maximum string length of the property value

PROPERTY_API int PROP_ask_name ( tag_t  prop_tag,
char **  name 
)

Asks name of a property.

Deprecated:
Obsolete in Teamcenter Version 10.0
Parameters:
prop_tag  (I) The tag of the property
name  (OF) The name of the property

PROPERTY_API int PROP_ask_num_elements ( tag_t  prop_tag,
int *  num_elem 
)

Asks number of elements a property holds (i.e., how large is the list or array).

A single-valued property will always return 1. An array will return the size of the array. A list will return the current number of elements in the list, ranging from 0 to infinity.

Deprecated:
This function is not supported after Version 10.0. Use AOM_ask_num_elements instead.
Parameters:
prop_tag  (I) The tag of the property
num_elem  (O) Number of elements the property holds

PROPERTY_API int PROP_ask_object_type ( tag_t  prop_tag,
tag_t *  type_tag 
)

Ask the type that the property defines.

Parameters:
prop_tag  (I) The tag of the property
type_tag  (O) The tag of the type

PROPERTY_API int PROP_ask_owning_object ( tag_t  prop_tag,
tag_t *  obj_tag 
)

Asks for the object that this property describes.

Deprecated:
Obsolete in Teamcenter Engineering Version 10.0
Parameters:
prop_tag  (I) The tag of the property
obj_tag  (O) The tag of the object the property describes

PROPERTY_API int PROP_ask_property_by_name ( tag_t  object_tag,
const char *  prop_name,
tag_t *  prop_tag 
)

Asks an object for its property with the specified name.

Deprecated:
Obsolete in Teamcenter 10.0 Beginning with Teamcenter 10.0 there should be no need to use the property object. All functionality related to properties is now available via AOM functions that take the property name as input. For example AOM_UIF_ask_name, AOM_set_value_<type> or AOM_ask_value_<type>.
Parameters:
object_tag  (I) The tag of the object
prop_name  (I) The name of the property
prop_tag  (O) The tag of the property

PROPERTY_API int PROP_ask_property_type ( tag_t  prop_tag,
PROP_type_t *  proptype,
char **  proptype_n 
)

Returns the property type of a property. Go to the property descriptor (PROPDESC) module for a description of the possible property types.

Deprecated:
This function is not supported after Version 10.0. Use AOM_ask_property_type instead.
Parameters:
prop_tag  (I) The tag of the property
proptype  (O) The property type of the property
proptype_n  (OF) The name of the property type

PROPERTY_API int PROP_ask_value_char ( tag_t  prop_tag,
char *  value 
)

Asks value of a single-valued property.

This function uses PROP_ask_value_char_msg. To customize the behavior of this function, register a method against this message name.

Deprecated:
Use AOM_ask_value_char instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
value  (O) Actual value of the property

PROPERTY_API int PROP_ask_value_char_at ( tag_t  prop_tag,
int  position,
char *  value 
)

Asks value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0.

This function uses PROP_ask_value_char_at_msg if the property is multi-valued or PROP_ask_value_char_msg if the property is single-valued and position = 0. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_ask_value_char_at instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
position  (I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value  (O) Actual value of the property at the specified index position

PROPERTY_API int PROP_ask_value_chars ( tag_t  prop_tag,
int *  num,
char **  values 
)

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

This function uses PROP_ask_value_chars_msg if multi-valued and PROP_ask_value_char_msg if single-valued. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_ask_value_chars instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
num  (O) Number of values asked
values  (OF) num Actual values of the property. This must be a list or array of constant chars. If the property is an array, the number of values passed in must equal the size of the array.

PROPERTY_API int PROP_ask_value_date ( tag_t  prop_tag,
date_t *  value 
)

Asks value of a single-valued property.

This function uses PROP_ask_value_date_msg. To customize the behavior of this function, register a method against this message name.

Deprecated:
Use AOM_ask_value_date instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
value  (O) Actual value of the property

PROPERTY_API int PROP_ask_value_date_at ( tag_t  prop_tag,
int  position,
date_t *  value 
)

Asks value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0.

This function uses PROP_ask_value_date_at_msg if the property is multi-valued or PROP_ask_value_date_msg if the property is single-valued and position = 0. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_ask_value_date_at instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
position  (I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value  (O) Actual value of the property at the specified index position

PROPERTY_API int PROP_ask_value_dates ( tag_t  prop_tag,
int *  num,
date_t **  values 
)

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

This function uses PROP_ask_value_dates_msg if multi-valued and PROP_ask_value_date_msg if single-valued. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_ask_value_dates instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
num  (O) Number of values asked
values  (OF) num Actual values of the property. This must be a list or array of constant chars. If the property is an array, the number of values passed in must equal the size of the array.

PROPERTY_API int PROP_ask_value_double ( tag_t  prop_tag,
double *  value 
)

Asks value of a single-valued property.

This function uses PROP_ask_value_double_msg. To customize the behavior of this function, register a method against this message name.

Deprecated:
Use AOM_ask_value_double instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
value  (O) Actual value of the property

PROPERTY_API int PROP_ask_value_double_at ( tag_t  prop_tag,
int  position,
double *  value 
)

Asks value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0.

This function uses PROP_ask_value_double_at_msg if the property is multi-valued or PROP_ask_value_double_msg if the property is single-valued and position = 0. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_ask_value_double_at instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
position  (I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value  (O) Actual value of the property at the specified index position

PROPERTY_API int PROP_ask_value_doubles ( tag_t  prop_tag,
int *  num,
double **  values 
)

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

This function uses PROP_ask_value_doubles_msg if multi-valued and PROP_ask_value_double_msg if single-valued. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_ask_value_doubles instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
num  (O) Number of values asked
values  (OF) num Actual values of the property. This must be a list or array of constant chars. If the property is an array, the number of values passed in must equal the size of the array.

PROPERTY_API int PROP_ask_value_int ( tag_t  prop_tag,
int *  value 
)

Asks value of a single-valued property.

This function uses PROP_ask_value_int_msg. To customize the behavior of this function, register a method against this message name.

Deprecated:
Use AOM_ask_value_int instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
value  (O) Actual value of the property

PROPERTY_API int PROP_ask_value_int_at ( tag_t  prop_tag,
int  position,
int *  value 
)

Asks value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0.

This function uses PROP_ask_value_int_at_msg if the property is multi-valued or PROP_ask_value_int_msg if the property is single-valued and position = 0. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_ask_value_int_at instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
position  (I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value  (O) Actual value of the property at the specified index position

PROPERTY_API int PROP_ask_value_ints ( tag_t  prop_tag,
int *  num,
int **  values 
)

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

This function uses PROP_ask_value_ints_msg if multi-valued and PROP_ask_value_int_msg if single-valued. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_ask_value_ints instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
num  (O) Number of values asked
values  (OF) num Actual values of the property. This must be a list or array of constant chars. If the property is an array, the number of values passed in must equal the size of the array.

PROPERTY_API int PROP_ask_value_logical ( tag_t  prop_tag,
logical *  value 
)

Asks value of a single-valued property.

This function uses PROP_ask_value_logical_msg. To customize the behavior of this function, register a method against this message name.

Deprecated:
Use AOM_ask_value_logical instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
value  (O) Actual value of the property

PROPERTY_API int PROP_ask_value_logical_at ( tag_t  prop_tag,
int  position,
logical *  value 
)

Asks value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0.

This function uses PROP_ask_value_logical_at_msg if the property is multi-valued or PROP_ask_value_logical_msg if the property is single-valued and position = 0. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_ask_value_logical_at instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
position  (I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value  (O) Actual value of the property at the specified index position

PROPERTY_API int PROP_ask_value_logicals ( tag_t  prop_tag,
int *  num,
logical **  values 
)

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

This function uses PROP_ask_value_logicals_msg if multi-valued and PROP_ask_value_logical_msg if single-valued. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_ask_value_logicals instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
num  (O) Number of values asked
values  (OF) num Actual values of the property. This must be a list or array of constant chars. If the property is an array, the number of values passed in must equal the size of the array.

PROPERTY_API int PROP_ask_value_string ( tag_t  prop_tag,
char **  value 
)

Asks value of a single-valued property.

This function uses PROP_ask_value_string_msg. To customize the behavior of this function, register a method against this message name.

Deprecated:
Use AOM_ask_value_string instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
value  (OF) Actual value of the property

PROPERTY_API int PROP_ask_value_string_at ( tag_t  prop_tag,
int  position,
char **  value 
)

Asks value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0.

This function uses PROP_ask_value_string_at_msg if the property is multi-valued or PROP_ask_value_string_msg if the property is single-valued and position = 0. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_ask_value_string_at instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
position  (I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value  (OF) Actual value of the property at the specified index position

PROPERTY_API int PROP_ask_value_strings ( tag_t  prop_tag,
int *  num,
char ***  values 
)

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

This function uses PROP_ask_value_strings_msg if multi-valued and PROP_ask_value_string_msg if single-valued. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_ask_value_strings instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
num  (O) Number of values asked
values  (OF) num Actual values of the property. This must be a list or array of constant chars. If the property is an array, the number of values passed in must equal the size of the array.

PROPERTY_API int PROP_ask_value_tag ( tag_t  prop_tag,
tag_t *  value 
)

Asks value of a single-valued property.

This function uses PROP_ask_value_tag_msg. To customize the behavior of this function, register a method against this message name.

Deprecated:
Use AOM_ask_value_tag instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
value  (O) Actual value of the property

PROPERTY_API int PROP_ask_value_tag_at ( tag_t  prop_tag,
int  position,
tag_t *  value 
)

Asks value of a multi-valued (i.e., list or array) property at a particular index position. The property can be single-valued if position = 0.

This function uses PROP_ask_value_tag_at_msg if the property is multi-valued or PROP_ask_value_tag_msg if the property is single-valued and position = 0. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_ask_value_tag_at instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
position  (I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value  (O) Actual value of the property at the specified index position

PROPERTY_API int PROP_ask_value_tags ( tag_t  prop_tag,
int *  num,
tag_t **  values 
)

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

This function uses PROP_ask_value_tags_msg if multi-valued and PROP_ask_value_tag_msg if single-valued. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_ask_value_tags instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
num  (O) Number of values asked
values  (OF) num Actual values of the property. This must be a list or array of constant chars. If the property is an array, the number of values passed in must equal the size of the array.

PROPERTY_API int PROP_ask_value_type ( tag_t  prop_tag,
PROP_value_type_t *  valtype,
char **  valtype_n 
)

Returns the value type of a property. Go to the property descriptor (PROPDESC) module for a description of the possible value types.

Deprecated:
This function is not supported after Version 10.0. Use AOM_ask_value_type instead.
Parameters:
prop_tag  (I) The tag of the property
valtype  (O) The value type of the property
valtype_n  (OF) The name of the value type

PROPERTY_API int PROP_is_modifiable ( tag_t  prop_tag,
logical *  mod_flag 
)

Asks property if it is modifiable by the user who is accessing it.

This function uses the message PROP_is_modifiable_msg. To customize the behavior, register a method against this message name.

Deprecated:
This function is not supported after Version 10.0. Use AOM_is_modifiable instead.
Parameters:
prop_tag  (I) The tag of the property
mod_flag  (O) Indicates whether the property is modifiable (i.e., TRUE = modifiable, FALSE = not modifiable)

PROPERTY_API int PROP_is_property_localizable ( tag_t  object_tag,
char *  prop_name,
logical *  is_localizable 
)

Parameters:
object_tag  (I)
prop_name  (I)
is_localizable  (O)

PROPERTY_API int PROP_list_common_modifiable_properties ( int  object_count,
tag_t *  object_tags,
int *  prop_count,
char ***  prop_names 
)

Parameters:
object_count  (I)
object_tags  (I)
prop_count  (O)
prop_names  (OF) prop_count

PROPERTY_API int PROP_list_properties ( tag_t  object_tag,
int *  num,
tag_t **  prop_tags 
)

Gets a list of properties for a specified object.

Deprecated:
This function will not be supported after V10.0. Use AOM_ask_prop_names instead.
Parameters:
object_tag  (I) The tag of the object
num  (O) Number of properties found
prop_tags  (OF) num The list of properties

PROPERTY_API int PROP_set_value_char ( tag_t  prop_tag,
char  value 
)

Sets value on a single-valued property.

This function uses PROP_set_value_char_msg. To customize the behavior of this function, register a method against this message name.

Deprecated:
Use AOM_set_value_char instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
value  (I) Actual value being set on the property

PROPERTY_API int PROP_set_value_char_at ( tag_t  prop_tag,
int  position,
char  value 
)

Sets value on a multi-valued (i.e., list or array) property at a specified index position.

This function uses PROP_set_value_char_at_msg. If the property is single-valued and the index position = 0, PROP_set_value_char_msg will be called instead. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_set_value_char_at instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
position  (I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value  (I) Actual value being set on the property

PROPERTY_API int PROP_set_value_chars ( tag_t  prop_tag,
int  num,
const char *  values 
)

Sets one or more values on a property.

This function uses PROP_set_value_chars_msg if the property is multi-valued or PROP_set_value_char_msg if this property is single-valued. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_set_value_chars instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
num  (I) Number of values to be set
values  (I) Actual values being set on the property. This must be a list or array of constant characters. If the property is an array, the number of values passed in must equal the size of the array.

PROPERTY_API int PROP_set_value_date ( tag_t  prop_tag,
date_t  value 
)

Sets value on a single-valued property.

This function uses PROP_set_value_date_msg. To customize the behavior of this function, register a method against this message name.

Deprecated:
Use AOM_set_value_date instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
value  (I) Actual value being set on the property

PROPERTY_API int PROP_set_value_date_at ( tag_t  prop_tag,
int  position,
date_t  value 
)

Sets value on a multi-valued (i.e., list or array) property at a specified index position.

This function uses PROP_set_value_date_at_msg. If the property is single-valued and the index position = 0, PROP_set_value_date_msg will be called instead. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_set_value_date_at instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
position  (I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value  (I) Actual value being set on the property

PROPERTY_API int PROP_set_value_dates ( tag_t  prop_tag,
int  num,
const date_t *  values 
)

Sets one or more values on a property.

This function uses PROP_set_value_dates_msg if the property is multi-valued or PROP_set_value_date_msg if this property is single-valued. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_set_value_dates instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
num  (I) Number of values to be set
values  (I) Actual values being set on the property. This must be a list or array of constant characters. If the property is an array, the number of values passed in must equal the size of the array.

PROPERTY_API int PROP_set_value_double ( tag_t  prop_tag,
double  value 
)

Sets value on a single-valued property.

This function uses PROP_set_value_double_msg. To customize the behavior of this function, register a method against this message name.

Deprecated:
Use AOM_set_value_double instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
value  (I) Actual value being set on the property

PROPERTY_API int PROP_set_value_double_at ( tag_t  prop_tag,
int  position,
double  value 
)

Sets value on a multi-valued (i.e., list or array) property at a specified index position.

This function uses PROP_set_value_double_at_msg. If the property is single-valued and the index position = 0, PROP_set_value_double_msg will be called instead. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_set_value_double_at instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
position  (I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value  (I) Actual value being set on the property

PROPERTY_API int PROP_set_value_doubles ( tag_t  prop_tag,
int  num,
const double *  values 
)

Sets one or more values on a property.

This function uses PROP_set_value_doubles_msg if the property is multi-valued or PROP_set_value_double_msg if this property is single-valued. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_set_value_doubles instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
num  (I) Number of values to be set
values  (I) Actual values being set on the property. This must be a list or array of constant characters. If the property is an array, the number of values passed in must equal the size of the array.

PROPERTY_API int PROP_set_value_int ( tag_t  prop_tag,
int  value 
)

Sets value on a single-valued property.

This function uses PROP_set_value_int_msg. To customize the behavior of this function, register a method against this message name.

Deprecated:
Use AOM_set_value_int instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
value  (I) Actual value being set on the property

PROPERTY_API int PROP_set_value_int_at ( tag_t  prop_tag,
int  position,
int  value 
)

Sets value on a multi-valued (i.e., list or array) property at a specified index position.

This function uses PROP_set_value_int_at_msg. If the property is single-valued and the index position = 0, PROP_set_value_int_msg will be called instead. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_set_value_int_at instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
position  (I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value  (I) Actual value being set on the property

PROPERTY_API int PROP_set_value_ints ( tag_t  prop_tag,
int  num,
const int *  values 
)

Sets one or more values on a property.

This function uses PROP_set_value_ints_msg if the property is multi-valued or PROP_set_value_int_msg if this property is single-valued. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_set_value_ints instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
num  (I) Number of values to be set
values  (I) Actual values being set on the property. This must be a list or array of constant characters. If the property is an array, the number of values passed in must equal the size of the array.

PROPERTY_API int PROP_set_value_logical ( tag_t  prop_tag,
logical  value 
)

Sets value on a single-valued property.

This function uses PROP_set_value_logical_msg. To customize the behavior of this function, register a method against this message name.

Deprecated:
Use AOM_set_value_logical instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
value  (I) Actual value being set on the property

PROPERTY_API int PROP_set_value_logical_at ( tag_t  prop_tag,
int  position,
logical  value 
)

Sets value on a multi-valued (i.e., list or array) property at a specified index position.

This function uses PROP_set_value_logical_at_msg. If the property is single-valued and the index position = 0, PROP_set_value_logical_msg will be called instead. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_set_value_logical_at instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
position  (I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value  (I) Actual value being set on the property

PROPERTY_API int PROP_set_value_logicals ( tag_t  prop_tag,
int  num,
const logical *  values 
)

Sets one or more values on a property.

This function uses PROP_set_value_logicals_msg if the property is multi-valued or PROP_set_value_logical_msg if this property is single-valued. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_set_value_logicals instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
num  (I) Number of values to be set
values  (I) Actual values being set on the property. This must be a list or array of constant characters. If the property is an array, the number of values passed in must equal the size of the array.

PROPERTY_API int PROP_set_value_string ( tag_t  prop_tag,
const char *  value 
)

Sets value on a single-valued property.

This function uses PROP_set_value_string_msg. To customize the behavior of this function, register a method against this message name.

Deprecated:
Use AOM_set_value_string instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
value  (I) Actual value being set on the property

PROPERTY_API int PROP_set_value_string_at ( tag_t  prop_tag,
int  position,
const char *  value 
)

Sets value on a multi-valued (i.e., list or array) property at a specified index position.

This function uses PROP_set_value_string_at_msg. If the property is single-valued and the index position = 0, PROP_set_value_string_msg will be called instead. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_set_value_string_at instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
position  (I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value  (I) Actual value being set on the property

PROPERTY_API int PROP_set_value_strings ( tag_t  prop_tag,
int  num,
char **  values 
)

Sets one or more values on a property.

This function uses PROP_set_value_strings_msg if the property is multi-valued or PROP_set_value_string_msg if this property is single-valued. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_set_value_strings instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
num  (I) Number of values to be set
values  (I) num Actual values being set on the property. This must be a list or array of constant characters. If the property is an array, the number of values passed in must equal the size of the array.

PROPERTY_API int PROP_set_value_tag ( tag_t  prop_tag,
tag_t  value 
)

Sets value on a single-valued property.

This function uses PROP_set_value_tag_msg. To customize the behavior of this function, register a method against this message name.

Deprecated:
Use AOM_set_value_tag instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
value  (I) Actual value being set on the property

PROPERTY_API int PROP_set_value_tag_at ( tag_t  prop_tag,
int  position,
tag_t  value 
)

Sets value on a multi-valued (i.e., list or array) property at a specified index position.

This function uses PROP_set_value_tag_at_msg. If the property is single-valued and the index position = 0, PROP_set_value_tag_msg will be called instead. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_set_value_tag_at instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
position  (I) The position of the specified property in an array or list. The first position is 0. For example, if the property is an array of size 3 and the third value in the array is to be modified, then position = 2.
value  (I) Actual value being set on the property

PROPERTY_API int PROP_set_value_tags ( tag_t  prop_tag,
int  num,
const tag_t *  values 
)

Sets one or more values on a property.

This function uses PROP_set_value_tags_msg if the property is multi-valued or PROP_set_value_tag_msg if this property is single-valued. To customize the behavior of this function, register a method against one of these messages.

Deprecated:
Use AOM_set_value_tags instead
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
num  (I) Number of values to be set
values  (I) Actual values being set on the property. This must be a list or array of constant characters. If the property is an array, the number of values passed in must equal the size of the array.

PROPERTY_API int PROP_UIF_ask_name ( tag_t  prop_tag,
char **  disp_name 
)

Asks display name of a property.

Deprecated:
This function is not supported after Version 10.0. Use AOM_UIF_ask_name instead.
Parameters:
prop_tag  (I) The tag of the property
disp_name  (OF) The display name of the property

PROPERTY_API int PROP_UIF_ask_property_by_name ( tag_t  object_tag,
const char *  disp_name,
tag_t *  prop_tag 
)

Asks an object for its property with the specified display name.

Deprecated:
Obsolete in Teamcenter Version 10.0 Use AOM Property ask and set ITKs directly to get or set property value, For example, AOM_ask_value_string. These ITKs do not require property object input
Parameters:
object_tag  (I) The tag of the object
disp_name  (I) The display name of the property
prop_tag  (O) The tag of the property

PROPERTY_API int PROP_UIF_ask_value ( tag_t  prop_tag,
char **  d_value 
)

Asks the display value of a property. Regardless of what type of property is asked, this value will be returned as an MEM_alloc'd string.

This function uses PROP_UIF_ask_value_msg. To customize the behavior of this function, register a property method, pre-action or post-action against this message name.

A default method is registered against PROP_UIF_ask_value_msg. The default behavior is as follows:

  1. PROP_UIF_ask_value gets a value from PROP_ask_value_<type>s.
  2. If the property is a single-value string or note, it does not change what PROP_ask_value_strings returns.
  3. If the property is a single-value number (int, float, etc.), the number is converted to a string and returned.
  4. If the property is a single-value tag (i.e., typed reference, typed relation, etc.) the object_string of the object being referenced by the tag is returned. For most objects, the object_string is its name. However, Item, ItemRevision and others have special object_strings. object_string is a run-time property that is displayed in the Object column of Workspace.
  5. If the property is a single-value date, the date is returned using the format identified by "DefaultDateFormat" in timelocal.uih.
  6. If the property is a single-value logical, the values for true/false identified by gk_properties_true_label and gk_properties_false_label in iman_text.uil are used.
  7. If the property is multi-valued, all of the values are returned in a single string with commas separating the values. The formatting described above is used for each of the property types.

Deprecated:
This function is not supported after Version 10.0. Use AOM_UIF_ask_value instead.
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
d_value  (OF) The display value of the property

PROPERTY_API int PROP_UIF_is_displayable ( tag_t  prop_tag,
logical *  is_display 
)

Asks display name of a property.

Deprecated:
This function is not supported after Version 10.0. Use AOM_UIF_is_displayable instead.
Parameters:
prop_tag  (I) The tag of the property
is_display  (O) Indicates whether property is displayable (i.e., TRUE=displayable, FALSE=not displayable)

PROPERTY_API int PROP_UIF_is_enabled ( tag_t  prop_tag,
logical *  is_enabled 
)

Parameters:
prop_tag  (I)
is_enabled  (O)

PROPERTY_API int PROP_UIF_list_displayable_properties ( tag_t  object_tag,
int *  num,
tag_t **  prop_tags 
)

Parameters:
object_tag  (I)
num  (O)
prop_tags  (OF) num

PROPERTY_API int PROP_UIF_set_value ( tag_t  prop_tag,
const char *  value 
)

Sets the value of a property using a display value as input. This function will work for any property type, accepts string values as input, then calls the appropriate PROP_set_value_<type>s command.

This function uses PROP_UIF_set_value_msg. To customize the behavior of this function, register a property method, pre-action, or post-action against this message name.

A default method is registered against PROP_UIF_set_value_msg. The default behavior is as follows:

  1. If the property is multi-valued, it will parse the string at the commas then convert the values to the appropriate type.
  2. If the property is a string or note, no conversion of the value is done.
  3. If the property is one of the number types (int, double, etc.), the input value will be converted from string to the appropriate type.
  4. If the property is a tag, an attempt will be made to convert the string passed in into a valid tag.
  5. If the property is a date, the format described by DefaultDateFormat in timelocal.uih will be used to convert the date from a string to a date_t.
  6. If the property is a logical, the values for true/false identified by gk_properties_true_label and gk_properties_false_label in iman_text.uil will be used to convert the string to a logical.
  7. Upon successful conversion, as described above, PROP_set_value_<type>s will be called, passing in the converted value(s).

Deprecated:
This function is not supported after Version 10.0. Use AOM_UIF_set_value instead.
Parameters:
prop_tag  (I) Unique identifier (tag) of the property instance
value  (I) The display value used to set the new value of the property