Teamcenter Arguments
[Integration Tool Kit]

Data Structures

struct TC_argument_s
struct TC_argument_list_s

Defines

#define TC_number_of_arguments(a) ((a == 0) ? 0 : a->number_of_arguments)
#define TC_init_argument_list(a) { if(a != 0) a->i = 0; }
#define TC_next_argument(a) ((a == 0) ? 0 : ((a->i < a->number_of_arguments) ? (a->arguments[a->i++].val_union.str_value) : 0))
#define TC_next_int_argument(a) ((a == 0) ? 0 : ((a->i < a->number_of_arguments) ? (a->arguments[a->i++].val_union.int_value) : 0))

Typedefs

typedef enum TC_module_state_e TC_module_state_t
typedef struct TC_argument_s TC_argument_t
typedef struct TC_argument_list_s TC_argument_list_t

Enumerations

enum TC_module_state_e { TC_uninitialized, TC_initializing, TC_initialized }

Define Documentation

#define TC_init_argument_list ( a ) { if(a != 0) a->i = 0; }

Initializes cursor position of a pointer to TC_argument_list_t.
This has to be used to ensure proper functioning of TC_next_argument and TC_next_int_argument.

Parameters:

a

(I) TC_argument_list_t*

Definition at line 155 of file tc_arguments.h.

#define TC_next_argument ( a ) ((a == 0) ? 0 : ((a->i < a->number_of_arguments) ? (a->arguments[a->i++].val_union.str_value) : 0))

Returns the current argument from the list of Teamcenter arguments, assuming that it is a string.
If there is no more argument in the list, it returns 0.

Subsequently, the position cursor is increased by one.

Parameters:

a

(I) TC_argument_list_t*

Definition at line 165 of file tc_arguments.h.

#define TC_next_int_argument ( a ) ((a == 0) ? 0 : ((a->i < a->number_of_arguments) ? (a->arguments[a->i++].val_union.int_value) : 0))

Returns the current argument from the list of Teamcenter arguments, assuming that it is an integer.
If there is no more argument in the list, it returns 0.

Subsequently, the position cursor is increased by one.

Parameters:

a

(I) TC_argument_list_t*

Definition at line 176 of file tc_arguments.h.

#define TC_number_of_arguments ( a ) ((a == 0) ? 0 : a->number_of_arguments)

Returns the total number of Teamcenter arguments contained in a pointer to TC_argument_list_t.

Parameters:

a

(I) TC_argument_list_t*

Definition at line 147 of file tc_arguments.h.