ITK Function Reference

(V10000.1.0.60_20160308.00)
Modules | Macros | Enumerations | Functions
Product Data Interface

Modules

 Product Data Interface Tags
 

Macros

#define PDI_access_denied   EMH_API_error_base + 4
 
#define PDI_attr_has_no_value   EMH_API_error_base + 25
 
#define PDI_call_block   EMH_API_error_base + 13
 
#define PDI_cancel_export_fail   EMH_API_error_base + 18
 
#define PDI_copy_appdata_fail   EMH_API_error_base + 20
 
#define PDI_fail   EMH_API_error_base
 
#define PDI_foreign_object   EMH_API_error_base + 32
 
#define PDI_im_no_nx_view_type   PDI_tc_error_base + 1
 
#define PDI_import_files_fail   EMH_API_error_base + 17
 
#define PDI_invalid_date_format   EMH_API_error_base + 29
 
#define PDI_invalid_mapping_for_object   EMH_API_error_base + 26
 
#define PDI_invalid_pref_scope   EMH_API_error_base + 34
 
#define PDI_invalid_role   EMH_API_error_base + 14
 
#define PDI_invalid_tag   EMH_API_error_base + 3
 
#define PDI_item_already_registered   EMH_API_error_base + 38
 
#define PDI_login_failed   EMH_API_error_base + 6
 
#define PDI_modified_elsewhere   EMH_API_error_base + 27
 
#define PDI_more_than_one_objects   EMH_API_error_base + 33
 
#define PDI_no_clipboard   EMH_API_error_base + 24
 
#define PDI_no_export_directory   EMH_API_error_base + 16
 
#define PDI_not_implemented   EMH_API_error_base + 8
 
#define PDI_not_licensed   EMH_API_error_base + 28
 
#define PDI_not_locker   EMH_API_error_base + 11
 
#define PDI_not_remote   EMH_API_error_base + 36
 
#define PDI_null   EMH_API_error_base + 2
 
#define PDI_null_input_string   EMH_API_error_base + 21
 
#define PDI_object_already_added   EMH_API_error_base + 30
 
#define PDI_object_deleted   EMH_API_error_base + 23
 
#define PDI_object_exists   EMH_API_error_base + 5
 
#define PDI_object_locked   EMH_API_error_base + 10
 
#define PDI_object_not_locked   EMH_API_error_base + 12
 
#define PDI_ok   0
 
#define PDI_pdm_internal   EMH_API_error_base + 7
 
#define PDI_rdbms_error   EMH_API_error_base + 31
 
#define PDI_read_only   EMH_API_error_base + 9
 
#define PDI_remote_item_not_co   EMH_API_error_base + 35
 
#define PDI_remove_export_dir_fail   EMH_API_error_base + 19
 
#define PDI_return_code_t   int
 
#define PDI_rpc_fail   EMH_API_error_base + 1
 
#define PDI_server_disconnected   EMH_API_error_base + 37
 
#define PDI_tc_error_base   EMH_API_error_base + 1000
 
#define PDI_tcfs_error   PDI_tc_error_base + 3
 
#define PDI_unable_to_create_dir   EMH_API_error_base + 15
 
#define PDI_unused_error   EMH_API_error_base + 39
 
#define PDI_user_exit_failure   EMH_API_error_base + 22
 
#define PDI_volume_full   PDI_tc_error_base + 2
 

Enumerations

enum  PDI_LOV_usage_t { PDI_LOV_unknown, PDI_LOV_exhaustive, PDI_LOV_suggested, PDI_LOV_bounded }
 
enum  PDI_value_t {
  PDI_int_value, PDI_double_value, PDI_string_value, PDI_date_value,
  PDI_tag_value, PDI_logical_value, PDI_unknown_value, PDI_unsupported_value,
  PDI_strings_value
}
 

Functions

NXMGR_IM_API char * PDI_format_name (int format)
 

PDI equivalents

For values used when calling the unix access function

#define PDI_W_OK   2
 
#define PDI_R_OK   4
 

Class IDs

#define PDI_class_t   int
 
#define PDI_class_p_t   int*
 
#define PDI_none_class   0
 
#define PDI_part_class   1
 
#define PDI_partrev_class   2
 
#define PDI_rep_class   3
 
#define PDI_reprev_class   4
 
#define PDI_appdata_class   5
 
#define PDI_appver_class   6
 
#define PDI_container_class   7
 
#define PDI_component_class   8
 
#define PDI_attribute_class   9
 
#define PDI_apptype_class   10
 
#define PDI_reltype_class   11
 
#define PDI_parttype_class   12
 
#define PDI_attr_mapping_class   13
 
#define PDI_lov_class   14
 
#define PDI_opaque_object_class   15
 
#define PDI_unused_class   16
 
#define PDI_CLASS_COUNT   17
 

File formats in Application Data Versions

#define PDI_appver_format_t   int
 
#define PDI_appver_format_p_t   int*
 
#define PDI_none_format   0
 
#define PDI_ascii_format   1
 
#define PDI_binary_format   2
 
#define PDI_unused_format   3
 
#define PDI_APPVER_FORMAT_COUNT   4
 

Supported Machine types

#define PDI_machine_type_t   int
 
#define PDI_none_machine_type   0
 
#define PDI_unix   1
 
#define PDI_wnt   3
 
#define PDI_unused_machine_type   4
 
#define PDI_MACHINE_TYPE_COUNT   5
 

Network Transports supported by RPC

#define PDI_transport_t   int
 
#define PDI_none_transport   0
 
#define PDI_sys5_msg   1
 
#define PDI_tcpip   2
 
#define PDI_sockets   3
 
#define PDI_tc_ss   4
 
#define PDI_unused_transport   6
 
#define PDI_TRANSPORT_COUNT   7
 

Possible values for lock status

Returned by PDI_ask_appdata_lock_status()

#define PDI_lock_status_t   int
 
#define PDI_not_locked   0
 
#define PDI_locked_by_caller   1
 
#define PDI_locked_by_other   2
 
#define PDI_locked_and_exported   3
 
#define PDI_checked_out   4
 

States of part number validity

Returned from PDI_validate_part_rev_id()

#define PDI_partno_validity_t   int
 
#define PDI_partno_valid   0
 
#define PDI_partno_invalid   1
 
#define PDI_partno_modified   2
 
#define PDI_partno_override   3
 

Constants for use by the operations functions and their callers

#define PDI_operation_ok   0
 
#define PDI_operation_failed   1
 
#define PDI_nx_load_operation   "Unigraphics Part Load"
 
#define PDI_nx_load_operation_NX3   "Part Load"
 

Bitmask for PDI_forget_var_configs

#define PDI_DISPLAYED_PART_ROLE   ( 1 << 0 )
 
#define PDI_PROD_ASSY_ROLE   ( 1 << 1 )
 

Tokens for the PDI search functions

#define PDI_SEARCH_FIND_MORE   0
 
#define PDI_SEARCH_FIND_ALL   -1
 
#define PDI_SEARCH_CONTEXT_ALL   0
 
#define PDI_SEARCH_CONTEXT_INFO   1
 

Flags

Indicate which mass properties are actually specified for AppData objects

#define PDI_masspr_accuracy_defined   (1 << 0)
 
#define PDI_masspr_mass_defined   (1 << 1)
 
#define PDI_masspr_volume_defined   (1 << 2)
 
#define PDI_masspr_density_defined   (1 << 3)
 
#define PDI_masspr_area_defined   (1 << 4)
 
#define PDI_masspr_com_defined   (1 << 5)
 
#define PDI_masspr_inertia_defined   (1 << 6)
 
#define PDI_masspr_min_mass_defined   (1 << 7)
 
#define PDI_masspr_max_mass_defined   (1 << 8)
 

Indexes

For the order in which the Mass Property values are passed

#define PDI_masspr_accuracy_index   0
 
#define PDI_masspr_mass_index   1
 
#define PDI_masspr_mass_err_index   2
 
#define PDI_masspr_volume_index   3
 
#define PDI_masspr_volume_err_index   4
 
#define PDI_masspr_area_index   5
 
#define PDI_masspr_area_err_index   6
 
#define PDI_masspr_density_index   7
 
#define PDI_masspr_com_x_index   8
 
#define PDI_masspr_com_y_index   9
 
#define PDI_masspr_com_z_index   10
 
#define PDI_masspr_com_err_index   11
 
#define PDI_masspr_moi_xx_index   12
 
#define PDI_masspr_moi_yy_index   13
 
#define PDI_masspr_moi_zz_index   14
 
#define PDI_masspr_poi_xy_index   15
 
#define PDI_masspr_poi_xz_index   16
 
#define PDI_masspr_poi_yz_index   17
 
#define PDI_masspr_inertia_err_index   18
 
#define PDI_masspr_min_mass_index   19
 
#define PDI_masspr_max_mass_index   20
 
#define PDI_MASSPR_ARRAY_SIZE   21
 

Prototypes and global variables

For error handling system in PDI module interface

typedef PDI_return_code_t(* PDI_error_handler_t )(const char *function_name, const PDI_return_code_t code)
 
NXMGR_IM_API void PDI_set_error_handler (PDI_error_handler_t handler)
 
NXMGR_IM_API void PDI_allow_no_errors (void)
 
NXMGR_IM_API void PDI_allow_selected_errors (const int error_count, const PDI_return_code_t errors[])
 
NXMGR_IM_API void PDI_allow_all_errors (void)
 

Initialization routines for client and server processes

typedef void(* PDI_input_callback_proc )(void *, int *, void **)
 
typedef void *(* PDI_add_input_func_t )(void *, int, void *, PDI_input_callback_proc, void *)
 
typedef void(* PDI_remove_input_func_t )(void *)
 
NXMGR_IM_API PDI_return_code_t PDI_init_server (char *process_id, void *ctxt, PDI_transport_t transport, char *ipcdata, PDI_add_input_func_t AppAddInput, PDI_remove_input_func_t RemoveInput)
 
NXMGR_IM_API PDI_return_code_t PDI_server_shutdown (void)
 
NXMGR_IM_API PDI_return_code_t PDI_init_client (char *process_id)
 
NXMGR_IM_API void PDI_version (char **letters, int *major_number, int *minor_number)
 

Detailed Description

Has definition for Read, Write access - 'mode' parameter in PDI calls

Macro Definition Documentation

#define PDI_access_denied   EMH_API_error_base + 4

Access denied

Definition at line 70 of file pdi_external.h.

#define PDI_appdata_class   5

Definition at line 226 of file pdi_external.h.

#define PDI_apptype_class   10

Definition at line 231 of file pdi_external.h.

#define PDI_appver_class   6

Definition at line 227 of file pdi_external.h.

#define PDI_APPVER_FORMAT_COUNT   4

Definition at line 252 of file pdi_external.h.

#define PDI_appver_format_p_t   int*

Definition at line 246 of file pdi_external.h.

#define PDI_appver_format_t   int

Definition at line 245 of file pdi_external.h.

#define PDI_ascii_format   1

Definition at line 249 of file pdi_external.h.

#define PDI_attr_has_no_value   EMH_API_error_base + 25

The Teamcenter Engineering attribute has no value

Definition at line 133 of file pdi_external.h.

#define PDI_attr_mapping_class   13

Definition at line 234 of file pdi_external.h.

#define PDI_attribute_class   9

Definition at line 230 of file pdi_external.h.

#define PDI_binary_format   2

Definition at line 250 of file pdi_external.h.

#define PDI_call_block   EMH_API_error_base + 13

Delay return from this routine

Definition at line 97 of file pdi_external.h.

#define PDI_cancel_export_fail   EMH_API_error_base + 18

Deletion of the exported stuff fails

Definition at line 112 of file pdi_external.h.

#define PDI_checked_out   4

Definition at line 316 of file pdi_external.h.

#define PDI_CLASS_COUNT   17

Definition at line 238 of file pdi_external.h.

#define PDI_class_p_t   int*

Definition at line 219 of file pdi_external.h.

#define PDI_class_t   int

Definition at line 218 of file pdi_external.h.

#define PDI_component_class   8

Definition at line 229 of file pdi_external.h.

#define PDI_container_class   7

Definition at line 228 of file pdi_external.h.

#define PDI_copy_appdata_fail   EMH_API_error_base + 20

Copy files from old appdata to new one fails

Definition at line 118 of file pdi_external.h.

#define PDI_DISPLAYED_PART_ROLE   ( 1 << 0 )

Definition at line 352 of file pdi_external.h.

#define PDI_fail   EMH_API_error_base

General failure error

Definition at line 58 of file pdi_external.h.

#define PDI_foreign_object   EMH_API_error_base + 32

Definition at line 157 of file pdi_external.h.

#define PDI_im_no_nx_view_type   PDI_tc_error_base + 1

TC_NX_View_Type not present in pref file (pdi_im_rep.c)

Definition at line 206 of file pdi_external.h.

#define PDI_import_files_fail   EMH_API_error_base + 17

Import fails to bring in files

Definition at line 109 of file pdi_external.h.

#define PDI_invalid_date_format   EMH_API_error_base + 29

Definition at line 147 of file pdi_external.h.

#define PDI_invalid_mapping_for_object   EMH_API_error_base + 26

The mapping cannot be resolved for the object

Definition at line 136 of file pdi_external.h.

#define PDI_invalid_pref_scope   EMH_API_error_base + 34

Definition at line 167 of file pdi_external.h.

#define PDI_invalid_role   EMH_API_error_base + 14

Invalid role name for encap GS

Definition at line 100 of file pdi_external.h.

#define PDI_invalid_tag   EMH_API_error_base + 3

Bad tag as input

Definition at line 67 of file pdi_external.h.

#define PDI_item_already_registered   EMH_API_error_base + 38

Definition at line 188 of file pdi_external.h.

#define PDI_lock_status_t   int

Definition at line 310 of file pdi_external.h.

#define PDI_locked_and_exported   3

Definition at line 315 of file pdi_external.h.

#define PDI_locked_by_caller   1

Definition at line 313 of file pdi_external.h.

#define PDI_locked_by_other   2

Definition at line 314 of file pdi_external.h.

#define PDI_login_failed   EMH_API_error_base + 6

Problems with logging into PDM

Definition at line 76 of file pdi_external.h.

#define PDI_lov_class   14

Definition at line 235 of file pdi_external.h.

#define PDI_MACHINE_TYPE_COUNT   5

Definition at line 283 of file pdi_external.h.

#define PDI_machine_type_t   int

Definition at line 274 of file pdi_external.h.

#define PDI_masspr_accuracy_defined   (1 << 0)

An indication of how accurrately the values were calculated

Definition at line 402 of file pdi_external.h.

#define PDI_masspr_accuracy_index   0

Definition at line 438 of file pdi_external.h.

#define PDI_masspr_area_defined   (1 << 4)

The Surface Area (and corresponding error) is defined

Definition at line 414 of file pdi_external.h.

#define PDI_masspr_area_err_index   6

Definition at line 444 of file pdi_external.h.

#define PDI_masspr_area_index   5

Definition at line 443 of file pdi_external.h.

#define PDI_MASSPR_ARRAY_SIZE   21

Definition at line 460 of file pdi_external.h.

#define PDI_masspr_com_defined   (1 << 5)

The Center Of Mass vector [X,Y,Z] (and its error distance) is defined

Definition at line 417 of file pdi_external.h.

#define PDI_masspr_com_err_index   11

Definition at line 449 of file pdi_external.h.

#define PDI_masspr_com_x_index   8

Definition at line 446 of file pdi_external.h.

#define PDI_masspr_com_y_index   9

Definition at line 447 of file pdi_external.h.

#define PDI_masspr_com_z_index   10

Definition at line 448 of file pdi_external.h.

#define PDI_masspr_density_defined   (1 << 3)

The Density is defined

Definition at line 411 of file pdi_external.h.

#define PDI_masspr_density_index   7

Definition at line 445 of file pdi_external.h.

#define PDI_masspr_inertia_defined   (1 << 6)

Both the Moments Of Inertia [XX, YY, ZZ] and Products Of Inertia [XY, XZ, YZ] are defined (with its error range)

Definition at line 423 of file pdi_external.h.

#define PDI_masspr_inertia_err_index   18

Definition at line 456 of file pdi_external.h.

#define PDI_masspr_mass_defined   (1 << 1)

The Mass (and corresponding error) is defined

Definition at line 405 of file pdi_external.h.

#define PDI_masspr_mass_err_index   2

Definition at line 440 of file pdi_external.h.

#define PDI_masspr_mass_index   1

Definition at line 439 of file pdi_external.h.

#define PDI_masspr_max_mass_defined   (1 << 8)

The maximum allowable mass for this part is defined

Definition at line 429 of file pdi_external.h.

#define PDI_masspr_max_mass_index   20

Definition at line 458 of file pdi_external.h.

#define PDI_masspr_min_mass_defined   (1 << 7)

The minimum allowable mass for this part is defined

Definition at line 426 of file pdi_external.h.

#define PDI_masspr_min_mass_index   19

Definition at line 457 of file pdi_external.h.

#define PDI_masspr_moi_xx_index   12

Definition at line 450 of file pdi_external.h.

#define PDI_masspr_moi_yy_index   13

Definition at line 451 of file pdi_external.h.

#define PDI_masspr_moi_zz_index   14

Definition at line 452 of file pdi_external.h.

#define PDI_masspr_poi_xy_index   15

Definition at line 453 of file pdi_external.h.

#define PDI_masspr_poi_xz_index   16

Definition at line 454 of file pdi_external.h.

#define PDI_masspr_poi_yz_index   17

Definition at line 455 of file pdi_external.h.

#define PDI_masspr_volume_defined   (1 << 2)

The Volume (and corresponding error) is defined

Definition at line 408 of file pdi_external.h.

#define PDI_masspr_volume_err_index   4

Definition at line 442 of file pdi_external.h.

#define PDI_masspr_volume_index   3

Definition at line 441 of file pdi_external.h.

#define PDI_modified_elsewhere   EMH_API_error_base + 27

The object has been modified by some other process since we loaded it

Definition at line 139 of file pdi_external.h.

#define PDI_more_than_one_objects   EMH_API_error_base + 33

Definition at line 162 of file pdi_external.h.

#define PDI_no_clipboard   EMH_API_error_base + 24

No clipboard is available

Definition at line 130 of file pdi_external.h.

#define PDI_no_export_directory   EMH_API_error_base + 16

Export directory does not exist

Definition at line 106 of file pdi_external.h.

#define PDI_none_class   0

Definition at line 221 of file pdi_external.h.

#define PDI_none_format   0

Definition at line 248 of file pdi_external.h.

#define PDI_none_machine_type   0

Definition at line 276 of file pdi_external.h.

#define PDI_none_transport   0

Definition at line 292 of file pdi_external.h.

#define PDI_not_implemented   EMH_API_error_base + 8

Functionality not implemented

Definition at line 82 of file pdi_external.h.

#define PDI_not_licensed   EMH_API_error_base + 28

Not licensed to perform the function

Definition at line 142 of file pdi_external.h.

#define PDI_not_locked   0

Definition at line 312 of file pdi_external.h.

#define PDI_not_locker   EMH_API_error_base + 11

Caller is not object locker

Definition at line 91 of file pdi_external.h.

#define PDI_not_remote   EMH_API_error_base + 36

Definition at line 179 of file pdi_external.h.

#define PDI_null   EMH_API_error_base + 2

No objects found

Definition at line 64 of file pdi_external.h.

#define PDI_null_input_string   EMH_API_error_base + 21

Object Name cannot be set to a null value

Definition at line 121 of file pdi_external.h.

#define PDI_nx_load_operation   "Unigraphics Part Load"

Definition at line 344 of file pdi_external.h.

#define PDI_nx_load_operation_NX3   "Part Load"

Definition at line 345 of file pdi_external.h.

#define PDI_object_already_added   EMH_API_error_base + 30

The object has already been added, e.g. when inserting into a folder

Definition at line 150 of file pdi_external.h.

#define PDI_object_deleted   EMH_API_error_base + 23

Object has been deleted

Definition at line 127 of file pdi_external.h.

#define PDI_object_exists   EMH_API_error_base + 5

Trying to create an object with same id.

Definition at line 73 of file pdi_external.h.

#define PDI_object_locked   EMH_API_error_base + 10

Object is locked already

Definition at line 88 of file pdi_external.h.

#define PDI_object_not_locked   EMH_API_error_base + 12

Object is not locked

Definition at line 94 of file pdi_external.h.

#define PDI_ok   0

Definition at line 55 of file pdi_external.h.

#define PDI_opaque_object_class   15

Definition at line 236 of file pdi_external.h.

#define PDI_operation_failed   1

Definition at line 342 of file pdi_external.h.

#define PDI_operation_ok   0

Definition at line 341 of file pdi_external.h.

#define PDI_part_class   1

Definition at line 222 of file pdi_external.h.

#define PDI_partno_invalid   1

Definition at line 328 of file pdi_external.h.

#define PDI_partno_modified   2

Definition at line 329 of file pdi_external.h.

#define PDI_partno_override   3

Definition at line 334 of file pdi_external.h.

#define PDI_partno_valid   0

Definition at line 327 of file pdi_external.h.

#define PDI_partno_validity_t   int

Definition at line 325 of file pdi_external.h.

#define PDI_partrev_class   2

Definition at line 223 of file pdi_external.h.

#define PDI_parttype_class   12

Definition at line 233 of file pdi_external.h.

#define PDI_pdm_internal   EMH_API_error_base + 7

PDM internal error

Definition at line 79 of file pdi_external.h.

#define PDI_PROD_ASSY_ROLE   ( 1 << 1 )

Definition at line 353 of file pdi_external.h.

#define PDI_R_OK   4

Is it readable by caller

Definition at line 46 of file pdi_external.h.

#define PDI_rdbms_error   EMH_API_error_base + 31

Definition at line 155 of file pdi_external.h.

#define PDI_read_only   EMH_API_error_base + 9

Object may not be modified

Definition at line 85 of file pdi_external.h.

#define PDI_reltype_class   11

Definition at line 232 of file pdi_external.h.

#define PDI_remote_item_not_co   EMH_API_error_base + 35

Definition at line 173 of file pdi_external.h.

#define PDI_remove_export_dir_fail   EMH_API_error_base + 19

Deletion of the exported stuff fails

Definition at line 115 of file pdi_external.h.

#define PDI_rep_class   3

Definition at line 224 of file pdi_external.h.

#define PDI_reprev_class   4

Definition at line 225 of file pdi_external.h.

#define PDI_return_code_t   int

Definition at line 53 of file pdi_external.h.

#define PDI_rpc_fail   EMH_API_error_base + 1

General RPC error

Definition at line 61 of file pdi_external.h.

#define PDI_SEARCH_CONTEXT_ALL   0

Definition at line 363 of file pdi_external.h.

#define PDI_SEARCH_CONTEXT_INFO   1

Definition at line 364 of file pdi_external.h.

#define PDI_SEARCH_FIND_ALL   -1

Definition at line 361 of file pdi_external.h.

#define PDI_SEARCH_FIND_MORE   0

Definition at line 360 of file pdi_external.h.

#define PDI_server_disconnected   EMH_API_error_base + 37

server disconnected or time out

Definition at line 182 of file pdi_external.h.

#define PDI_sockets   3

Definition at line 295 of file pdi_external.h.

#define PDI_sys5_msg   1

Definition at line 293 of file pdi_external.h.

#define PDI_tc_error_base   EMH_API_error_base + 1000

Definition at line 203 of file pdi_external.h.

#define PDI_tc_ss   4

Definition at line 296 of file pdi_external.h.

#define PDI_tcfs_error   PDI_tc_error_base + 3

Cannot contact Tcfs

Definition at line 212 of file pdi_external.h.

#define PDI_tcpip   2

Definition at line 294 of file pdi_external.h.

#define PDI_TRANSPORT_COUNT   7

Definition at line 301 of file pdi_external.h.

#define PDI_transport_t   int

Definition at line 290 of file pdi_external.h.

#define PDI_unable_to_create_dir   EMH_API_error_base + 15

Unable to create export directory

Definition at line 103 of file pdi_external.h.

#define PDI_unix   1

Definition at line 277 of file pdi_external.h.

#define PDI_unused_class   16

Definition at line 237 of file pdi_external.h.

#define PDI_unused_error   EMH_API_error_base + 39

Last used error token

Definition at line 191 of file pdi_external.h.

#define PDI_unused_format   3

Definition at line 251 of file pdi_external.h.

#define PDI_unused_machine_type   4

Definition at line 282 of file pdi_external.h.

#define PDI_unused_transport   6

Definition at line 300 of file pdi_external.h.

#define PDI_user_exit_failure   EMH_API_error_base + 22

Failure in database user exit called from PDI

Definition at line 124 of file pdi_external.h.

#define PDI_volume_full   PDI_tc_error_base + 2

Volume is full

Definition at line 209 of file pdi_external.h.

#define PDI_W_OK   2

Is it writable by caller

Definition at line 43 of file pdi_external.h.

#define PDI_wnt   3

Definition at line 281 of file pdi_external.h.

Typedef Documentation

typedef void*(* PDI_add_input_func_t)(void *,int,void *,PDI_input_callback_proc,void *)

Definition at line 505 of file pdi_external.h.

typedef PDI_return_code_t(* PDI_error_handler_t)(const char *function_name, const PDI_return_code_t code)

Definition at line 470 of file pdi_external.h.

typedef void(* PDI_input_callback_proc)(void *,int *,void **)

Definition at line 499 of file pdi_external.h.

typedef void(* PDI_remove_input_func_t)(void *)

Definition at line 513 of file pdi_external.h.

Enumeration Type Documentation

These correspond directly to TC's LOV_usage_t.

Enumerator
PDI_LOV_unknown 
PDI_LOV_exhaustive 
PDI_LOV_suggested 
PDI_LOV_bounded 

Definition at line 370 of file pdi_external.h.

Values describing value types supported by attribute-synchronisation.

Enumerator
PDI_int_value 
PDI_double_value 
PDI_string_value 
PDI_date_value 
PDI_tag_value 
PDI_logical_value 
PDI_unknown_value 
PDI_unsupported_value 
PDI_strings_value 

Definition at line 381 of file pdi_external.h.

Function Documentation

NXMGR_IM_API void PDI_allow_all_errors ( void  )
NXMGR_IM_API void PDI_allow_no_errors ( void  )
NXMGR_IM_API void PDI_allow_selected_errors ( const int  error_count,
const PDI_return_code_t  errors[] 
)
NXMGR_IM_API char* PDI_format_name ( int  format)

Corresponding names of format. Initialized in pdi_utils.c

NXMGR_IM_API PDI_return_code_t PDI_init_client ( char *  process_id)
Parameters
process_id(I)
NXMGR_IM_API PDI_return_code_t PDI_init_server ( char *  process_id,
void *  ctxt,
PDI_transport_t  transport,
char *  ipcdata,
PDI_add_input_func_t  AppAddInput,
PDI_remove_input_func_t  RemoveInput 
)
Parameters
process_id(I)
ctxt(I)
transport(I)
ipcdata(I)
AppAddInput(I)
RemoveInput(I)
NXMGR_IM_API PDI_return_code_t PDI_server_shutdown ( void  )
NXMGR_IM_API void PDI_set_error_handler ( PDI_error_handler_t  handler)
NXMGR_IM_API void PDI_version ( char **  letters,
int *  major_number,
int *  minor_number 
)
Parameters
letters(OF)
major_number(O)
minor_number(O)