ICT UserService

---

Detailed Description

You will use the UserService mechanism to specify the functions that you want to register in Teamcenter Engineering. These functions are called dynamically by the Teamcenter Engineering Client.

Data Structures

• struct USERSERVICE_array_s

Defines

• #define USERARG_ARRAY_TYPE   100
• #define USERARG_VOID_TYPE   0
• #define USERARG_CHAR_TYPE   1
• #define USERARG_DATE_TYPE   2
• #define USERARG_DOUBLE_TYPE   3
• #define USERARG_FLOAT_TYPE   4
• #define USERARG_INT_TYPE   5
• #define USERARG_LOGICAL_TYPE   6
• #define USERARG_SHORT_TYPE   7
• #define USERARG_STRING_TYPE   8
• #define USERARG_TAG_TYPE   9

Typedefs

• typedef int(* USER_function_t )(void *)
• typedef struct USERSERVICE_array_s USERSERVICE_array_t

Functions

• DLLAPI int USERSERVICE_register_method (char *functionName, USER_function_t functionPtr, int numberOfArguments, int *argumentList, int returnValueType)
• DLLAPI int USERSERVICE_return_int_array (const int *array, int arrayLength, USERSERVICE_array_t *arrayStruct)
• DLLAPI int USERSERVICE_return_short_array (const short *array, int arrayLength, USERSERVICE_array_t *arrayStruct)
• DLLAPI int USERSERVICE_return_double_array (const double *array, int arrayLength, USERSERVICE_array_t *arrayStruct)
• DLLAPI int USERSERVICE_return_float_array (const float *array, int arrayLength, USERSERVICE_array_t *arrayStruct)
• DLLAPI int USERSERVICE_return_logical_array (const logical *array, int arrayLength, USERSERVICE_array_t *arrayStruct)
• DLLAPI int USERSERVICE_return_string_array (const char **array, int arrayLength, USERSERVICE_array_t *arrayStruct)
• DLLAPI int USERSERVICE_return_tag_array (const tag_t *array, int arrayLength, USERSERVICE_array_t *arrayStruct)
• DLLAPI int USERSERVICE_return_char_array (const char *array, int arrayLength, USERSERVICE_array_t *arrayStruct)
• DLLAPI int USERSERVICE_return_date_array (const date_t *array, int arrayLength, USERSERVICE_array_t *arrayStruct)
• DLLAPI int USERARG_get_int_argument (int *arg)
• DLLAPI int USERARG_get_int_array_argument (int *length, int **args)
• DLLAPI int USERARG_get_double_argument (double *arg)
• DLLAPI int USERARG_get_double_array_argument (int *length, double **args)
• DLLAPI int USERARG_get_string_argument (char **arg)
• DLLAPI int USERARG_get_string_array_argument (int *length, char ***args)
• DLLAPI int USERARG_get_tag_argument (tag_t *arg)
• DLLAPI int USERARG_get_tag_array_argument (int *length, tag_t **args)
• DLLAPI int USERARG_get_logical_argument (logical *arg)
• DLLAPI int USERARG_get_logical_array_argument (int *length, logical **args)
• DLLAPI int USERARG_get_float_argument (float *arg)
• DLLAPI int USERARG_get_float_array_argument (int *length, float **arg)
• DLLAPI int USERARG_get_short_argument (short *arg)
• DLLAPI int USERARG_get_short_array_argument (int *length, short **arg)
• DLLAPI int USERARG_get_char_argument (char *arg)
• DLLAPI int USERARG_get_char_array_argument (int *length, char **arg)
• DLLAPI int USERARG_get_date_argument (date_t *arg)
• DLLAPI int USERARG_get_date_array_argument (int *length, date_t **arg)
• DLLAPI void USERARG_reset_arguments ()

---

Define Documentation

#define USERARG_ARRAY_TYPE   100

Definition at line 44 of file ict_userservice.h.

#define USERARG_CHAR_TYPE   1

Definition at line 46 of file ict_userservice.h.

#define USERARG_DATE_TYPE   2

Definition at line 47 of file ict_userservice.h.

#define USERARG_DOUBLE_TYPE   3

Definition at line 48 of file ict_userservice.h.

#define USERARG_FLOAT_TYPE   4

Definition at line 49 of file ict_userservice.h.

#define USERARG_INT_TYPE   5

Definition at line 50 of file ict_userservice.h.

#define USERARG_LOGICAL_TYPE   6

Definition at line 51 of file ict_userservice.h.

#define USERARG_SHORT_TYPE   7

Definition at line 52 of file ict_userservice.h.

#define USERARG_STRING_TYPE   8

Definition at line 53 of file ict_userservice.h.

#define USERARG_TAG_TYPE   9

Definition at line 54 of file ict_userservice.h.

#define USERARG_VOID_TYPE   0

Definition at line 45 of file ict_userservice.h.

---

Typedef Documentation

typedef int(* USER_function_t)(void *)

Definition at line 56 of file ict_userservice.h.

typedef struct USERSERVICE_array_s USERSERVICE_array_t

---

Function Documentation

DLLAPI int USERARG_get_char_argument

(

char *

arg

)

Gets the character argument from the user argument stack.

Parameters:

arg	(O) Character argument from the user argument stack

DLLAPI int USERARG_get_char_array_argument	(	int *	length,
		char **	arg
	)

Gets the character array argument from the user argument stack.

Parameters:

length	(O) Size of the array
arg	(OF) length Integer argument from the user argument stack

DLLAPI int USERARG_get_date_argument

(

date_t *

arg

)

Gets the date argument from the user argument stack.

Parameters:

arg	(O) Date argument from the user argument stack

DLLAPI int USERARG_get_date_array_argument	(	int *	length,
		date_t **	arg
	)

Gets the date array argument from the user argument stack.

Parameters:

length	(O)
arg	(OF) length Date array argument from the user argument stack

DLLAPI int USERARG_get_double_argument

(

double *

arg

)

Parameters:

arg

(O)

DLLAPI int USERARG_get_double_array_argument	(	int *	length,
		double **	args
	)

Parameters:

length	(O)
args	(OF) length

DLLAPI int USERARG_get_float_argument

(

float *

arg

)

Gets the float argument from the user argument stack.

Parameters:

arg	(O) Float argument from the user argument stack

DLLAPI int USERARG_get_float_array_argument	(	int *	length,
		float **	arg
	)

Gets the float array argument from the user argument stack.

Parameters:

length	(O) Size of the array
arg	(OF) length Float array argument from the user argument stack

DLLAPI int USERARG_get_int_argument

(

int *

arg

)

Gets the integer argument from the user argument stack.

Parameters:

arg	(O) Integer argument from the user argument stack

DLLAPI int USERARG_get_int_array_argument	(	int *	length,
		int **	args
	)

Gets the integer array argument from the user argument stack.

Parameters:

length	(O) Size of the array
args	(OF) length Integer array argument from the user argument stack

DLLAPI int USERARG_get_logical_argument

(

logical *

arg

)

Gets the logical argument from the user argument stack.

Parameters:

arg	(O) Logical argument from the user argument stack

DLLAPI int USERARG_get_logical_array_argument	(	int *	length,
		logical **	args
	)

Gets the string argument from the user argument stack.

Parameters:

length	(O)
args	(OF) length Logical array argument from the user argument stack

DLLAPI int USERARG_get_short_argument

(

short *

arg

)

Gets the short argument from the user argument stack.

Parameters:

arg	(O) Short argument from the user argument stack

DLLAPI int USERARG_get_short_array_argument	(	int *	length,
		short **	arg
	)

Gets the short array argument from the user argument stack.

Parameters:

length	(O) Size of the array
arg	(OF) length Short array argument from the user argument stack

DLLAPI int USERARG_get_string_argument

(

char **

arg

)

Gets the string argument from the user argument stack.

Parameters:

arg	(OF) Integer argument from the user argument stack

DLLAPI int USERARG_get_string_array_argument	(	int *	length,
		char ***	args
	)

Gets the string array argument from the user argument stack.

Parameters:

length	(O) Size of the array
args	(OF) length String array argument from the user argument stack

DLLAPI int USERARG_get_tag_argument

(

tag_t *

arg

)

Gets the tag argument from the user argument stack.

Parameters:

arg	(O) Tag argument from the user argument stack

DLLAPI int USERARG_get_tag_array_argument	(	int *	length,
		tag_t **	args
	)

Gets the tag array argument from the user argument stack.

Parameters:

length	(O) Size of the array
args	(OF) length Tag argument from the user argument stack

DLLAPI void USERARG_reset_arguments

(

)

DLLAPI int USERSERVICE_register_method	(	char *	functionName,
		USER_function_t	functionPtr,
		int	numberOfArguments,
		int *	argumentList,
		int	returnValueType
	)

Registers user-specified function.

Parameters:

functionName	(I) Name of the user specified function
functionPtr	(I) Pointer to the user specified function
numberOfArguments	(I) Number of arguments for the user-specified function
argumentList	(I) List of input argument types for the user-specified function
returnValueType	(I) Type of the value that is returned by the user-specified function

DLLAPI int USERSERVICE_return_char_array	(	const char *	array,
		int	arrayLength,
		USERSERVICE_array_t *	arrayStruct
	)

Returns array of character values in a structure.

Parameters:

array	(I) Array of character values
arrayLength	(I) Length of the array
arrayStruct	(O) The structure into which the array values will be copied

DLLAPI int USERSERVICE_return_date_array	(	const date_t *	array,
		int	arrayLength,
		USERSERVICE_array_t *	arrayStruct
	)

Returns array of date values in a structure.

Parameters:

array	(I) Array of date values
arrayLength	(I) Length of the array
arrayStruct	(O) The structure into which the array values will be copied

DLLAPI int USERSERVICE_return_double_array	(	const double *	array,
		int	arrayLength,
		USERSERVICE_array_t *	arrayStruct
	)

Returns array of double values in a structure.

Parameters:

array	(I) Array of double values
arrayLength	(I) Length of the array
arrayStruct	(O) The structure into which the array values will be copied

DLLAPI int USERSERVICE_return_float_array	(	const float *	array,
		int	arrayLength,
		USERSERVICE_array_t *	arrayStruct
	)

Returns array of float values in a structure.

Parameters:

array	(I) Array of float values
arrayLength	(I) Length of the array
arrayStruct	(O) The structure into which the array values will be copied

DLLAPI int USERSERVICE_return_int_array	(	const int *	array,
		int	arrayLength,
		USERSERVICE_array_t *	arrayStruct
	)

Returns array of integer values in a structure.

Parameters:

array	(I) Array of integer values
arrayLength	(I) Length of the array
arrayStruct	(O) The structure into which the array values will be copied

DLLAPI int USERSERVICE_return_logical_array	(	const logical *	array,
		int	arrayLength,
		USERSERVICE_array_t *	arrayStruct
	)

Returns array of logical values in a structure.

Parameters:

array	(I) Array of logical values
arrayLength	(I) Length of the array
arrayStruct	(O) The structure into which the array values will be copied

DLLAPI int USERSERVICE_return_short_array	(	const short *	array,
		int	arrayLength,
		USERSERVICE_array_t *	arrayStruct
	)

Returns array of short values in a structure.

Parameters:

array	(I) Array of short values
arrayLength	(I) Length of the array
arrayStruct	(O) The structure into which the array values will be copied

DLLAPI int USERSERVICE_return_string_array	(	const char **	array,
		int	arrayLength,
		USERSERVICE_array_t *	arrayStruct
	)

Returns array of string values in a structure.

Parameters:

array	(I) Array of string values
arrayLength	(I) Length of the array
arrayStruct	(O) The structure into which the array values will be copied

DLLAPI int USERSERVICE_return_tag_array	(	const tag_t *	array,
		int	arrayLength,
		USERSERVICE_array_t *	arrayStruct
	)

Returns array of tag values in a structure.

Parameters:

array	(I) Array of tag values
arrayLength	(I) Length of the array
arrayStruct	(O) The structure into which the array values will be copied