SS Functions

Modules
	Signal handling routines

Typedefs
typedef void(*	SS_function_pointer_t )(void)

Functions
SS_API int	SS_generate_unique_name (char **unique_name)
SS_API int	SS_get_function_pointer (const char *library_name, const char *function_name, SS_function_ptr_t *function_pointer)
SS_API int	SS_get_function_pointer_in_library (const char *library_name, const char *function_name, SS_function_pointer_t *function_pointer)
SS_API int	SS_get_host_address (const char *host_name, char **host_ip_address)
SS_API int	SS_get_host_name (char **host_name)

Detailed Description

Teamcenter has implemented some System Specific methods.

The ITK system level functions include:

• A function to generates a unique name that can be used for directory name or a file name.
• A function to retrieve the address of a function in a library.
• A function to retrieve the name of the Teamcenter server host.
• A function to retrieve the IP address of the Teamcenter server host.
• A function that delays the Teamcenter server process for the specified number of seconds.

Typedef Documentation

typedef void(* SS_function_pointer_t)(void)

Defines a generic type of function pointer. It will need to be cast to the proper signature before usage.

Definition at line 51 of file ss_functions.h.

Function Documentation

SS_API int SS_generate_unique_name

(

char **

unique_name

)

Generates a unique name that can be used for directory name or a file name.

Returns

ITK_ok always

Parameters

unique_name

(OF) The generated unique name

SS_API int SS_get_function_pointer	(	const char *	library_name,
		const char *	function_name,
		SS_function_ptr_t *	function_pointer
	)

Retrieves the address of a function in a library.

Note

The library name can be with or without the platform specific extension.
If no extension is provided, the function adds the proper platform specific extension.

Returns

• ITK_ok always
• SS_NOOPEN if the full path to the library is specified
• SS_NOGETADDR if the function is not found in the specified library

Deprecated:

This is deprecated in Tc9.1.3.5 and removed from Tc11.2.
Please use SS_get_function_pointer_in_library instead.

Parameters

library_name	(I) Shared library name (with or without platform extension)
function_name	(I) Function name
function_pointer	(O) Function pointer

SS_API int SS_get_function_pointer_in_library	(	const char *	library_name,
		const char *	function_name,
		SS_function_pointer_t *	function_pointer
	)

Retrieves the address of a function in a library.

Note

No extension is to be provided for the library name.

SS_function_pointer_t function_pointer;
int ifail = SS_get_function_pointer_in_library( "libtextsrv", "TXTSRV_get_supported_languages_list", &function_pointer );
if( ITK_ok == ifail )
{
    int nbLanguages = 0;
    char** languageCodeList = 0;
    char** languageNameList = 0;
    / /  Now casting the function pointer to match the signature of the TXTSRV_get_supported_languages_list API
    ifail = ((int (*)(int*, char***, char***))function_pointer)(&nbLanguages, &languageCodeList, &languageNameList);
    [...]
}

Returns

• ITK_ok on success
• SS_shlib_no_such_file if the library library_name cannot be found
• SS_shlib_invalid_library if the library library_name cannot be loaded
• SS_shlib_operation_failed if the function function_name cannot be found in the library library_name
• Possibly other errors

Parameters

library_name	(I) Shared library name (without any platform extension)
function_name	(I) Function name
function_pointer	(O) Function address

SS_API int SS_get_host_address	(	const char *	host_name,
		char **	host_ip_address
	)

Retrieves the IP address of the Teamcenter server host.

Note

The function only returns IPv4 addresses for the moment.

Returns

• ITK_ok on success
• SS_NOHOSTADDR if the host address cannot be determined

Parameters

host_name	(I) The name of the server host
host_ip_address	(OF) The IP address of the machine

SS_API int SS_get_host_name

(

char **

host_name

)

Retrieves the name of the Teamcenter server host.

Returns

• ITK_ok on success
• SS_NOHOST if the host name cannot be determined

Parameters

host_name

(OF) The host name