List of Values

Modules
	LOV Errors
	LOV Messages

Macros
#define	LOV_char_c   PROP_char
#define	LOV_char_class_name_c   "ListOfValuesChar"
#define	LOV_classification_name_size_c   32
#define	LOV_date_c   PROP_date
#define	LOV_date_class_name_c   "ListOfValuesDate"
#define	LOV_desc_size_c   240
#define	LOV_double_c   PROP_double
#define	LOV_double_class_name_c   "ListOfValuesDouble"
#define	LOV_dynamic_class_name_c   "Fnd0ListOfValuesDynamic"
#define	LOV_filter_class_name_c   "ListOfValuesFilter"
#define	LOV_integer_c   PROP_int
#define	LOV_integer_class_name_c   "ListOfValuesInteger"
#define	LOV_name_size_c   32
#define	LOV_root_class_name_c   "ListOfValues"
#define	LOV_string_c   PROP_string
#define	LOV_string_class_name_c   "ListOfValuesString"
#define	LOV_tag_c   PROP_untyped_reference
#define	LOV_tag_class_name_c   "ListOfValuesTag"
#define	LOV_type_size_c   32
#define	LOV_value_desc_size_c   256

Typedefs
typedef enum LOV_attached_type_e	LOV_attached_type_t
typedef enum LOV_usage_e	LOV_usage_t

Enumerations
enum	LOV_attached_type_e { LOV_Unused, LOV_Attribute, LOV_Property }
enum	LOV_usage_e {   LOV_Unknown, LOV_Exhaustive_list, LOV_Suggestions, LOV_Ranges,   LOV_Upper_bound }

Functions
LOV_API int	LOV_ask_attached_dependency_order (const char *type_name, const char *prop_name, int *order)
LOV_API int	LOV_ask_attached_dependency_orders (tag_t lov_tag, int *n_attached, int **orders)
LOV_API int	LOV_ask_attached_description_logical (const char *type_name, const char *prop_name, logical *descAttach)
LOV_API int	LOV_ask_attached_description_logicals (tag_t lov_tag, int *n_attached, logical **desc_attach)
LOV_API int	LOV_ask_attached_parent_number (const char *type_name, const char *prop_name, int *n_parent)
LOV_API int	LOV_ask_attached_parent_numbers (tag_t lov_tag, int *n_attached, int **n_parents)
LOV_API int	LOV_ask_attached_properties (tag_t lov_tag, int *n_attach, char ***type_names, char ***prop_names)
LOV_API int	LOV_ask_attached_properties_info (tag_t lov_tag, int *n_attach, char ***type_names, char ***prop_names, int **orders, int **n_parents, logical **desc_attach)
LOV_API int	LOV_ask_attached_properties_info_with_conditions (tag_t lov_tag, int *n_attach, char ***type_names, char ***prop_names, int **orders, int **n_parents, logical **desc_attach, tag_t **conditions, logical **overrides)
LOV_API int	LOV_ask_based_on_lov_shown_indexes (tag_t lov_tag, tag_t *based_on_lov, logical *all_shown, int *n_shown_indices, int **shown_indices)
LOV_API int	LOV_ask_column_names (tag_t lov_tag, tag_t *lov_value_prop_desc_tag, tag_t *lov_descr_prop_desc_tag, int *num_filter_props, tag_t *filter_prop_desc_tags[])
LOV_API int	LOV_ask_description (tag_t lov, char lov_desc[LOV_desc_size_c+1])
LOV_API int	LOV_ask_description2 (tag_t lov, char **lov_desc)
LOV_API int	LOV_ask_disp_value_descriptions (tag_t lov_tag, int *n_desc_strings, char ***desc_strings, logical **is_null, logical **is_empty)
LOV_API int	LOV_ask_disp_values (tag_t lov_tag, LOV_usage_t *usage, int *n_values, logical **is_null, logical **is_empty, char ***value_strings)
LOV_API int	LOV_ask_disp_values_tag (tag_t lov, LOV_usage_t lov_usage, int n_values, const tag_t *values, const logical *is_null, const logical *is_empty, char ***disp_values)
LOV_API int	LOV_ask_disp_values_without_evaluation (tag_t lov_tag, LOV_usage_t *usage, int *n_values, logical **is_null, logical **is_empty, char ***value_strings)
LOV_API int	LOV_ask_name (tag_t lov, char lov_name[LOV_name_size_c+1])
LOV_API int	LOV_ask_name2 (tag_t lov, char **lov_name)
LOV_API int	LOV_ask_num_of_values (tag_t lov, int *length)
LOV_API int	LOV_ask_reference (tag_t lov, char **class_name, char **attr_name)
LOV_API int	LOV_ask_type (tag_t lov, char lov_type[LOV_type_size_c+1])
LOV_API int	LOV_ask_type2 (tag_t lov, char **lov_type)
LOV_API int	LOV_ask_usage (tag_t lov_tag, LOV_usage_t *usage)
LOV_API int	LOV_ask_value_classifications (tag_t lov_tag, int *n_classifications, char ***classifications)
LOV_API int	LOV_ask_value_descriptions (tag_t lov_tag, LOV_usage_t *usage, int *n_values, char ***desc_strings, logical **is_null, logical **is_empty)
LOV_API int	LOV_ask_value_filters (tag_t lov_tag, int *n_list_of_filters, int **list_of_filter_indices, tag_t **list_of_filters)
LOV_API int	LOV_ask_value_type (tag_t lov_tag, PROP_value_type_t *value_type)
LOV_API int	LOV_ask_values_display_tag (tag_t lov, LOV_usage_t *lov_usage, int *n_values, char ***display_values, tag_t **values)
LOV_API int	LOV_ask_values_from_disp_values_string (tag_t pd_tag, int n_values, const char **disp_values, int *n_internal_values, char ***internal_values)
LOV_API int	LOV_execute_dynamic_lov (const tag_t lov_tag, const tag_t object_tag, const char *prop_name, const char *filter_string, const int max_results, const char *sort_property_name, const int order, int *num_results, tag_t **results)
LOV_API int	LOV_extent (int *n_lovs, tag_t **lov)
LOV_API int	LOV_find (const char *lov_name, int *n_lovs, tag_t **lov)
LOV_API int	LOV_find_attached_prop (const char *type_name, const char *prop_name, tag_t *lov)

For integer value type
LOV_API int	LOV_is_value_valid_int (tag_t lov, int value, logical *answer)
LOV_API int	LOV_ask_range_lower_int (tag_t lov, int *value, logical *is_it_null, logical *is_it_empty)
LOV_API int	LOV_ask_range_upper_int (tag_t lov, int *value, logical *is_it_null, logical *is_it_empty)
LOV_API int	LOV_ask_values_int (tag_t lov, int *n_values, int **values)
LOV_API int	LOV_ask_lov_int (tag_t lov, LOV_usage_t *lov_usage, int *n_values, int **values, logical **is_null, logical **is_empty)
LOV_API int	LOV_ask_lov_int_without_evaluation (tag_t lov, LOV_usage_t *lov_usage, int *n_values, int **values, logical **is_null, logical **is_empty)
LOV_API int	LOV_ask_disp_values_int (tag_t lov, LOV_usage_t lov_usage, int n_values, const int *values, const logical *is_null, const logical *is_empty, char ***disp_values)

For double value type
LOV_API int	LOV_is_value_valid_double (tag_t lov, double value, logical *answer)
LOV_API int	LOV_ask_range_lower_double (tag_t lov, double *value, logical *is_it_null, logical *is_it_empty)
LOV_API int	LOV_ask_range_upper_double (tag_t lov, double *value, logical *is_it_null, logical *is_it_empty)
LOV_API int	LOV_ask_values_double (tag_t lov, int *n_values, double **values)
LOV_API int	LOV_ask_values_double_without_evaluation (tag_t lov, int *n_values, double **values)
LOV_API int	LOV_ask_lov_double (tag_t lov, LOV_usage_t *lov_usage, int *n_values, double **values, logical **is_null, logical **is_empty)
LOV_API int	LOV_ask_lov_double_without_evaluation (tag_t lov, LOV_usage_t *lov_usage, int *n_values, double **values, logical **is_null, logical **is_empty)
LOV_API int	LOV_ask_disp_values_double (tag_t lov, LOV_usage_t lov_usage, int n_values, const double *values, const logical *is_null, const logical *is_empty, char ***disp_values)

For char value type
LOV_API int	LOV_is_value_valid_char (tag_t lov, char value, logical *answer)
LOV_API int	LOV_ask_range_lower_char (tag_t lov, char *value, logical *is_it_null, logical *is_it_empty)
LOV_API int	LOV_ask_range_upper_char (tag_t lov, char *value, logical *is_it_null, logical *is_it_empty)
LOV_API int	LOV_ask_values_char (tag_t lov, int *n_values, char **values)
LOV_API int	LOV_ask_values_char_without_evaluation (tag_t lov, int *n_values, char **values)
LOV_API int	LOV_ask_lov_char (tag_t lov, LOV_usage_t *lov_usage, int *n_values, char **values, logical **is_null, logical **is_empty)
LOV_API int	LOV_ask_lov_char_without_evaluation (tag_t lov, LOV_usage_t *lov_usage, int *n_values, char **values, logical **is_null, logical **is_empty)
LOV_API int	LOV_ask_disp_values_char (tag_t lov, LOV_usage_t lov_usage, int n_values, const char *values, const logical *is_null, const logical *is_empty, char ***disp_values)

For string value type
LOV_API int	LOV_is_value_valid_string (tag_t lov, const char *value, logical *answer)
LOV_API int	LOV_ask_range_lower_string (tag_t lov, char **value, logical *is_it_null, logical *is_it_empty)
LOV_API int	LOV_ask_range_upper_string (tag_t lov, char **value, logical *is_it_null, logical *is_it_empty)
LOV_API int	LOV_ask_values_string (tag_t lov, int *n_values, char ***values)
LOV_API int	LOV_ask_values_string_without_evaluation (tag_t lov, int *n_values, char ***values)
LOV_API int	LOV_ask_values_int_without_evaluation (tag_t lov_tag, int *n_values, int **values)
LOV_API int	LOV_ask_lov_string (tag_t lov, LOV_usage_t *lov_usage, int *n_values, char ***values, logical **is_null, logical **is_empty)
LOV_API int	LOV_ask_lov_string_without_evaluation (tag_t lov, LOV_usage_t *lov_usage, int *n_values, char ***values, logical **is_null, logical **is_empty)
LOV_API int	LOV_ask_values_display_string (tag_t lov, LOV_usage_t *lov_usage, int *n_values, char ***display_values, char ***values)
LOV_API int	LOV_ask_disp_values_string (tag_t lov, LOV_usage_t lov_usage, int n_values, const char **values, const logical *is_null, const logical *is_empty, char ***disp_values)

For date value type
LOV_API int	LOV_is_value_valid_date (tag_t lov, date_t value, logical *answer)
LOV_API int	LOV_ask_range_lower_date (tag_t lov, date_t *value, logical *is_it_null, logical *is_it_empty)
LOV_API int	LOV_ask_range_upper_date (tag_t lov, date_t *value, logical *is_it_null, logical *is_it_empty)
LOV_API int	LOV_ask_values_date (tag_t lov, int *n_values, date_t **values)
LOV_API int	LOV_ask_values_date_without_evaluation (tag_t lov, int *n_values, date_t **values)
LOV_API int	LOV_ask_lov_date (tag_t lov, LOV_usage_t *lov_usage, int *n_values, date_t **values, logical **is_null, logical **is_empty)
LOV_API int	LOV_ask_lov_date_without_evaluation (tag_t lov, LOV_usage_t *lov_usage, int *n_values, date_t **values, logical **is_null, logical **is_empty)
LOV_API int	LOV_ask_disp_values_date (tag_t lov, LOV_usage_t lov_usage, int n_values, const date_t *values, const logical *is_null, const logical *is_empty, char ***disp_values)

For tag value type
LOV_API int	LOV_is_value_valid_tag (tag_t lov, tag_t value, logical *answer)
LOV_API int	LOV_ask_values_tag (tag_t lov, int *n_values, tag_t **values)
LOV_API int	LOV_ask_lov_tag (tag_t lov, LOV_usage_t *lov_usage, int *n_values, tag_t **values, logical **is_null, logical **is_empty)

Detailed Description

List of Values (LOV) functions allow lists of pre-defined values to be created and associated with properties. These LOVs can be displayed to users at run-time to assist them with field entries.

Common Return Values

Return Value	Description
LOV_detach_error	Unable to detach the list of values from the property.
LOV_invalid_lov_name	Name cannot be NULL.
LOV_invalid_type	Invalid LOV type.
LOV_invalid_usage	Invalid usage for this LOV. LOV must be either LOV_Suggestions or LOV_Exhaustive_list.
LOV_invalid_value_type	Invalid value type. Valid types are PROP_typed_reference, PROP_untyped_reference, PROP_external_reference, PROP_typed_relation.
LOV_no_create	Failed to create the LOV.

Macro Definition Documentation

#define LOV_char_c   PROP_char

Definition at line 59 of file lov.h.

#define LOV_char_class_name_c   "ListOfValuesChar"

Definition at line 44 of file lov.h.

#define LOV_classification_name_size_c   32

Definition at line 55 of file lov.h.

#define LOV_date_c   PROP_date

Definition at line 61 of file lov.h.

#define LOV_date_class_name_c   "ListOfValuesDate"

Definition at line 46 of file lov.h.

#define LOV_desc_size_c   240

Definition at line 52 of file lov.h.

#define LOV_double_c   PROP_double

Definition at line 58 of file lov.h.

#define LOV_double_class_name_c   "ListOfValuesDouble"

Definition at line 43 of file lov.h.

#define LOV_dynamic_class_name_c   "Fnd0ListOfValuesDynamic"

Definition at line 49 of file lov.h.

#define LOV_filter_class_name_c   "ListOfValuesFilter"

Definition at line 48 of file lov.h.

#define LOV_integer_c   PROP_int

Definition at line 57 of file lov.h.

#define LOV_integer_class_name_c   "ListOfValuesInteger"

Definition at line 42 of file lov.h.

#define LOV_name_size_c   32

Definition at line 51 of file lov.h.

#define LOV_root_class_name_c   "ListOfValues"

Definition at line 41 of file lov.h.

#define LOV_string_c   PROP_string

Definition at line 60 of file lov.h.

#define LOV_string_class_name_c   "ListOfValuesString"

Definition at line 45 of file lov.h.

#define LOV_tag_c   PROP_untyped_reference

Definition at line 62 of file lov.h.

#define LOV_tag_class_name_c   "ListOfValuesTag"

Definition at line 47 of file lov.h.

#define LOV_type_size_c   32

Definition at line 53 of file lov.h.

#define LOV_value_desc_size_c   256

Definition at line 54 of file lov.h.

Typedef Documentation

typedef enum LOV_attached_type_e LOV_attached_type_t

Attached Types

typedef enum LOV_usage_e LOV_usage_t

Defines the different restriction rules of LOV that are supported

Enumeration Type Documentation

enum LOV_attached_type_e

Attached Types

Enumerator
LOV_Unused	Unknown
LOV_Attribute	Reference by an attribute (int, string, ...)
LOV_Property	Reference by a property

Definition at line 79 of file lov.h.

enum LOV_usage_e

Defines the different restriction rules of LOV that are supported

Enumerator
LOV_Unknown	Unknown
LOV_Exhaustive_list	LOV is a exhaustive list
LOV_Suggestions	LOV is suggestions
LOV_Ranges	LOV is ranges
LOV_Upper_bound	upper boundary of this enumerate

Definition at line 67 of file lov.h.

Function Documentation

LOV_API int LOV_ask_attached_dependency_order	(	const char *	type_name,
		const char *	prop_name,
		int *	order
	)

Gets the dependency order of LOV that is attached to specified property. Default order is 0

Parameters

type_name	(I) The name of the Teamcenter Engineering type to which property belongs
prop_name	(I) Property name to which the LOV is attached
order	(O) the attach level of the LOV if found

LOV_API int LOV_ask_attached_dependency_orders	(	tag_t	lov_tag,
		int *	n_attached,
		int **	orders
	)

return the array of the dependency orders for all the attached properties.

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
n_attached	(O) Number of attached dependency orders returned
orders	(OF) n_attached Array of dependency orders

LOV_API int LOV_ask_attached_description_logical	(	const char *	type_name,
		const char *	prop_name,
		logical *	descAttach
	)

Gets a flag whether the specified property is a LOV description attach. Default is false (LOV value attach).

Parameters

type_name	(I) The name of the Teamcenter Engineering type to which property belongs
prop_name	(I) Property name to which the LOV is attached
descAttach	(O) description attach of the LOV if found

LOV_API int LOV_ask_attached_description_logicals	(	tag_t	lov_tag,
		int *	n_attached,
		logical **	desc_attach
	)

return the array of the flags to indicate if each attach is a description attach.

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
n_attached	(O) Number of attached descriptions returned
desc_attach	(OF) n_attached Array of attached description flags

LOV_API int LOV_ask_attached_parent_number	(	const char *	type_name,
		const char *	prop_name,
		int *	n_parent
	)

Gets parent number for the specified property-lov attachment Default is 0.

Parameters

type_name	(I) The name of the Teamcenter Engineering type to which property belongs
prop_name	(I) Property name to which the LOV is attached
n_parent	(O) parent number for lov-property attachment if found

LOV_API int LOV_ask_attached_parent_numbers	(	tag_t	lov_tag,
		int *	n_attached,
		int **	n_parents
	)

return the array of the ints about the parent number for each attachment.

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
n_attached	(O) Number of attached parent numbers returned
n_parents	(OF) n_attached Array of attached parent numbers

LOV_API int LOV_ask_attached_properties	(	tag_t	lov_tag,
		int *	n_attach,
		char ***	type_names,
		char ***	prop_names
	)

Finds the list of properties that are attached to the specified LOV.

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
n_attach	(O) The number of attachments
type_names	(OF) n_attach The name of theTeamcenter Engineering type to which the property belongs. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.
prop_names	(OF) n_attach The name of property to be detached. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.

LOV_API int LOV_ask_attached_properties_info	(	tag_t	lov_tag,
		int *	n_attach,
		char ***	type_names,
		char ***	prop_names,
		int **	orders,
		int **	n_parents,
		logical **	desc_attach
	)

Parameters

lov_tag	(I) The unique identifier (tag) of the LOV instance
n_attach	(O) The number of attachments
type_names	(OF) n_attach The name of the Teamcenter Engineering types to which the properties belong. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.
prop_names	(OF) n_attach The names of properties to be attached. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.
orders	(OF) n_attach The dependency order for each attachment
n_parents	(OF) n_attach Parent number to be combined with the leaf value
desc_attach	(OF) n_attach Array of description attachment flag

LOV_API int LOV_ask_attached_properties_info_with_conditions	(	tag_t	lov_tag,
		int *	n_attach,
		char ***	type_names,
		char ***	prop_names,
		int **	orders,
		int **	n_parents,
		logical **	desc_attach,
		tag_t **	conditions,
		logical **	overrides
	)

Parameters

lov_tag	(I) The unique identifier (tag) of the LOV instance
n_attach	(O) The number of attachments
type_names	(OF) n_attach The name of the Teamcenter Engineering types to which the properties belong. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.
prop_names	(OF) n_attach The names of properties to be attached. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.
orders	(OF) n_attach the dependency order for each attachment
n_parents	(OF) n_attach parent number to be combined with the leaf value
desc_attach	(OF) n_attach description attachment flag
conditions	(OF) n_attach condition attachment
overrides	(OF) n_attach condition attachment

LOV_API int LOV_ask_based_on_lov_shown_indexes	(	tag_t	lov_tag,
		tag_t *	based_on_lov,
		logical *	all_shown,
		int *	n_shown_indices,
		int **	shown_indices
	)

ask based-on-lov and shown indexes for a LOV Filter.

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
based_on_lov	(O) Based on LOV tag returned
all_shown	(O) true if all the values in the base lov are shown. In this case, all the shown indexes are returned for the base
n_shown_indices	(O) Number of shown indices returned
shown_indices	(OF) n_shown_indices Array of shown indices

LOV_API int LOV_ask_column_names	(	tag_t	lov_tag,
		tag_t *	lov_value_prop_desc_tag,
		tag_t *	lov_descr_prop_desc_tag,
		int *	num_filter_props,
		tag_t *	filter_prop_desc_tags[]
	)

Given a Dynamic LOV tag, this function will retrieve the LOV definition from the database and return the LOV value property name, the LOV description property name and the filter properties for the Dynamic LOV.

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
lov_value_prop_desc_tag	(O) Property Descriptor tag of the LOV Value Property
lov_descr_prop_desc_tag	(O) Property Descriptor tag of the LOV Description Property
num_filter_props	(O) Number of property Descriptor tags of the filter properties.
filter_prop_desc_tags	(OF) num_filter_props Property Descriptor tags of the filter properties.

LOV_API int LOV_ask_description	(	tag_t	lov,
		char	lov_desc[LOV_desc_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use LOV_ask_description2

Gets the description of a list of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_desc	(O) The description of a list of values

LOV_API int LOV_ask_description2	(	tag_t	lov,
		char **	lov_desc
	)

Gets the description of a list of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_desc	(OF) The description of a list of values

LOV_API int LOV_ask_disp_value_descriptions	(	tag_t	lov_tag,
		int *	n_desc_strings,
		char ***	desc_strings,
		logical **	is_null,
		logical **	is_empty
	)

Return display values of descriptions.

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
n_desc_strings	(O) Number of descriptions returned
desc_strings	(OF) n_desc_strings Display descriptions. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.
is_null	(OF) n_desc_strings Indicates which value(s) are null
is_empty	(OF) n_desc_strings Indicates which value(s) are empty

LOV_API int LOV_ask_disp_values	(	tag_t	lov_tag,
		LOV_usage_t *	usage,
		int *	n_values,
		logical **	is_null,
		logical **	is_empty,
		char ***	value_strings
	)

This ITK is for IMAN-PC and IMAN/Web and is intentionally not documented. We may, however, turn this ITK into public fully and document it in the future.

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
usage	(O) Usage of the LOV returned
n_values	(O) Number of values returned
is_null	(OF) n_values Indicates which value(s) are null
is_empty	(OF) n_values Indicates which value(s) are empty
value_strings	(OF) n_values The converted string values. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.

LOV_API int LOV_ask_disp_values_char	(	tag_t	lov,
		LOV_usage_t	lov_usage,
		int	n_values,
		const char *	values,
		const logical *	is_null,
		const logical *	is_empty,
		char ***	disp_values
	)

Converts an LOV to a list of strings. When the usage of the LOV is LOV_Ranges, an upper limit/lower limit pair must be set. The upper limit and lower limit values are used to put the values indicated by an even and odd index, respectively.

This function uses LOV_ask_disp_values_msg.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(I) Usage of the LOV
n_values	(I) Number of values to be converted
values	(I) n_values Values in the LOV
is_null	(I) n_values Indicates which value(s) are null
is_empty	(I) n_values Indicates which value(s) are empty
disp_values	(OF) n_values The converted string values. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.

LOV_API int LOV_ask_disp_values_date	(	tag_t	lov,
		LOV_usage_t	lov_usage,
		int	n_values,
		const date_t *	values,
		const logical *	is_null,
		const logical *	is_empty,
		char ***	disp_values
	)

Converts an LOV to a list of strings. When the usage of the LOV is LOV_Ranges, an upper limit/lower limit pair must be set. The upper limit and lower limit values are used to put the values indicated by an even and odd index, respectively.

This function uses LOV_ask_disp_values_msg.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(I) Usage of the LOV
n_values	(I) Number of values to be converted
values	(I) n_values Values in the LOV
is_null	(I) n_values Indicates which value(s) are null
is_empty	(I) n_values Indicates which value(s) are empty
disp_values	(OF) n_values The converted string values. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.

LOV_API int LOV_ask_disp_values_double	(	tag_t	lov,
		LOV_usage_t	lov_usage,
		int	n_values,
		const double *	values,
		const logical *	is_null,
		const logical *	is_empty,
		char ***	disp_values
	)

Converts an LOV to a list of strings. When the usage of the LOV is LOV_Ranges, an upper limit/lower limit pair must be set. The upper limit and lower limit values are used to put the values indicated by an even and odd index, respectively.

This function uses LOV_ask_disp_values_msg.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(I) Usage of the LOV
n_values	(I) Number of values to be converted
values	(I) n_values Values in the LOV
is_null	(I) n_values Indicates which value(s) are null
is_empty	(I) n_values Indicates which value(s) are empty
disp_values	(OF) n_values The converted string values. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.

LOV_API int LOV_ask_disp_values_int	(	tag_t	lov,
		LOV_usage_t	lov_usage,
		int	n_values,
		const int *	values,
		const logical *	is_null,
		const logical *	is_empty,
		char ***	disp_values
	)

Converts an LOV to a list of strings. When the usage of the LOV is LOV_Ranges, an upper limit/lower limit pair must be set. The upper limit and lower limit values are used to put the values indicated by an even and odd index, respectively.

This function uses LOV_ask_disp_values_msg.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(I) Usage of the LOV
n_values	(I) Number of values to be converted
values	(I) n_values Values in the LOV
is_null	(I) n_values Indicates which value(s) are null
is_empty	(I) n_values Indicates which value(s) are empty
disp_values	(OF) n_values The converted string values. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.

LOV_API int LOV_ask_disp_values_string	(	tag_t	lov,
		LOV_usage_t	lov_usage,
		int	n_values,
		const char **	values,
		const logical *	is_null,
		const logical *	is_empty,
		char ***	disp_values
	)

Converts an LOV to a list of strings. When the usage of the LOV is LOV_Ranges, an upper limit/lower limit pair must be set. The upper limit and lower limit values are used to put the values indicated by an even and odd index, respectively.

This function uses LOV_ask_disp_values_msg.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(I) Usage of the LOV
n_values	(I) Number of values to be converted
values	(I) n_values Values in the LOV
is_null	(I) n_values Indicates which value(s) are null
is_empty	(I) n_values Indicates which value(s) are empty
disp_values	(OF) n_values The converted string values. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.

LOV_API int LOV_ask_disp_values_tag	(	tag_t	lov,
		LOV_usage_t	lov_usage,
		int	n_values,
		const tag_t *	values,
		const logical *	is_null,
		const logical *	is_empty,
		char ***	disp_values
	)

Converts an LOV to a list of strings. When the usage of the LOV is LOV_Ranges, an upper limit/lower limit pair must be set. The upper limit and lower limit values are used to put the values indicated by an even and odd index, respectively.

This function uses LOV_ask_disp_values_msg.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(I) Usage of the LOV
n_values	(I) Number of values to be converted
values	(I) n_values Values in the LOV
is_null	(I) n_values Indicates which value(s) are null
is_empty	(I) n_values Indicates which value(s) are empty
disp_values	(OF) n_values The converted string values. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.

LOV_API int LOV_ask_disp_values_without_evaluation	(	tag_t	lov_tag,
		LOV_usage_t *	usage,
		int *	n_values,
		logical **	is_null,
		logical **	is_empty,
		char ***	value_strings
	)

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
usage	(O) Usage of the LOV returned
n_values	(O) Number of values returned
is_null	(OF) n_values Indicates which value(s) are null
is_empty	(OF) n_values Indicates which value(s) are empty
value_strings	(OF) n_values The converted string values. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.

LOV_API int LOV_ask_lov_char	(	tag_t	lov,
		LOV_usage_t *	lov_usage,
		int *	n_values,
		char **	values,
		logical **	is_null,
		logical **	is_empty
	)

Asks a range of values from the specified LOV. When the usage of the LOV is LOV_Ranges, an upper limit/lower limit pair will be returned. The upper limit and lower limit values are put in the values indicated by an even and odd index, respectively.

This function uses LOV_ask_values_msg when the usage is LOV_Exhaustive_list or LOV_Suggestions.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(O) Usage of the LOV
n_values	(O) Number of values returned
values	(OF) n_values Values in the LOV
is_null	(OF) n_values Indicates which value(s) are null
is_empty	(OF) n_values Indicates which value(s) are empty

LOV_API int LOV_ask_lov_char_without_evaluation	(	tag_t	lov,
		LOV_usage_t *	lov_usage,
		int *	n_values,
		char **	values,
		logical **	is_null,
		logical **	is_empty
	)

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(O) Usage of the LOV
n_values	(O) Number of values returned
values	(OF) n_values Values in the LOV
is_null	(OF) n_values Indicates which value(s) are null
is_empty	(OF) n_values Indicates which value(s) are empty

LOV_API int LOV_ask_lov_date	(	tag_t	lov,
		LOV_usage_t *	lov_usage,
		int *	n_values,
		date_t **	values,
		logical **	is_null,
		logical **	is_empty
	)

Asks a range of values from the specified LOV. When the usage of the LOV is LOV_Ranges, an upper limit/lower limit pair will be returned. The upper limit and lower limit values are put in the values indicated by an even and odd index, respectively.

This function uses LOV_ask_values_msg when the usage is LOV_Exhaustive_list or LOV_Suggestions.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(O) Usage of the LOV
n_values	(O) Number of values returned
values	(OF) n_values Values in the LOV
is_null	(OF) n_values Indicates which value(s) are null
is_empty	(OF) n_values Indicates which value(s) are empty

LOV_API int LOV_ask_lov_date_without_evaluation	(	tag_t	lov,
		LOV_usage_t *	lov_usage,
		int *	n_values,
		date_t **	values,
		logical **	is_null,
		logical **	is_empty
	)

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(O) Usage of the LOV
n_values	(O) Number of values returned
values	(OF) n_values Values in the LOV
is_null	(OF) n_values Indicates which value(s) are null
is_empty	(OF) n_values Indicates which value(s) are empty

LOV_API int LOV_ask_lov_double	(	tag_t	lov,
		LOV_usage_t *	lov_usage,
		int *	n_values,
		double **	values,
		logical **	is_null,
		logical **	is_empty
	)

Asks a range of values from the specified LOV. When the usage of the LOV is LOV_Ranges, an upper limit/lower limit pair will be returned. The upper limit and lower limit values are put in the values indicated by an even and odd index, respectively.

This function uses LOV_ask_values_msg when the usage is LOV_Exhaustive_list or LOV_Suggestions.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(O) Usage of the LOV
n_values	(O) Number of values returned
values	(OF) n_values Values in the LOV
is_null	(OF) n_values Indicates which value(s) are null
is_empty	(OF) n_values Indicates which value(s) are empty

LOV_API int LOV_ask_lov_double_without_evaluation	(	tag_t	lov,
		LOV_usage_t *	lov_usage,
		int *	n_values,
		double **	values,
		logical **	is_null,
		logical **	is_empty
	)

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(O) Usage of the LOV
n_values	(O) Number of values returned
values	(OF) n_values Values in the LOV
is_null	(OF) n_values Indicates which value(s) are null
is_empty	(OF) n_values Indicates which value(s) are empty

LOV_API int LOV_ask_lov_int	(	tag_t	lov,
		LOV_usage_t *	lov_usage,
		int *	n_values,
		int **	values,
		logical **	is_null,
		logical **	is_empty
	)

Asks a range of values from the specified LOV. When the usage of the LOV is LOV_Ranges, an upper limit/lower limit pair will be returned. The upper limit and lower limit values are put in the values indicated by an even and odd index, respectively.

This function uses LOV_ask_values_msg when the usage is LOV_Exhaustive_list or LOV_Suggestions.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(O) Usage of the LOV
n_values	(O) Number of values returned
values	(OF) n_values Values in the LOV
is_null	(OF) n_values Indicates which value(s) are null
is_empty	(OF) n_values Indicates which value(s) are empty

LOV_API int LOV_ask_lov_int_without_evaluation	(	tag_t	lov,
		LOV_usage_t *	lov_usage,
		int *	n_values,
		int **	values,
		logical **	is_null,
		logical **	is_empty
	)

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(O) Usage of the LOV
n_values	(O) Number of values returned
values	(OF) n_values Values in the LOV
is_null	(OF) n_values Indicates which value(s) are null
is_empty	(OF) n_values Indicates which value(s) are empty

LOV_API int LOV_ask_lov_string	(	tag_t	lov,
		LOV_usage_t *	lov_usage,
		int *	n_values,
		char ***	values,
		logical **	is_null,
		logical **	is_empty
	)

Asks a range of values from the specified LOV. When the usage of the LOV is LOV_Ranges, an upper limit/lower limit pair will be returned. The upper limit and lower limit values are put in the values indicated by an even and odd index, respectively.

This function uses LOV_ask_values_msg when the usage is LOV_Exhaustive_list or LOV_Suggestions.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(O) Usage of the LOV
n_values	(O) Number of values returned
values	(OF) n_values Values in the LOV. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.
is_null	(OF) n_values Indicates which value(s) are null
is_empty	(OF) n_values Indicates which value(s) are empty

LOV_API int LOV_ask_lov_string_without_evaluation	(	tag_t	lov,
		LOV_usage_t *	lov_usage,
		int *	n_values,
		char ***	values,
		logical **	is_null,
		logical **	is_empty
	)

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(O) Usage of the LOV
n_values	(O) Number of values returned
values	(OF) n_values Values in the LOV. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.
is_null	(OF) n_values Indicates which value(s) are null
is_empty	(OF) n_values Indicates which value(s) are empty

LOV_API int LOV_ask_lov_tag	(	tag_t	lov,
		LOV_usage_t *	lov_usage,
		int *	n_values,
		tag_t **	values,
		logical **	is_null,
		logical **	is_empty
	)

Asks a range of values from the specified LOV. When the usage of the LOV is LOV_Ranges, an upper limit/lower limit pair will be returned. The upper limit and lower limit values are put in the values indicated by an even and odd index, respectively.

This function uses LOV_ask_values_msg when the usage is LOV_Exhaustive_list or LOV_Suggestions.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(O) Usage of the LOV
n_values	(O) Number of values returned
values	(OF) n_values Values in the LOV
is_null	(OF) n_values Indicates which value(s) are null
is_empty	(OF) n_values Indicates which value(s) are empty

LOV_API int LOV_ask_name	(	tag_t	lov,
		char	lov_name[LOV_name_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use LOV_ask_name2

Gets the name of an LOV.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_name	(O) The name of an LOV

LOV_API int LOV_ask_name2	(	tag_t	lov,
		char **	lov_name
	)

Gets the name of an LOV.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_name	(OF) The name of an LOV

LOV_API int LOV_ask_num_of_values	(	tag_t	lov,
		int *	length
	)

Gets the number of values in an LOV.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
length	(O) The number of values

LOV_API int LOV_ask_range_lower_char	(	tag_t	lov,
		char *	value,
		logical *	is_it_null,
		logical *	is_it_empty
	)

Gets the lower limit for a range of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(O) The values of lower limit
is_it_null	(O) Returns TRUE if lower limit is null
is_it_empty	(O) Returns TRUE if lower limit is empty

LOV_API int LOV_ask_range_lower_date	(	tag_t	lov,
		date_t *	value,
		logical *	is_it_null,
		logical *	is_it_empty
	)

Gets the lower limit for a range of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(O) The values of lower limit
is_it_null	(O) Returns TRUE if lower limit is null
is_it_empty	(O) Returns TRUE if lower limit is empty

LOV_API int LOV_ask_range_lower_double	(	tag_t	lov,
		double *	value,
		logical *	is_it_null,
		logical *	is_it_empty
	)

Gets the lower limit for a range of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(O) The values of lower limit
is_it_null	(O) Returns TRUE if lower limit is null
is_it_empty	(O) Returns TRUE if lower limit is empty

LOV_API int LOV_ask_range_lower_int	(	tag_t	lov,
		int *	value,
		logical *	is_it_null,
		logical *	is_it_empty
	)

Gets the lower limit for a range of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(O) The values of lower limit
is_it_null	(O) Returns TRUE if lower limit is null
is_it_empty	(O) Returns TRUE if lower limit is empty

LOV_API int LOV_ask_range_lower_string	(	tag_t	lov,
		char **	value,
		logical *	is_it_null,
		logical *	is_it_empty
	)

Gets the lower limit for a range of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(OF) The values of lower limit
is_it_null	(O) Returns TRUE if lower limit is null
is_it_empty	(O) Returns TRUE if lower limit is empty

LOV_API int LOV_ask_range_upper_char	(	tag_t	lov,
		char *	value,
		logical *	is_it_null,
		logical *	is_it_empty
	)

Gets the upper limit for a range of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(O) The values of upper limit
is_it_null	(O) Returns TRUE if upper limit is not set
is_it_empty	(O) Returns TRUE if upper limit is empty

LOV_API int LOV_ask_range_upper_date	(	tag_t	lov,
		date_t *	value,
		logical *	is_it_null,
		logical *	is_it_empty
	)

Gets the upper limit for a range of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(O) The values of upper limit
is_it_null	(O) Returns TRUE if upper limit is not set
is_it_empty	(O) Returns TRUE if upper limit is empty

LOV_API int LOV_ask_range_upper_double	(	tag_t	lov,
		double *	value,
		logical *	is_it_null,
		logical *	is_it_empty
	)

Gets the upper limit for a range of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(O) The values of upper limit
is_it_null	(O) Returns TRUE if upper limit is not set
is_it_empty	(O) Returns TRUE if upper limit is empty

LOV_API int LOV_ask_range_upper_int	(	tag_t	lov,
		int *	value,
		logical *	is_it_null,
		logical *	is_it_empty
	)

Gets the upper limit for a range of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(O) The values of upper limit
is_it_null	(O) Returns TRUE if upper limit is not set
is_it_empty	(O) Returns TRUE if upper limit is empty

LOV_API int LOV_ask_range_upper_string	(	tag_t	lov,
		char **	value,
		logical *	is_it_null,
		logical *	is_it_empty
	)

Gets the upper limit for a range of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(OF) The values of upper limit
is_it_null	(O) Returns TRUE if upper limit is not set
is_it_empty	(O) Returns TRUE if upper limit is empty

LOV_API int LOV_ask_reference	(	tag_t	lov,
		char **	class_name,
		char **	attr_name
	)

Asks reference information from the specified LOV.

Note

Only the data type tag can contain reference information.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
class_name	(OF) POM class name
attr_name	(OF) POM attribute name

LOV_API int LOV_ask_type	(	tag_t	lov,
		char	lov_type[LOV_type_size_c+1]
	)

Deprecated:

This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use LOV_ask_type2

Gets the type of a list of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_type	(O) The type of a list of values

LOV_API int LOV_ask_type2	(	tag_t	lov,
		char **	lov_type
	)

Gets the type of a list of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_type	(OF) The type of a list of values

LOV_API int LOV_ask_usage	(	tag_t	lov_tag,
		LOV_usage_t *	usage
	)

Gets the usage of an LOV.

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
usage	(O) The usage of this list. One of the following: LOV_Exhaustive_list LOV_Suggestions LOV_Ranges

LOV_API int LOV_ask_value_classifications	(	tag_t	lov_tag,
		int *	n_classifications,
		char ***	classifications
	)

return the array of the strings as the classifications for values. If the usage of the LOV is LOV_Ranges, or if no classifications are defined, NULL array is returned.

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
n_classifications	(O) Number of classifications returned
classifications	(OF) n_classifications The output string values. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.

LOV_API int LOV_ask_value_descriptions	(	tag_t	lov_tag,
		LOV_usage_t *	usage,
		int *	n_values,
		char ***	desc_strings,
		logical **	is_null,
		logical **	is_empty
	)

return the array of the strings as the descriptions for values. If the usage of the LOV is LOV_Ranges, or if no descriptions are defined, NULL array is returned.

This function uses LOV_ask_value_desc_msg.

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
usage	(O) Usage of the LOV returned
n_values	(O) Number of values returned
desc_strings	(OF) n_values The converted string values. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.
is_null	(OF) n_values Indicates which value(s) are null
is_empty	(OF) n_values Indicates which value(s) are empty

LOV_API int LOV_ask_value_filters	(	tag_t	lov_tag,
		int *	n_list_of_filters,
		int **	list_of_filter_indices,
		tag_t **	list_of_filters
	)

return the array of the value indexes and their filters.

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
n_list_of_filters	(O) Number of lists of filters returned
list_of_filter_indices	(OF) n_list_of_filters Array of filter indices
list_of_filters	(OF) n_list_of_filters Array of filter tags

LOV_API int LOV_ask_value_type	(	tag_t	lov_tag,
		PROP_value_type_t *	value_type
	)

Gets the value type of an LOV.

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
value_type	(O) The type of values in list. Choose one of the following: PROP_char PROP_date PROP_double PROP_float PROP_int PROP_logical PROP_short PROP_string PROP_typed_reference PROP_untyped_reference PROP_external_reference PROP_note PROP_typed_relation PROP_untyped_relation

LOV_API int LOV_ask_values_char	(	tag_t	lov,
		int *	n_values,
		char **	values
	)

Gets the values in an LOV.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
n_values	(O) The number of returned values
values	(OF) n_values Values in the LOV

LOV_API int LOV_ask_values_char_without_evaluation	(	tag_t	lov,
		int *	n_values,
		char **	values
	)

Gets all the values in an LOV without evaluation of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
n_values	(O) The number of returned values
values	(OF) n_values Values in the LOV

LOV_API int LOV_ask_values_date	(	tag_t	lov,
		int *	n_values,
		date_t **	values
	)

Gets the values in an LOV.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
n_values	(O) The number of returned values
values	(OF) n_values Values in the LOV

LOV_API int LOV_ask_values_date_without_evaluation	(	tag_t	lov,
		int *	n_values,
		date_t **	values
	)

Gets all the date values in an LOV without evaluation.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
n_values	(O) The number of returned values
values	(OF) n_values Values in the LOV

LOV_API int LOV_ask_values_display_string	(	tag_t	lov,
		LOV_usage_t *	lov_usage,
		int *	n_values,
		char ***	display_values,
		char ***	values
	)

Returns both display values and values, sorted by display values

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(O) Usage of the LOV
n_values	(O) Number of values returned
display_values	(OF) n_values The display values for the LOV. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.
values	(OF) n_values The values for the LOV. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.

LOV_API int LOV_ask_values_display_tag	(	tag_t	lov,
		LOV_usage_t *	lov_usage,
		int *	n_values,
		char ***	display_values,
		tag_t **	values
	)

Returns both display values and values, sorted by display values

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
lov_usage	(O) Usage of the LOV returned
n_values	(O) Number of values returned
display_values	(OF) n_values The display values for the LOV. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.
values	(OF) n_values Values in the LOV.

LOV_API int LOV_ask_values_double	(	tag_t	lov,
		int *	n_values,
		double **	values
	)

Gets the values in an LOV.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
n_values	(O) The number of returned values
values	(OF) n_values Values in the LOV

LOV_API int LOV_ask_values_double_without_evaluation	(	tag_t	lov,
		int *	n_values,
		double **	values
	)

Gets all the values in an LOV wihout evaluation of values.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
n_values	(O) The number of returned values
values	(OF) n_values Values in the LOV

LOV_API int LOV_ask_values_from_disp_values_string	(	tag_t	pd_tag,
		int	n_values,
		const char **	disp_values,
		int *	n_internal_values,
		char ***	internal_values
	)

Returns display values corresponding to internal values. Display value passed in can be a string or a pattern e.g (A*, AB*, AB). Input prop desc can have dynamic and static lovs attached. Returns input values disp_values, appended in internal_values at the end. If * is supplied as input, it is not processed and returned in output as it is. If property desc has not lov attached, input values are returned as it is.

Parameters

pd_tag	(I) Property Desc Tag
n_values	(I) Number of display values
disp_values	(I) n_values Display values, it can be pattern
n_internal_values	(O) Number of internal values found
internal_values	(OF) n_internal_values internal values. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.

LOV_API int LOV_ask_values_int	(	tag_t	lov,
		int *	n_values,
		int **	values
	)

Gets the values in an LOV.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
n_values	(O) The number of returned values
values	(OF) n_values Values in the LOV

LOV_API int LOV_ask_values_int_without_evaluation	(	tag_t	lov_tag,
		int *	n_values,
		int **	values
	)

Gets the values in an Integer LOV without evaluation.

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
n_values	(O) The number of returned values
values	(OF) n_values Values in the LOV.

LOV_API int LOV_ask_values_string	(	tag_t	lov,
		int *	n_values,
		char ***	values
	)

Gets the values in an LOV.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
n_values	(O) The number of returned values
values	(OF) n_values Values in the LOV. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.

LOV_API int LOV_ask_values_string_without_evaluation	(	tag_t	lov,
		int *	n_values,
		char ***	values
	)

Gets the values in an String LOV without evaluation.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
n_values	(O) The number of returned values
values	(OF) n_values Values in the LOV. Iterate through the output array and call MEM_free on each element to de-allocate the nested memory block.

LOV_API int LOV_ask_values_tag	(	tag_t	lov,
		int *	n_values,
		tag_t **	values
	)

Gets the values in an LOV.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
n_values	(O) The number of returned values
values	(OF) n_values Values in the LOV

LOV_API int LOV_execute_dynamic_lov	(	const tag_t	lov_tag,
		const tag_t	object_tag,
		const char *	prop_name,
		const char *	filter_string,
		const int	max_results,
		const char *	sort_property_name,
		const int	order,
		int *	num_results,
		tag_t **	results
	)

Given a Dynamic LOV tag and user entered search string that is used to filter the results, this function will return a list of objects that match the query criteria for the Dynamic LOV including the filter string entered by the user.

Parameters

lov_tag	(I) Unique identifier (tag) of the LOV instance
object_tag	(I) This is an optional argument. It represents a runtime object which will be used in the future to evaluate LOV values based on context
prop_name	(I) The property name for which the LOV values are being evaluated
filter_string	(I) The user entered string.
max_results	(I) Maximum values the client wants to be returned from the server
sort_property_name	(I) Property name used to sort the results
order	(I) A value of 1 indicates sort property values to be in ascending order. A value of 2 indicates sort property values to be in descending order.
num_results	(O) Number of objects that match the query criteria for the Dynamic LOV
results	(OF) num_results Objects that match the query criteria for the Dynamic LOV

LOV_API int LOV_extent	(	int *	n_lovs,
		tag_t **	lov
	)

Gets the lists of all the list of values in the database.

Parameters

n_lovs	(O) The number of the lists of values in the database
lov	(OF) n_lovs The list of tags for all the LOVs in the database

LOV_API int LOV_find	(	const char *	lov_name,
		int *	n_lovs,
		tag_t **	lov
	)

Gets all LOVs with the specified name.

Parameters

lov_name	(I) The name of the LOV
n_lovs	(O) The number of the found lists of values
lov	(OF) n_lovs The tags of the found LOV

LOV_API int LOV_find_attached_prop	(	const char *	type_name,
		const char *	prop_name,
		tag_t *	lov
	)

Gets LOV that is attached to specified property. If the returned lov is NULLTAG, specified property does not have an LOV.

Parameters

type_name	(I) The name of the Teamcenter Engineering type to which property belongs
prop_name	(I) Property name to which the LOV is attached
lov	(O) Unique identifier (tag) of the LOV instance

LOV_API int LOV_is_value_valid_char	(	tag_t	lov,
		char	value,
		logical *	answer
	)

Verifies that an LOV value is valid.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(I) The value to be verified
answer	(O) Returns TRUE if valid and FALSE if not valid

LOV_API int LOV_is_value_valid_date	(	tag_t	lov,
		date_t	value,
		logical *	answer
	)

Verifies that an LOV value is valid.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(I) The value to be verified
answer	(O) Returns TRUE if valid and FALSE if not valid

LOV_API int LOV_is_value_valid_double	(	tag_t	lov,
		double	value,
		logical *	answer
	)

Verifies that an LOV value is valid.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(I) The value to be verified
answer	(O) Returns TRUE if valid and FALSE if not valid

LOV_API int LOV_is_value_valid_int	(	tag_t	lov,
		int	value,
		logical *	answer
	)

Verifies that an LOV value is valid.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(I) The value to be verified
answer	(O) Returns TRUE if valid and FALSE if not valid

LOV_API int LOV_is_value_valid_string	(	tag_t	lov,
		const char *	value,
		logical *	answer
	)

Verifies that an LOV value is valid.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(I) The value to be verified
answer	(O) Returns TRUE if valid and FALSE if not valid

LOV_API int LOV_is_value_valid_tag	(	tag_t	lov,
		tag_t	value,
		logical *	answer
	)

Verifies that an LOV value is valid.

Parameters

lov	(I) Unique identifier (tag) of the LOV instance
value	(I) The value to be verified
answer	(O) Returns TRUE if valid and FALSE if not valid