Programming Guide

About This Document

• Documentation Website
• How to Print the Document
• Documentation Conventions
• Contact Us!

1. JPL Command Overview

• Control Flow
• Procedure Structure
• Variable Declaration
• Command/Function Execution
• Module Access and Availability
• Text Display
• Data/Message Transfer
• Database Drivers
• JetNet/Oracle Tuxedo Processing
• Connection
• Data/Message Transfer
• Service Request Processing
• Event Broker Processing
• Two-Phase Commit Transaction Processing
• Component Processing (COM, EJB)

2. JPL Command Reference

• advertise
• break
• broadcast
• call
• client_exit
• client_init
• dbms
• dequeue
• enqueue
• flush
• for
• global
• if
• include
• jif_check
• jif_read
• log
• msg
• next
• notify
• parms
• post
• proc
• public
• raise_exception
• receive
• receive_args
• return
• return_args
• runreport
• send
• service_call
• service_cancel
• service_forward
• service_return
• subscribe
• switch
• unadvertise
• unload
• unload_data
• unsubscribe
• vars
• wait
• while
• xa_begin
• xa_commit
• xa_end
• xa_rollback

3. Built-in Control Functions

• jm_exit
• jm_gotop
• jm_goform
• jm_keys
• jm_system
• jm_winsize

4. Library Function Overview

• Initialization/Reset
• Screen and Viewport Control
• Interscreen Messaging
• Widget Creation/Deletion
• Property Access
• Field/Array Data Access
• Group Access
• Local Data Block Access
• Validation
• Cursor Control
• Display Terminal I/O
• Message Display
• Mass Storage and Retrieval
• Global Data and Changing Panther Behavior
• Menus
• Database Interaction
• Transaction Manager
• GUI Access
• DDE (Dynamic Data Exchange)
• File Access
• Library Access
• JPL
• JetNet/Oracle Tuxedo Processing
• Open Middleware Connectivity
• COM/MTS Processing
• Reports
• Web Applications
• Mail
• XML
• Miscellaneous

5. Library Functions

• dm_bin_create_occur
• dm_bin_delete_occur
• dm_bin_get_dlength
• dm_bin_get_occur
• dm_bin_length
• dm_bin_max_occur
• dm_bin_set_dlength
• dm_convert_empty
• dm_cursor_connection
• dm_cursor_consistent
• dm_cursor_engine
• dm_dbi_init
• dm_dbms
• dm_dbms_noexp
• dm_disable_styles
• dm_enable_styles
• dm_exec_sql
• dm_expand
• dm_free_sql_info
• dm_gen_change_execute_using
• dm_gen_change_select_from
• dm_gen_change_select_group_by
• dm_gen_change_select_having
• dm_gen_change_select_list
• dm_gen_change_select_order_by
• dm_gen_change_select_suffix
• dm_gen_change_select_where
• dm_gen_get_tv_alias
• dm_gen_sql_info
• dm_get_db_conn_handle
• dm_get_db_cursor_handle
• dm_get_driver_option
• dm_getdbitext
• dm_init
• dm_is_connection
• dm_is_cursor
• dm_is_engine
• dm_odb_preserves_cursor
• dm_reset
• dm_set_driver_option
• dm_set_max_fetches
• dm_set_max_rows_per_fetch
• dm_set_tm_clear_fast
• dm_val_relative
• sm_adjust_area
• sm_allget
• sm_*amt_format
• sm_append_bundle_data
• sm_append_bundle_done
• sm_append_bundle_item
• sm_*at_cur
• sm_*attach_drawing_func
• sm_backtab
• sm_bel
• sm_bi_compare
• sm_bi_copy
• sm_bi_initialize
• sm_bkrect
• sm_c_off
• sm_c_on
• sm_c_vis
• sm_calc
• sm_cancel
• sm_ckdigit
• sm_cl_all_mdts
• sm_cl_unprot
• sm_*clear_array
• sm_close_window
• sm_com_load_picture
• sm_com_QueryInterface
• sm_com_result
• sm_com_result_msg
• sm_com_set_handler
• sm_*copyarray
• sm_create_bundle
• sm_d_msg_line
• sm_*dblval
• sm_dd_able
• sm_dde_client_connect_cold
• sm_dde_client_connect_hot
• sm_dde_client_connect_warm
• sm_dde_client_disconnect
• sm_dde_client_off
• sm_dde_client_on
• sm_dde_client_paste_link_cold
• sm_dde_client_paste_link_hot
• sm_dde_client_paste_link_warm
• sm_dde_client_request
• sm_dde_execute
• sm_dde_install_notify
• sm_dde_poke
• sm_dde_server_off
• sm_dde_server_on
• sm_delay_cursor
• sm_deselect
• sm_dicname
• sm_disp_off
• sm_*dlength
• sm_do_uinstalls
• sm_*doccur
• sm_*drawingarea
• sm_*dtofield
• sm_femsg
• sm_ferr_reset
• sm_fi_path
• sm_file_copy
• sm_file_exists
• sm_file_move
• sm_file_remove
• sm_filebox
• sm_filetypes
• sm_fio_a2f
• sm_fio_close
• sm_fio_editor
• sm_fio_error
• sm_fio_error_set
• sm_fio_f2a
• sm_fio_getc
• sm_fio_gets
• sm_fio_handle
• sm_fio_open
• sm_fio_putc
• sm_fio_puts
• sm_fio_rewind
• sm_flush
• sm_*form
• sm_formlist
• sm_*fptr
• sm_fqui_msg
• sm_fquiet_err
• sm_free_bundle
• sm_*ftog
• sm_*fval
• sm_*get_bi_data
• sm_get_bundle_data
• sm_get_bundle_item_count
• sm_get_bundle_occur_count
• sm_get_next_bundle_name
• sm_*get_tv_bi_data
• sm_getenv
• sm_*getfield
• sm_getkey
• sm_*gofield
• sm_*gtof
• sm_n_gval
• sm_hlp_by_name
• sm_home
• sm_inimsg
• sm_*initcrt
• sm_input
• sm_inquire
• sm_install
• sm_*intval
• sm_*ioccur
• sm_is_bundle
• sm_*is_no
• sm_*is_yes
• sm_isabort
• sm_iset
• sm_issv
• sm_*itofield
• sm_jclose
• sm_jfilebox
• sm_jform
• sm_*jplcall
• sm_jplpublic
• sm_jplunload
• sm_jtop
• sm_jwindow
• sm_key_integer
• sm_keyfilter
• sm_keyhit
• sm_keyinit
• sm_keylabel
• sm_keyoption
• sm_l_close
• sm_l_open
• sm_l_open_syslib
• sm_last
• sm_launch
• sm_*ldb_fld_*get
• sm_*ldb_fld_*store
• sm_ldb_get_active
• sm_ldb_get_inactive
• sm_ldb_get_next_active
• sm_ldb_get_next_inactive
• sm_*ldb_*getfield
• sm_ldb_handle
• sm_ldb_init
• sm_ldb_is_loaded
• sm_ldb_load
• sm_ldb_name
• sm_ldb_next_handle
• sm_ldb_pop
• sm_ldb_push
• sm_*ldb_*putfield
• sm_ldb_*state_get
• sm_ldb_*state_set
• sm_ldb_*unload
• sm_leave
• sm_list_objects_count
• sm_list_objects_end
• sm_list_objects_next
• sm_list_objects_start
• sm_*lngval
• sm_load_screen
• sm_log
• sm_lstore
• sm_ltofield
• sm_m_flush
• sm_*mail_attach
• sm_*mail_file_text
• sm_mail_message
• sm_mail_new
• sm_*mail_send
• sm_*mail_text
• sm_*mail_widget
• sm_menu_bar_error
• sm_menu_change
• sm_menu_create
• sm_menu_delete
• sm_menu_get*
• sm_menu_install
• sm_menu_remove
• sm_message_box
• sm_mncrinit6
• sm_*mnitem_change
• sm_*mnitem_create
• sm_*mnitem_delete
• sm_*mnitem_get
• sm_mnscript_load
• sm_mnscript_unload
• sm_ms_inquire
• sm_msg
• sm_msg_del
• sm_msg_get
• sm_*msg_read
• sm_msg_set
• sm_msgfind
• sm_mts_CreateInstance
• sm_mts_CreateProperty
• sm_mts_CreatePropertyGroup
• sm_mts_DisableCommit
• sm_mts_EnableCommit
• sm_mts_GetPropertyValue
• sm_mts_IsCallerInRole
• sm_mts_IsInTransaction
• sm_mts_IsSecurityEnabled
• sm_mts_PutPropertyValue
• sm_mts_SetAbort
• sm_mts_SetComplete
• sm_mus_time
• sm_mw_DismissIntroPixmap
• sm_mw_get_client_wnd
• sm_mw_get_cmd_show
• sm_mw_get_frame_wnd
• sm_mw_get_instance
• sm_mw_get_prev_instance
• sm_mw_install_msg_callback
• sm_mw_PrintScreen
• sm_next_sync
• sm_nl
• sm_*null
• sm_obj_call
• sm_obj_copy*
• sm_obj_create
• sm_obj_create_licensed
• sm_obj_create_server
• sm_obj_delete*
• sm_obj_get_property
• sm_obj_onerror
• sm_obj_set_property
• sm_obj_sort
• sm_obj_sort_auto
• sm_occur_no
• sm_*off_gofield
• sm_option
• sm_optmnu_id
• sm_*PiMwCopyToClipboard
• sm_*PiMwPasteFromClipboard
• sm_pinquire
• sm_popup_at_cur
• sm_prop_error
• sm_prop_get*
• sm_prop_id
• sm_prop_name_to_id
• sm_prop_set*
• sm_pset
• sm_*putfield
• sm_raise_exception
• sm_receive
• sm_receive_args
• sm_rescreen
• sm_*resetcrt
• sm_resize
• sm_restore_data
• sm_return
• sm_return_args
• sm_rmformlist
• sm_rs_data
• sm_rw_error_message
• sm_rw_play_metafile
• sm_rw_runreport
• sm_s_val
• sm_save_data
• sm_sb_delete
• sm_sb_format
• sm_sb_gettext
• sm_sb_insert
• sm_sb_settext
• sm_sdtime
• sm_select
• sm_send
• sm_set_help
• sm_setbkstat
• sm_setsibling
• sm_setstatus
• sm_sh_off
• sm_shell
• sm_shrink_to_fit
• sm_slib_error
• sm_slib_install
• sm_slib_load
• sm_soption
• sm_*strip_amt_ptr
• sm_sv_data
• sm_sv_free
• sm_svscreen
• sm_tab
• sm_tm_clear
• sm_tm_clear_model_events
• sm_tm_command
• sm_tm_command_emsgset
• sm_tm_command_errset
• sm_tm_continuation_validity
• sm_tm_dbi_checker
• sm_tm_error
• sm_tm_errorlog
• sm_tm_event
• sm_tm_event_name
• sm_tm_failure_message
• sm_tm_handling
• sm_tm_inquire
• sm_tm_iset
• sm_tm_msg_count_error
• sm_tm_msg_emsg
• sm_tm_msg_error
• sm_tm_old_bi_context
• sm_tm_pcopy
• sm_tm_pinquire
• sm_tm_pop_model_event
• sm_tm_pset
• sm_tm_push_model_event
• sm_tmpnam
• sm_tp_exec
• sm_tp_free_arg_buf
• sm_tp_gen_insert
• sm_tp_gen_sel_return
• sm_tp_gen_sel_where
• sm_tp_gen_val_link
• sm_tp_gen_val_return
• sm_tp_get_svc_alias
• sm_tp_get_tux_callid
• sm_trace
• sm_translatecoords
• sm_tst_all_mdts
• sm_udtime
• sm_ungetkey
• sm_unload_screen
• sm_unsvscreen
• sm_upd_select
• sm_*validate
• sm_*vinit
• sm_wcount
• sm_wdeselect
• sm_web_get_cookie
• sm_web_invoke_url
• sm_web_log_error
• sm_web_save_global
• sm_web_set_cookie
• sm_web_unsave_all_globals
• sm_web_unsave_global
• sm_*widget
• sm_win_shrink
• sm_*window
• sm_winsize
• sm_wrotate
• sm_*wselect
• sm_*ww_length
• sm_*ww_read
• sm_*ww_write
• sm_xlate_table
• sm_xm_get_base_window
• sm_xm_get_display
• sm_*xml_export
• sm_*xml_export_file
• sm_*xml_import
• sm_*xml_import_file

6. Java Library Function Interfaces

• CFunctionsInterface
• ComFunctionsInterface
• DMFunctionsInterface
• RWFunctionsInterface
• TMFunctionsInterface
• TPFunctionsInterface
• WSFunctionsInterface

7. Java Object Interfaces

• ApplicationInterface
• FieldInterface
• GridInterface
• GroupInterface
• ScreenInterface
• WidgetInterface

8. Transaction Manager Commands

• sm_tm_command
• CHANGE
• CLEAR
• CLOSE
• CONTINUE
• CONTINUE_BOTTOM
• CONTINUE_DOWN
• CONTINUE_TOP
• CONTINUE_UP
• COPY
• COPY_FOR_UPDATE
• COPY_FOR_VIEW
• FETCH
• FINISH
• FORCE_CLOSE
• NEW
• REFRESH
• RELEASE
• SAVE
• SELECT
• START
• VIEW
• WALK_DELETE
• WALK_INSERT
• WALK_SELECT
• WALK_UPDATE

9. Transaction Model Events

• Common Transaction Model
• Reading the Event Table
• Error and Diagnostic Events
• Database-Specific Transaction Models
• INITIAL Mode Handling
• BEGIN Command Processing
• Special Processing

10. Transaction Manager Error Messages

• Transaction Manager Errors

11. DBMS Statements and Commands

• DBMS Command Summary
• ALIAS
• BINARY
• CATQUERY
• CLOSE_ALL_CONNECTIONS
• CLOSE CONNECTION
• CLOSE CURSOR
• COLUMN_NAMES
• CONNECTION
• CONTINUE
• CONTINUE_BOTTOM
• CONTINUE_DOWN
• CONTINUE_TOP
• CONTINUE_UP
• DECLARE CONNECTION
• DECLARE CURSOR
• ENGINE
• EXECUTE
• FORMAT
• OCCUR
• ONENTRY
• ONERROR
• ONEXIT
• QUERY
• RUN
• SQL
• START
• STORE
• UNIQUE
• WITH CONNECTION
• WITH CURSOR
• WITH ENGINE

12. DBMS Global Variables

• Variable Overview
• @dmengerrcode
• @dmengerrmsg
• @dmengreturn
• @dmengsqlstate
• @dmengwarncode
• @dmengwarnmsg
• @dmretcode
• @dmretmsg
• @dmrowcount
• @dmserial
• @dmwarnsqlstate

13. Keywords in Database Drivers

14. ActiveX Controls

• PrlSpinner

Index