A script-enabled browser is required for this page to function properly.

Block object macros

This section describes the macros of the Oracle Forms Open API Block object.

d2fblkg_back_color( ctx, obj, val );

This macro returns the value of the Background Color property of the block as type text.

d2fblkg_blk_description( ctx, obj, val );

This macro returns the value of the Data Block Description property of the block as type text.

d2fblkg_client_info( ctx, obj, val );

This macro returns the value of the D2FP_CLIENT_INFO property of the block as a type dvoid pointer.

d2fblkg_comment( ctx, obj, val );

This macro returns the value of the Comments property of the block as type text.

d2fblkg_db_blk( ctx, obj, val );

This macro returns the value of the Database Block property of the block as type boolean.

d2fblkg_del_allowed( ctx, obj, val );

This macro returns the value of the Delete Allowed property of the block as type boolean.

d2fblkg_del_dat_src_arg( ctx, obj, val );

This macro returns the value of the Delete Data Source Argument property of the block as type object.

d2fblkg_del_dat_src_col( ctx, obj, val );

This macro returns the value of the Delete Data Source Column property of the block as type object.

d2fblkg_del_proc_nam( ctx, obj, val );

This macro returns the value of the Delete Procedure Name property of the block as type text.

d2fblkg_dml_ary_siz( ctx, obj, val );

This macro returns the value of the DML Array Size property of the block as type number.

d2fblkg_dml_dat_nam( ctx, obj, val );

This macro returns the value of the DML Data Target Name property of the block as type text.

d2fblkg_dml_dat_typ( ctx, obj, val );

This macro returns the value of the DML Data Target Type property of the block as type number.

d2fblkg_enfrc_col_security( ctx, obj, val );

This macro returns the value of the Enforce Column Security property of the block as type boolean.

d2fblkg_enfrc_prmry_key( ctx, obj, val );

This macro returns the value of the Enforce Primary Key property of the block as type boolean.

d2fblkg_fill_pat( ctx, obj, val );

This macro returns the value of the Fill Pattern property of the block as type text.

d2fblkg_font_nam( ctx, obj, val );

This macro returns the value of the Font Name property of the block as type text.

d2fblkg_font_siz( ctx, obj, val );

This macro returns the value of the Font Size property of the block as type number.

d2fblkg_font_spcing( ctx, obj, val );

This macro returns the value of the Font Spacing property of the block as type number.

d2fblkg_font_sty( ctx, obj, val );

This macro returns the value of the Font Style property of the block as type number.

d2fblkg_font_wght( ctx, obj, val );

This macro returns the value of the Font Weight property of the block as type number.

d2fblkg_fore_color( ctx, obj, val );

This macro returns the value of the Foreground Color property of the block as type text.

d2fblkg_ins_dat_src_arg( ctx, obj, val );

This macro returns the value of the D2FP_INS_DAT_SRC_ARG property of the block as type object.

d2fblkg_ins_dat_src_col( ctx, obj, val );

This macro returns the value of the D2FP_INS_DAT_SRC_COL property of the block as type object.

d2fblkg_insrt_allowed( ctx, obj, val );

This macro returns the value of the Insert Allowed property of the block as type boolean.

d2fblkg_insrt_proc_nam( ctx, obj, val );

This macro returns the value of the Insert Procedure Name property of the block as type text.

d2fblkg_item( ctx, obj, val );

This macro returns the value of the D2FP_ITEM property of the block as type object.

d2fblkg_key_mode( ctx, obj, val );

This macro returns the value of the Key Mode property of the block as type number.

d2fblkg_lang_dir( ctx, obj, val );

This macro returns the value of the Language Direction property of the block as type number.

d2fblkg_lock_dat_src( ctx, obj, val );

This macro returns the value of the Lock Data Source property of the block as type object.

d2fblkg_lock_dat_src_col( ctx, obj, val );

This macro returns the value of the Lock Data Source Column property of the block as type object.

d2fblkg_lock_mode( ctx, obj, val );

This macro returns the value of the Locking Mode property of the block as type number.

d2fblkg_lock_proc_nam( ctx, obj, val );

This macro returns the value of the Lock Procedure Name property of the block as type text.

d2fblkg_lst_in_blk_mnu( ctx, obj, val );

This macro returns the value of the Listed In Block Menu property of the block as type boolean.

d2fblkg_max_qry_time( ctx, obj, val );

This macro returns the value of the Maximum Query Time property of the block as type number.

d2fblkg_max_recs_fetched( ctx, obj, val );

This macro returns the value of the D2FP_MAX_RECORDS_FETCHED property of the block as type number.

d2fblkg_module( ctx, obj, val );

This macro returns the value of the D2FP_MODULE property of the block as type object.

d2fblkg_name( ctx, obj, val );

This macro returns the value of the Name property of the block as type text.

d2fblkg_navigation_sty( ctx, obj, val );

This macro returns the value of the Navigation Style property of the block as type number.

d2fblkg_next( ctx, obj, val );

This macro returns the value of the D2FP_NEXT property of the block as type object.

d2fblkg_nxt_navigation_blk_nam( ctx, obj, val );

This macro returns the value of the D2FP_NXT_NAVIGATION_BLK_OBJ property of the block as type text.

d2fblkg_nxt_navigation_blk_obj( ctx, obj, val );

This macro returns the value of the Next Navigation Block property of the block as type object.

d2fblkg_opt_hint( ctx, obj, val );

This macro returns the value of the Optimizer Hint property of the block as type text.

d2fblkg_ordr_by_clause( ctx, obj, val );

This macro returns the value of the ORDER BY Clause property of the block as type text.

d2fblkg_owner( ctx, obj, val );

This macro returns the value of the D2FP_OWNER property of the block as type object.

d2fblkg_par_flnam( ctx, obj, val );

This macro returns the value of the D2FP_PAR_FLNAM property of the block as type text.

d2fblkg_par_flpath( ctx, obj, val );

This macro returns the value of the D2FP_PAR_FLPATH property of the block as type text.

d2fblkg_par_modstr( ctx, obj, val );

This macro returns the value of the D2FP_PAR_MODSTR property of the block as type number.

d2fblkg_par_modtyp( ctx, obj, val );

This macro returns the value of the D2FP_MODTYPE property of the block as type number.

d2fblkg_par_module( ctx, obj, val );

This macro returns the value of the D2FP_PAR_MODULE property of the block as type text.

d2fblkg_par_nam( ctx, obj, val );

This macro returns the value of the D2FP_PAR_NAME property of the block as type text.

d2fblkg_precomp_summ( ctx, obj, val );

This macro returns the value of the D2FP_PRECOMP_SUMMNO property of the block as type boolean.

d2fblkg_prev_navigation_blk_nam( ctx, obj, val );

This macro returns the value of the Previous Navigation Block property of the block as type text.

d2fblkg_prev_navigation_blk_obj( ctx, obj, val );

This macro returns the value of the D2FP_PREV_NAVIGATION_BLK_OBJ property of the block as type object.

d2fblkg_previous( ctx, obj, val );

This macro returns the value of the D2FP_PREVIOUS property of the block as type object.

d2fblkg_qry_all_recs( ctx, obj, val );

This macro returns the value of the Query All Record property of the block as type boolean.

d2fblkg_qry_allowed( ctx, obj, val );

This macro returns the value of the Query Allowed property of the block as type boolean.

d2fblkg_qry_dat_src_arg( ctx, obj, val );

This macro returns the value of the Query Data Source Name property of the block as type object.

d2fblkg_qry_dat_src_col( ctx, obj, val );

This macro returns the value of the Query Data Source Column property of the block as type object.

d2fblkg_qry_dat_src_nam( ctx, obj, val );

This macro returns the value of the Query Data Source Name property of the block as type text.

d2fblkg_qry_dat_src_typ( ctx, obj, val );

This macro returns the value of the Query Data Source Type property of the block as type number.

d2fblkg_rec_ornt( ctx, obj, val );

This macro returns the value of the Record Orientation property of the block as type number.

d2fblkg_rec_vat_grp_nam( ctx, obj, val );

This macro returns the value of the Current Record Visual Attribute Group property of the block as type text.

d2fblkg_rec_vat_grp_obj( ctx, obj, val );

This macro returns the value of the D2FP_REC_VAT_GRP_OBJ property of the block as type object.

d2fblkg_recs_buffered_count( ctx, obj, val );

This macro returns the value of the Number of Records Buffered property of the block as type number.

d2fblkg_recs_disp_count( ctx, obj, val );

This macro returns the value of the Number of Records Displayed property of the block as type number.

d2fblkg_recs_fetched_count( ctx, obj, val );

This macro returns the value of the D2FP_RECS_FETCHED_COUNT property of the block as type number.

d2fblkg_rel( ctx, obj, val );

This macro returns the value of the D2FP_REL property of the block as type object.

d2fblkg_rev_dir( ctx, obj, val );

This macro calls returns the value of the Reverse Direction property of the block as type boolean.

d2fblkg_scrlbr_cnv_nam( ctx, obj, val );

This macro returns the value of the Scroll Bar Canvas property of the block as type text.

d2fblkg_scrlbr_cnv_obj( ctx, obj, val );

This macro returns the value of the D2FP_SCRLBR_CNV_OBJ property of the block as type object.

d2fblkg_scrlbr_hgt( ctx, obj, val );

This macro returns the value of the Scroll Bar Height property of the block as type number.

d2fblkg_srclbr_ornt( ctx, obj, val );

This macro returns the value of the Scroll Bar Orientation property of the block as type number.

d2fblkg_scrlbr_tbp_nam( ctx, obj, val );

This macro returns the value of the Scroll Bar Tab Page property of the block as type text.

d2fblkg_scrlbr_tbp_obj( ctx, obj, val );

This macro returns the value of the D2FP_SCRLBR_TSP_OBJ property of the block as type object.

d2fblkg_scrlbr_wid( ctx, obj, val );

This macro returns the value of the Scroll Bar Width property of the block as type number.

d2fblkg_scrlbr_x_pos( ctx, obj, val );

This macro returns the value of the Scroll Bar X Position property of the block as type number.

d2fblkg_scrlbr_y_pos( ctx, obj, val );

This macro returns the value of the Scroll Bar Y Position property of the block as type number.

d2fblkg_show_scrlbr( ctx, obj, val );

This macro returns the value of the Show Scroll Bar property of the block as type boolean.

d2fblkg_sngl_rec( ctx, obj, val );

This macro returns the value of the Single Record property of the block as type boolean.

d2fblkg_source( ctx, obj, val );

This macro returns the value of the D2FP_SOURCE property of the block as type object.

d2fblkg_trigger( ctx, obj, val );

This macro returns the value of the D2FP_TRIGGER property of the block as type object.

d2fblkg_upd_dat_src_arg( ctx, obj, val );

This macro returns the value of the Update Data Source Argument property of the block as type object.

d2fblkg_upd_dat_src_col( ctx, obj, val );

This macro returns the value of the Update Data Source Column property of the block as type object.

d2fblkg_updt_allowed( ctx, obj, val );

This macro returns the value of the Update Allowed property of the block as type boolean.

d2fblkg_updt_changed_cols( ctx, obj, val );

This macro returns the value of the Update Changed Columns Only property of the block as type boolean.

d2fblkg_updt_proc_name( ctx, obj, val );

This macro returns the value of the Update Procedure Name property of the block as type text.

d2fblkg_vat_nam( ctx, obj, val );

This macro returns the value of the Visual Attribute Group property of the block as type text.

d2fblkg_vat_obj( ctx, obj, val );

This macro returns the value of the D2FP_VAT_OBJ property of the block as type object.

d2fblkg_where_clause( ctx, obj, val );

This macro returns the value of the WHERE Clause property of the block as type text.

d2fblks_back_color( ctx, obj, val );

This macro sets the value of the Background Color property of the block.

d2fblks_blk_description( ctx, obj, val );

This macro sets the value of the Data Block Description property of the block.

d2fblks_client_info( ctx, obj, val );

This macro sets the value of the D2FP_CLIENT_INFO property of the block.

d2fblks_comment( ctx, obj, val );

This macro sets the value of the Comments property of the block.

d2fblks_db_blk( ctx, obj, val );

This macro sets the value of the Database Block property of the block.

d2fblks_del_allowed( ctx, obj, val );

This macro sets the value of the Delete Allowed property of the block.

d2fblks_del_dat_src_arg( ctx, obj, val );

This macro sets the value of the Delete Data Source Argument property of the block.

d2fblks_del_dat_src_col( ctx, obj, val );

This macro sets the value of the Delete Data Source Column property of the block.

d2fblks_del_proc_nam( ctx, obj, val );

This macro sets the value of the Delete Procedure Name property of the block.

d2fblks_dml_ary_siz( ctx, obj, val );

This macro sets the value of the DML Array Size property of the block.

d2fblks_dml_dat_nam( ctx, obj, val );

This macro sets the value of the DML Data Target Name property of the block.

d2fblks_dml_dat_typ( ctx, obj, val );

This macro sets the value of the DML Data Target Type property of the block.

d2fblks_enfrc_col_security( ctx, obj, val );

This macro sets the value of the Enforce Column Security property of the block.

d2fblks_enfrc_prmry_key( ctx, obj, val );

This macro sets the value of the Enforce Primary Key property of the block.

d2fblks_fill_pat( ctx, obj, val );

This macro sets the value of the Fill Pattern property of the block.

d2fblks_font_nam( ctx, obj, val );

This macro sets the value of the Font Name property of the block.

d2fblks_font_siz( ctx, obj, val );

This macro sets the value of the Font Size property of the block.

d2fblks_font_spcing( ctx, obj, val );

This macro sets the value of the Font Spacing property of the block.

d2fblks_font_sty( ctx, obj, val );

This macro sets the value of the Font Style property of the block.

d2fblks_font_wght( ctx, obj, val );

This macro sets the value of the Font Weight property of the block.

d2fblks_fore_color( ctx, obj, val );

This macro sets the value of the Foreground Color property of the block.

d2fblks_ins_dat_src_arg( ctx, obj, val );

This macro sets the value of the D2FP_INS_DAT_SRC_ARG property of the block.

d2fblks_ins_dat_src_col( ctx, obj, val );

This macro sets the value of the D2FP_INS_DAT_SRC_COL property of the block.

d2fblks_insrt_allowed( ctx, obj, val );

This macro sets the value of the Insert Allowed property of the block.

d2fblks_insrt_proc_nam( ctx, obj, val );

This macro sets the value of the Insert Procedure Name property of the block.

d2fblks_item( ctx, obj, val );

This macro sets the value of the D2FP_ITEM property of the block.

d2fblks_key_mode( ctx, obj, val );

This macro sets the value of the Key Mode property of the block.

d2fblks_lang_dir( ctx, obj, val );

This macro sets the value of the Language Direction property of the block.

d2fblks_lock_dat_src( ctx, obj, val );

This macro sets the value of the Lock Data Source property of the block.

d2fblks_lock_dat_src_col( ctx, obj, val );

This macro sets the value of the Lock Data Source Column property of the block.

d2fblks_lock_mode( ctx, obj, val );

This macro sets the value of the Locking Mode property of the block.

d2fblks_lock_proc_nam( ctx, obj, val );

This macro sets the value of the Lock Procedure Name property of the block.

d2fblks_lst_in_blk_mnu( ctx, obj, val );

This macro sets the value of the Listed In Block Menu property of the block.

d2fblks_max_qry_time( ctx, obj, val );

This macro sets the value of the Maximum Query Time property of the block.

d2fblks_max_recs_fetched( ctx, obj, val );

This macro sets the value of the Max Records Fetched property of the block.

d2fblks_module( ctx, obj, val );

This macro sets the value of the D2FP_MODULE property of the block.

d2fblks_name( ctx, obj, val );

This macro sets the value of the Name property of the block.

d2fblks_navigation_sty( ctx, obj, val );

This macro sets the value of the Navigation Style property of the block.

d2fblks_next( ctx, obj, val );

This macro sets the value of the D2FP_NEXT property of the block.

d2fblks_nxt_navigation_blk_nam( ctx, obj, val );

This macro sets the value of the D2FP_NXT_NAVIGATION_BLK_OBJ property of the block.

d2fblks_nxt_navigation_blk_obj( ctx, obj, val );

This macro sets the value of the Next Navigation Block property of the block.

d2fblks_opt_hint( ctx, obj, val );

This macro sets the value of the Optimizer Hint property of the block.

d2fblks_ordr_by_clause( ctx, obj, val );

This macro sets the value of the ORDER BY Clause property of the block.

d2fblks_owner( ctx, obj, val );

This macro sets the value of the D2FP_OWNER property of the block.

d2fblks_par_flnam( ctx, obj, val );

This macro sets the value of the D2FP_PAR_FLNAM property of the block.

d2fblks_par_flpath( ctx, obj, val );

This macro sets the value of the D2FP_PAR_FLPATH property of the block.

d2fblks_par_modstr( ctx, obj, val );

This macro sets the value of the D2FP_PAR_MODSTR property of the block.

d2fblks_par_modtyp( ctx, obj, val );

This macro sets the value of the D2FP_MODTYPE property of the block.

d2fblks_par_module( ctx, obj, val );

This macro sets the value of the D2FP_PAR_MODULE property of the block.

d2fblks_par_nam( ctx, obj, val );

This macro sets the value of the D2FP_PAR_NAME property of the block.

d2fblks_precomp_summ( ctx, obj, val );

This macro sets the value of the D2FP_PRECOMP_SUMMNO property of the block.

d2fblks_prev_navigation_blk_nam( ctx, obj, val );

This macro sets the value of the Previous Navigation Block property of the block.

d2fblks_prev_navigation_blk_obj( ctx, obj, val );

This macro sets the value of the D2FP_PREV_NAVIGATION_BLK_OBJ property of the block.

d2fblks_previous( ctx, obj, val );

This macro sets the value of the D2FP_PREVIOUS property of the block.

d2fblks_qry_all_recs( ctx, obj, val );

This macro sets the value of the Query All Record property of the block.

d2fblks_qry_allowed( ctx, obj, val );

This macro sets the value of the Query Allowed property of the block.

d2fblks_qry_dat_src_arg( ctx, obj, val );

This macro sets the value of the Query Data Source Name property of the block.

d2fblks_qry_dat_src_col( ctx, obj, val );

This macro sets the value of the Query Data Source Column property of the block.

d2fblks_qry_dat_src_nam( ctx, obj, val );

This macro sets the value of the Query Data Source Name property of the block.

d2fblks_qry_dat_src_typ( ctx, obj, val );

This macro sets the value of the Query Data Source Type property of the block.

d2fblks_rec_ornt( ctx, obj, val );

This macro sets the value of the Record Orientation property of the block.

d2fblks_rec_vat_grp_nam( ctx, obj, val );

This macro sets the value of the Current Record Visual Attribute Group property of the block.

d2fblks_rec_vat_grp_obj( ctx, obj, val );

This macro sets the value of the D2FP_REC_VAT_GRP_OBJ property of the block.

d2fblks_recs_buffered_count( ctx, obj, val );

This macro sets the value of the Number of Records Buffered property of the block.

d2fblks_recs_disp_count( ctx, obj, val );

This macro sets the value of the Number of Records Displayed property of the block.

d2fblks_recs_fetched_count( ctx, obj, val );

This macro sets the value of the D2FP_RECS_FETCHED_COUNT property of the block.

d2fblks_rel( ctx, obj, val );

This macro sets the value of the D2FP_REL property of the block.

d2fblks_rev_dir( ctx, obj, val );

This macro calls sets the value of the Reverse Direction property of the block.

d2fblks_scrlbr_cnv_nam( ctx, obj, val );

This macro sets the value of the Scroll Bar Canvas property of the block.

d2fblks_scrlbr_cnv_obj( ctx, obj, val );

This macro sets the value of the D2FP_SCRLBR_CNV_OBJ property of the block.

d2fblks_scrlbr_hgt( ctx, obj, val );

This macro sets the value of the Scroll Bar Height property of the block.

d2fblks_srclbr_ornt( ctx, obj, val );

This macro sets the value of the Scroll Bar Orientation property of the block.

d2fblks_scrlbr_tbp_nam( ctx, obj, val );

This macro sets the value of the Scroll Bar Tab Page property of the block.

d2fblks_scrlbr_tbp_obj( ctx, obj, val );

This macro sets the value of the D2FP_SCRLBR_TSP_OBJ property of the block.

d2fblks_scrlbr_wid( ctx, obj, val );

This macro sets the value of the Scroll Bar Width property of the block.

d2fblks_scrlbr_x_pos( ctx, obj, val );

This macro sets the value of the Scroll Bar X Position property of the block.

d2fblks_scrlbr_y_pos( ctx, obj, val );

This macro sets the value of the Scroll Bar Y Position property of the block.

d2fblks_show_scrlbr( ctx, obj, val );

This macro sets the value of the Show Scroll Bar property of the block.

d2fblks_sngl_rec( ctx, obj, val );

This macro sets the value of the Single Record property of the block.

d2fblks_source( ctx, obj, val );

This macro sets the value of the D2FP_SOURCE property of the block.

d2fblks_trigger( ctx, obj, val );

This macro sets the value of the D2FP_TRIGGER property of the block.

d2fblks_upd_dat_src_arg( ctx, obj, val );

This macro sets the value of the Update Data Source Argument property of the block.

d2fblks_upd_dat_src_col( ctx, obj, val );

This macro sets the value of the Update Data Source Column property of the block.

d2fblks_updt_allowed( ctx, obj, val );

This macro sets the value of the Update Allowed property of the block.

d2fblks_updt_changed_cols( ctx, obj, val );

This macro sets the value of the Update Changed Columns Only property of the block.

d2fblks_updt_proc_name( ctx, obj, val );

This macro sets the value of the Update Procedure Name property of the block.

d2fblks_vat_nam( ctx, obj, val );

This macro sets the value of the Visual Attribute Group property of the block.

d2fblks_vat_obj( ctx, obj, val );

This macro sets the value of the D2FP_VAT_OBJ property of the block.

d2fblks_where_clause( ctx, obj, val );

This macro sets the value of the WHERE Clause property of the block.


Creating modules using the Open API

Modifying modules using the Open API

About Open API header files

Block object functions

Block object API properties

Block object