Teamcenter Utility

Typedefs
typedef enum URLFormat_e	urlFormat_t

Enumerations
enum	URLFormat_e {   PORTAL, DHTML, HTML, AWC,   SHF }

Functions
TC_API logical	isAPIServer (void)
TC_API logical	isNXManager (void)
TC_API void	SM_report_logging (FILE *stream)
TC_API void	SM_start_logging (void)
TC_API int	TC_alloc_fixed_array (int count, int element_size, char ***new_memory)
TC_API void	TC_free_strings (char **array)
TC_API const char *	TC_getenv (const char *value)
TC_API logical	TC_isTIEImport (void)
TC_API char **	TC_pack_strings (int nstrings, char **strings, char ***packed_strings)
TC_API char **	TC_pack_strings_transient (int nstrings, char **strings, char ***packed_strings)
TC_API void	TC_print_dll_versions (FILE *stream)
TC_API void	TC_print_env_vars (FILE *stream, const char *filter, const char *prefix)
TC_API void	TC_print_what_tcupdate (FILE *stream)
TC_API int	TC_tag_to_url (tag_t tag, urlFormat_t urlType, char **url)
TC_API char *	TCWEB_tag_to_url (tag_t tag)

Detailed Description

Typedef Documentation

typedef enum URLFormat_e urlFormat_t

Defines different types of Teamcenter URLs depending on the client types.

Note

The input value HTML is for legacy web client and is obsolete

Enumeration Type Documentation

enum URLFormat_e

Defines different types of Teamcenter URLs depending on the client types.

Note

The input value HTML is for legacy web client and is obsolete

Enumerator
PORTAL	Teamcenter Rich Client URL.
DHTML	Teamcenter Thin Client(DHTML) URL.
HTML	Teamcenter Thin Client(HTML) URL. This Client Does Not Exist Anymore.
AWC	Teamcenter Active Workspace URL.
SHF	Teamcenter SoftLine, HardLines and Footwear Web Client URL.

Definition at line 36 of file tc_util.h.

Function Documentation

TC_API logical isAPIServer

(

void

)

TC_API logical isNXManager

(

void

)

TC_API void SM_report_logging

(

FILE *

stream

)

TC_API void SM_start_logging

(

void

)

Starts recording MEM_alloc()ators, prints a report

TC_API int TC_alloc_fixed_array	(	int	count,
		int	element_size,
		char ***	new_memory
	)

TC_API void TC_free_strings

(

char **

array

)

Given an array of MEM_alloc()ed strings, calls MEM_free on each element and then MEM_free on the array itself. This is useful for freeing unpacked string arrays. (Use MEM_free on packed strings.) This is null-pointer-proof, just as all good freeing functions should be.

TC_API const char* TC_getenv

(

const char *

value

)

Cover for SS_getenv, returns a static (hence never null)

TC_API logical TC_isTIEImport

(

void

)

Implemented in iman_util.cxx

Returns true if TIE importer is running

TC_API char** TC_pack_strings	(	int	nstrings,
		char **	strings,
		char ***	packed_strings
	)

TC_API char** TC_pack_strings_transient	(	int	nstrings,
		char **	strings,
		char ***	packed_strings
	)

TC_API void TC_print_dll_versions

(

FILE *

stream

)

On Windows: logs DLL versions

TC_API void TC_print_env_vars	(	FILE *	stream,
		const char *	filter,
		const char *	prefix
	)

Prints to "stream" all the environment variables that satisfy the given filtering, prefixed by "prefix" (or by nothing if "prefix" is null so you can e.g. supply an indent). The filtering is done by printing just those variables that include "filter" as a substring. If "filter" starts with a "^", then the variable must 'start' with the substring. If "filter" is null, all variables are printed. So a typical use might be TC_print_env_vars( ERROR_system_log, "^TC", NULL );

TC_API void TC_print_what_tcupdate

(

FILE *

stream

)

Essentially prints a "what $TC_LIBRARY/libtcupdate" to stream

TC_API int TC_tag_to_url	(	tag_t	tag,
		urlFormat_t	urlType,
		char **	url
	)

Generates a URL to the targeted object for a specified application type.

Note

The URL type HTML is deprecated starting Tc10.1. Calling this ITK with this parameter will provide default URL.

This ITK returns:

• ITK_ok on success.
• ITK_Web_server_not_defined if the preference "WEB_default_site_server" is not set.

Parameters

tag	(I) Tag of the object
urlType	(I) Type of needed URL: AWC, SHF, PORTAL,DHTML or HTML
url	(OF) URL to the targeted object

TC_API char* TCWEB_tag_to_url

(

tag_t

tag

)

Implemented in urlserver.cxx

Returns 0 on failure (no URL for tag, or error), ptr to string on success (MEM_free to dispose)