Modules
	DMI Constants

	DMI Errors

	DMI Handler

Functions
DMI_API int	DMI_ask_dataset_ref (tag_t dataset, char **named_ref)

DMI_API int	DMI_ask_image_markups (tag_t image, tag_t markup_type, int n_markups, tag_t *markups)

DMI_API int	DMI_ask_mapping_types_count (int *count)

DMI_API int	DMI_ask_markup_types (const char image_type_name[WSO_name_size_c+1], int markuptypes_count, char **markuptypes_names)

DMI_API int	DMI_ask_markup_types2 (const char image_type_name, int markuptypes_count, char ***markuptypes_names)

DMI_API int	DMI_ask_tempmarkup_type (const char markup_type_name[WSO_name_size_c+1], char **tempmarkup_type_name)

DMI_API int	DMI_ask_tempmarkup_type2 (const char markup_type_name, char *tempmarkup_type_name)

DMI_API int	DMI_create_markup (tag_t image, const char markup_name[WSO_name_size_c+1], const char markup_desc[WSO_desc_size_c+1], const char markup_type[WSO_name_size_c+1], tag_t *markup)

DMI_API int	DMI_create_markup2 (tag_t image, const char markup_name, const char markup_desc, const char markup_type, tag_t markup)

DMI_API int	DMI_delete_image (tag_t image)

DMI_API int	DMI_delete_image_named_ref (tag_t image)

DMI_API int	DMI_delete_markup (tag_t markup)

DMI_API int	DMI_delete_markup_named_ref (tag_t markup)

DMI_API int	DMI_delete_thumbnail_named_ref (tag_t image)

DMI_API int	DMI_fetch_image_file (tag_t image, const char dest_dir[DMI_path_name_size_c+1], char image_name[DMI_file_name_size_c+1])

DMI_API int	DMI_fetch_image_file2 (tag_t image, const char dest_dir, char *image_name)

DMI_API int	DMI_fetch_image_markup_files (tag_t image, const char dest_dir[DMI_path_name_size_c+1], int n_files, char image_file, char **markup_files)

DMI_API int	DMI_fetch_image_markup_files2 (tag_t image, const char dest_dir, int n_files, char image_file, char *markup_files)

DMI_API int	DMI_fetch_markup_file (tag_t markup, const char dest_dir[DMI_path_name_size_c+1], char image_file, char markup_file)

DMI_API int	DMI_fetch_markup_file2 (tag_t markup, const char dest_dir, char image_file, char *markup_file)

DMI_API int	DMI_fetch_thumbnail_file (tag_t image, const char dest_dir[DMI_path_name_size_c+1], char thumbnail_name[DMI_file_name_size_c+1])

DMI_API int	DMI_fetch_thumbnail_file2 (tag_t image, const char dest_dir, char *thumbnail_name)

DMI_API int	DMI_init_module (void)

DMI_API int	DMI_merge_image_markup_files (tag_t image, tag_t markup_type, tag_t *new_markup)

DMI_API int	DMI_revise_image (tag_t image, const char image_file_name[DMI_file_name_size_c+1], const char path_name[DMI_path_name_size_c+1], tag_t *new_image_rev)

DMI_API int	DMI_revise_image2 (tag_t image, const char image_file_name, const char path_name, tag_t *new_image_rev)

DMI_API int	DMI_revise_markup (tag_t markup, const char markup_file_name[DMI_file_name_size_c+1], const char path_name[DMI_path_name_size_c+1], tag_t *new_markup_rev)

DMI_API int	DMI_revise_markup2 (tag_t markup, const char markup_file_name, const char path_name, tag_t *new_markup_rev)

DMI_API int	DMI_revise_thumbnail (tag_t image, const char thumbnail_file_name[DMI_file_name_size_c+1], const char path_name[DMI_path_name_size_c+1], tag_t *new_image_rev)

DMI_API int	DMI_revise_thumbnail2 (tag_t image, const char thumbnail_file_name, const char path_name, tag_t *new_image_rev)

DMI_API int	DMI_store_image_file (tag_t image, const char image_file_name[DMI_file_name_size_c+1], const char path_name[DMI_path_name_size_c+1])

DMI_API int	DMI_store_image_file2 (tag_t image, const char image_file_name, const char path_name)

DMI_API int	DMI_store_markup_file (tag_t markup, const char markup_file_name[DMI_file_name_size_c+1], const char path_name[DMI_path_name_size_c+1])

DMI_API int	DMI_store_markup_file2 (tag_t markup, const char markup_file_name, const char path_name)

DMI_API int	DMI_store_thumbnail_file (tag_t image, const char thumbnail_file_name[DMI_file_name_size_c+1], const char path_name[DMI_path_name_size_c+1])

DMI_API int	DMI_store_thumbnail_file2 (tag_t image, const char thumbnail_file_name, const char path_name)

DMI_API int	DMI_update_markup (tag_t markup)

DMI_API int	DMI_verify_image (tag_t image, logical *answer)

Detailed Description

Function Documentation

DMI_API int DMI_ask_dataset_ref	(	tag_t	dataset,
		char **	named_ref
	)

Parameters

dataset	(I)
named_ref	(OF)

DMI_API int DMI_ask_image_markups	(	tag_t	image,
		tag_t	markup_type,
		int *	n_markups,
		tag_t **	markups
	)

Asks markups datasets that are associated to an image.

Parameters

image	(I) Tag of an image dataset
markup_type	(I) Tag of the markup type. If NULLTAG is entered, the default markup type "Markup" will be used.
n_markups	(O) Number of markups found
markups	(OF) n_markups Array of markup tags

DMI_API int DMI_ask_mapping_types_count ( int * count )

Asks for mapping types count.

Parameters

count (O) Number of mapping types

DMI_API int DMI_ask_markup_types	(	const char	image_type_name[WSO_name_size_c+1],
		int *	markuptypes_count,
		char ***	markuptypes_names
	)

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

Asks for all defined markup types that can be used for marking up a given image type.

Parameters

image_type_name	(I) Name of the dataset type
markuptypes_count	(O) Number of markup types
markuptypes_names	(OF) markuptypes_count Arrays of markup type names

DMI_API int DMI_ask_markup_types2	(	const char *	image_type_name,
		int *	markuptypes_count,
		char ***	markuptypes_names
	)

Parameters

image_type_name	(I) Name of the dataset type
markuptypes_count	(O) Number of markup types
markuptypes_names	(OF) markuptypes_count Arrays of markup type names

DMI_API int DMI_ask_tempmarkup_type	(	const char	markup_type_name[WSO_name_size_c+1],
		char **	tempmarkup_type_name
	)

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

Asks for temporary markup type of a given markup type.

Parameters

markup_type_name	(I) Name of a markup type
tempmarkup_type_name	(OF) Name of a temporary markup type

DMI_API int DMI_ask_tempmarkup_type2	(	const char *	markup_type_name,
		char **	tempmarkup_type_name
	)

Parameters

markup_type_name	(I) Name of a markup type
tempmarkup_type_name	(OF) Name of a temporary markup type

DMI_API int DMI_create_markup	(	tag_t	image,
		const char	markup_name[WSO_name_size_c+1],
		const char	markup_desc[WSO_desc_size_c+1],
		const char	markup_type[WSO_name_size_c+1],
		tag_t *	markup
	)

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

Creates a markup dataset.

Parameters

image	(I) Tag of an image dataset which a markup will be created
markup_name	(I) Name of the markup dataset
markup_desc	(I) Description of the markup dataset
markup_type	(I) Dataset type name that will be used for creating markup. If no type name is entered, the default markup type "Markup" will be used.
markup	(O) Tag of the created markup dataset

DMI_API int DMI_create_markup2	(	tag_t	image,
		const char *	markup_name,
		const char *	markup_desc,
		const char *	markup_type,
		tag_t *	markup
	)

Parameters

image	(I) Tag of an image dataset which a markup will be created
markup_name	(I) Name of the markup dataset
markup_desc	(I) Description of the markup dataset
markup_type	(I) Dataset type name that will be used for creating markup. If no type name is entered, the default markup type "Markup" will be used.
markup	(O) Tag of the created markup dataset

DMI_API int DMI_delete_image ( tag_t image )

Deletes an image dataset and its associated markup datasets.

Parameters

image (I) Tag of a dataset

DMI_API int DMI_delete_image_named_ref ( tag_t image )

Deletes a named reference of an image dataset.

Parameters

image (I) Tag of an image dataset

DMI_API int DMI_delete_markup ( tag_t markup )

Deletes a markup dataset.

Parameters

markup (I) Tag of a markup dataset to be deleted

DMI_API int DMI_delete_markup_named_ref ( tag_t markup )

Deletes a named reference of a markup dataset.

Parameters

markup (I) Tag of a markup dataset

DMI_API int DMI_delete_thumbnail_named_ref ( tag_t image )

Parameters

image (I)

DMI_API int DMI_fetch_image_file	(	tag_t	image,
		const char	dest_dir[DMI_path_name_size_c+1],
		char	image_name[DMI_file_name_size_c+1]
	)

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

Fetches an image file from a dataset.

Parameters

image	(I) Tag of a dataset that is used for storing image file
dest_dir	(I) Directory where the image file will be fetched to
image_name	(O) Fetched image file name

DMI_API int DMI_fetch_image_file2	(	tag_t	image,
		const char *	dest_dir,
		char **	image_name
	)

Fetches an image file from a dataset.

Parameters

image	(I) Tag of a dataset that is used for storing image file
dest_dir	(I) Directory where the image file will be fetched to
image_name	(OF) Fetched image file name

DMI_API int DMI_fetch_image_markup_files	(	tag_t	image,
		const char	dest_dir[DMI_path_name_size_c+1],
		int *	n_files,
		char **	image_file,
		char ***	markup_files
	)

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

Gets all image and markup files.

Parameters

image	(I) Tag of an image dataset
dest_dir	(I) Directory path where all files will be fetched to
n_files	(O) Number of fetched files
image_file	(OF) Name of image file
markup_files	(OF) n_files Array of markup filenames

DMI_API int DMI_fetch_image_markup_files2	(	tag_t	image,
		const char *	dest_dir,
		int *	n_files,
		char **	image_file,
		char ***	markup_files
	)

Parameters

image	(I) Tag of an image dataset
dest_dir	(I) Directory path where all files will be fetched to
n_files	(O) Number of fetched files
image_file	(OF) Name of image file
markup_files	(OF) n_files Array of markup filenames

DMI_API int DMI_fetch_markup_file	(	tag_t	markup,
		const char	dest_dir[DMI_path_name_size_c+1],
		char **	image_file,
		char **	markup_file
	)

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

Fetches markup file and its associated image file.

Parameters

markup	(I) Tag of a markup dataset
dest_dir	(I) Directory path where markup and image files should be fetched to
image_file	(OF) Name of the fetched image file
markup_file	(OF) Name of the fetched markup file

DMI_API int DMI_fetch_markup_file2	(	tag_t	markup,
		const char *	dest_dir,
		char **	image_file,
		char **	markup_file
	)

Parameters

markup	(I) Tag of a markup dataset
dest_dir	(I) Directory path where markup and image files should be fetched to
image_file	(OF) Name of the fetched image file
markup_file	(OF) Name of the fetched markup file

DMI_API int DMI_fetch_thumbnail_file	(	tag_t	image,
		const char	dest_dir[DMI_path_name_size_c+1],
		char	thumbnail_name[DMI_file_name_size_c+1]
	)

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

Parameters

image	(I)
dest_dir	(I)
thumbnail_name	(O)

DMI_API int DMI_fetch_thumbnail_file2	(	tag_t	image,
		const char *	dest_dir,
		char **	thumbnail_name
	)

Parameters

image	(I)
dest_dir	(I)
thumbnail_name	(OF)

DMI_API int DMI_init_module ( void )

Initializes the DMI module. No DMI functions will work unless the module is initialized. The initialization must be called after the login into Teamcenter Engineering is established.

DMI_API int DMI_merge_image_markup_files	(	tag_t	image,
		tag_t	markup_type,
		tag_t *	new_markup
	)

Merges all markup files that are associated with an image into a new markup dataset.

Parameters

image	(I) Tag of an image dataset
markup_type	(I) Tag of the markup dataset type. If NULLTAG is entered, the default markup type "Markup" is used.
new_markup	(O) Tag of the new markup dataset

DMI_API int DMI_revise_image	(	tag_t	image,
		const char	image_file_name[DMI_file_name_size_c+1],
		const char	path_name[DMI_path_name_size_c+1],
		tag_t *	new_image_rev
	)

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

Creates a new revision of image dataset.

Parameters

image	(I) Tag of an image dataset
image_file_name	(I) Name of image file
path_name	(I) Directory path where the image file is located
new_image_rev	(O) Tag of the image dataset revision

DMI_API int DMI_revise_image2	(	tag_t	image,
		const char *	image_file_name,
		const char *	path_name,
		tag_t *	new_image_rev
	)

Parameters

image	(I) Tag of an image dataset
image_file_name	(I) Name of image file
path_name	(I) Directory path where the image file is located
new_image_rev	(O) Tag of the image dataset revision

DMI_API int DMI_revise_markup	(	tag_t	markup,
		const char	markup_file_name[DMI_file_name_size_c+1],
		const char	path_name[DMI_path_name_size_c+1],
		tag_t *	new_markup_rev
	)

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

Creates a new revision of image dataset.

Parameters

markup	(I) Tag of a markup dataset
markup_file_name	(I) Name of a markup file
path_name	(I) Directory path where the markup file is located
new_markup_rev	(O) Tag of the markup dataset revision

DMI_API int DMI_revise_markup2	(	tag_t	markup,
		const char *	markup_file_name,
		const char *	path_name,
		tag_t *	new_markup_rev
	)

Parameters

markup	(I) Tag of a markup dataset
markup_file_name	(I) Name of a markup file
path_name	(I) Directory path where the markup file is located
new_markup_rev	(O) Tag of the markup dataset revision

DMI_API int DMI_revise_thumbnail	(	tag_t	image,
		const char	thumbnail_file_name[DMI_file_name_size_c+1],
		const char	path_name[DMI_path_name_size_c+1],
		tag_t *	new_image_rev
	)

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

Parameters

image	(I)
thumbnail_file_name	(I)
path_name	(I)
new_image_rev	(O)

DMI_API int DMI_revise_thumbnail2	(	tag_t	image,
		const char *	thumbnail_file_name,
		const char *	path_name,
		tag_t *	new_image_rev
	)

Parameters

image	(I)
thumbnail_file_name	(I)
path_name	(I)
new_image_rev	(O)

DMI_API int DMI_store_image_file	(	tag_t	image,
		const char	image_file_name[DMI_file_name_size_c+1],
		const char	path_name[DMI_path_name_size_c+1]
	)

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

Stores an image file to a dataset.

Parameters

image	(I) Tag of a dataset that is used for storing image file
image_file_name	(I) Name of a file to be stored in dataset
path_name	(I) Directory path where the image_file_name located

DMI_API int DMI_store_image_file2	(	tag_t	image,
		const char *	image_file_name,
		const char *	path_name
	)

Parameters

image	(I) Tag of a dataset that is used for storing image file
image_file_name	(I) Name of a file to be stored in dataset
path_name	(I) Directory path where the image_file_name located

DMI_API int DMI_store_markup_file	(	tag_t	markup,
		const char	markup_file_name[DMI_file_name_size_c+1],
		const char	path_name[DMI_path_name_size_c+1]
	)

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

Stores markup file into a markup dataset.

Parameters

markup	(I) Tag of a markup dataset
markup_file_name	(I) Name of markup file
path_name	(I) Directory path name where the markup file located

DMI_API int DMI_store_markup_file2	(	tag_t	markup,
		const char *	markup_file_name,
		const char *	path_name
	)

Parameters

markup	(I) Tag of a markup dataset
markup_file_name	(I) Name of markup file
path_name	(I) Directory path name where the markup file located

DMI_API int DMI_store_thumbnail_file	(	tag_t	image,
		const char	thumbnail_file_name[DMI_file_name_size_c+1],
		const char	path_name[DMI_path_name_size_c+1]
	)

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

Parameters

image	(I)
thumbnail_file_name	(I)
path_name	(I)

DMI_API int DMI_store_thumbnail_file2	(	tag_t	image,
		const char *	thumbnail_file_name,
		const char *	path_name
	)

Parameters

image	(I)
thumbnail_file_name	(I)
path_name	(I)

DMI_API int DMI_update_markup ( tag_t markup )

Updates the markup dataset by replacing its associated image with a newly revised image dataset.

Parameters

markup (I) Tag of a markup dataset to be updated

DMI_API int DMI_verify_image	(	tag_t	image,
		logical *	answer
	)

Verifies that a given dataset has a named reference that can be used for view/markup.

Parameters

image	(I) Tag of a dataset
answer	(O) If true, then the input dataset can be used for view/markup. If false, the input dataset cannot be used for view/markup.

Modules

Functions

Detailed Description

Function Documentation