TIPTOP内置函数.docx

1、TIPTOP内置函数TIPTOP内置函数函式名称：cl_about 程序名称：cl_about.4gl 用途：程序信息 传入参数：none 回传值：none 用法：CALL cl_about() 函式名称：cl_anykey 程序名称：cl_anykey.4gl 用途：请按任何键继续 传入参数：p_sw Not used 回传值：none 用法：CALL cl_anykey() 函式名称：cl_autotime 程序名称：cl_autotime.4gl 用途：自动累加时间，累加级数为1 传入参数：time1 累加起始时间 sw 累加类型H:小时M:分钟S:秒钟 lay 累加级数Default

2、= 1 回传值：Time 时间 用法：CALL cl_autotime(09:30,H,1) 函式名称：cl_batch_proc 程序名称：cl_batch_proc.4gl 用途：动态产生批次数据处理画面 传入参数：ps_headers (Table 的Header 字符串，中间以逗号分隔) 回传值：none 用法：LET ls_headers = img01,img02,img03,img04,imk09 CALL cl_batch_proc(ls_headers) 函式名称：cl_cal 程序名称：cl_cal.4gl 用途：传入当前日期，要增加的月份及天数取得计算过后的日期 传入参数

3、：p_date 日期 p_month 月份 p_day 日 回传值：l_year,l_month,l_day 用法：LET l_date=cl_cal(p_date,p_mm,p_dd) 函式名称：cl_chg_comp_att 程序名称：cl_chg_comp_att.4gl 用途：更动原有对象的attribute 传入参数：ps_field STRING 欲更动字段名称 ps_atts STRING 字段type 属性 ps_values STRING 字段type 属性值 回传值：none 用法：CALL cl_chg_comp_att (ima01,NOENTRY|ITEMS,1|(1

4、,2,3),(red,b lue,green) 函式名称：cl_chg_win_title 程序名称：cl_chg_win_title.4gl 用途： 转换程序Title 显示 传入参数：ps_str 显示字符串 回传值：none 用法：CALL cl_chg_win_title(“用户参数设定作业”) 函式名称：cl_chk_act_auth 程序名称：cl_chk_act_auth.4gl 用途： 检查ACTION 的权限检查前务必指定g_action_choice 值 传入参数：none 回传值：1 FOR TRUE 是 0 FOR FALSE 否 用法：LET g_action_cho

5、ice = “insert” IF cl_chk_act_auth() THEN 函式名称：cl_chk_data_continue 程序名称：cl_chk_data_continue.4gl 用途： 检查资料是否连续 传入参数：ps_source STRING 来源资料 回传值：1 FOR TRUE 是 0 FOR FALSE 否 用法：IF NOT cl_chk_data_continue(g_pmw.pmw015,10) THEN 函式名称：cl_chk_str_correct 程序名称：cl_chk_data_continue.4gl 用途：检查字符串是否符合09,az 传入参数：ps

6、_source STRING 来源资料 ps_count SMALLINT 检查几码，如果未传几码，则会以 来源字符串长度当作ps_count li_result SMALLINT 回传结果 回传值：1 FOR TRUE 是 0 FOR FALSE 否 用法：IF NOT cl_chk_data_continue(g_pmw.pmw011,3) THEN 函式名称：cl_chkym 程序名称：cl_chkym.4gl 用途：检查文字型态变量是否为年月型态 传入参数：p_str CHAR(6) 文字型态变量 回传值：1 FOR TRUE 是 0 FOR FALSE 否 用法：IF cl_chky

7、m(p_str) 函式名称：cl_choice 程序名称：cl_choice.4gl 用途：让用户输入选择 传入参数：l_msg CHAR(100) 窗口上显示的说明文字 回传值：l_choice 用法：CALL cl_choice(l_msg) RETURNING g_choice 函式名称：cl_open_url 程序名称：cl_client_app.4gl 用途：藉由explorer 开启传入的网址 传入参数：ps_url STRING 网址 回传值：1 FOR TRUE 是 0 FOR FALSE 否 用法：CALL cl_open_url(http:/www) 函式名称：cl_ope

8、n_doc 程序名称：cl_client_app.4gl 用途：开启档案 传入参数：ps_doc STRING 档案位置 回传值：1 FOR TRUE 是 0 FOR FALSE 否 用法：CALL cl_open_doc(C:/tiptop/tiptop.txt) 函式名称：cl_open_prog 程序名称：cl_client_app.4gl 用途：藉由指定的程序开启档案 传入参数：ps_prog STRING 程序工具 ps_arg STRING 档案位置 回传值：1 FOR TRUE 是 0 FOR FALSE 否 用法：CALL cl_open_prog(C:/Editor.exe,

9、 C:/tiptop/tiptop.txt) 函式名称：cl_close 程序名称：cl_close.4gl 用途：询问此笔资料是否确定结案(Y/N)： 或此笔资料是否取消结案(Y/N)： 传入参数：p_row,p_col 无作用，传入0,0 即可 p_old_acticode 传入Y 代表讯息为取消结案；N 代表确定结案 回传值：1 FOR TRUE 是 0 FOR FALSE 否 用法：IF cl_close(0,0,”Y”) 函式名称：cl_cmdask 程序名称：cl_cmdask.4gl 用途：询问用户欲执行的程序，并执行之 传入参数：none 回传值：none 用法：CALL cl

10、_cmdask() 函式名称：cl_cmdat 程序名称：cl_cmdat.4gl 用途：指定时间延后执行UNIX 指令 传入参数：p_time 指定时间 p_cmd UNIX 指令 回传值：none 用法：CALL cl_cmdat(p_code,p_time,p_cmd) 函式名称：cl_cmdrun 程序名称： 用途：执行UNIX 指令 传入参数：ps_cmd 程序代码或UNIX 执行指令 回传值：none 用法：CALL cl_cmdrun(axmq450) 函式名称：cl_cmdrun_wait 程序名称： 用途：执行UNIX 指令，需等待此指令结束后才可继续原程序的执行 传入参数：

11、ps_cmd 程序代码或UNIX 执行指令 回传值：none 用法：LET l_cmd=axmp800 ,g_oea.oea01, ,g_oea.oea905, CALL cl_cmdrun_wait(l_cmd) 函式名称：cl_cmmsg 程序名称：cl_cmmsg.4gl 用途：显示异动更新成功讯息 传入参数：p_code 讯息种类1 及4 代表异动更新完成 2 及3 代表此张单据异动更新完成 回传值：none 用法：CALL cl_cmmsg(1) 函式名称：cl_conf3 程序名称：cl_conf3.4gl 用途：根据MESSAGE CODE 取出正确讯息，询问 配合发票的使用，本

12、作业允许用户不输入数据 传入参数：p_row,p_col 无作用 p_msgcode 回传值：1 FOR TRUE 是 0 FOR FALSE 否 用法：IF cl_conf(0,0,p_msgcode) THEN 函式名称：cl_confirm 程序名称：cl_confirm.4gl 用途：依照讯息代码将数据显示在画面上，询问是否 传入参数：ps_msg 讯息代码或讯息字符串 回传值：1 FOR TRUE 是 0 FOR FALSE 否 用法：IF (cl_confirm(agl-021) THEN 函式名称：cl_cont 程序名称：cl_cont.4gl 用途：询问是否继续执行本作业(Y

13、/N)： 传入参数：p_row,p_col 无作用 回传值：1 FOR TRUE 是 0 FOR FALSE 否 用法：IF cl_cont(0,0) THEN 函式名称：cl_create_4sm 程序名称：cl_create_4sm.4gl 用途：产生udm_tree 所需要的StartMenu 档案 传入参数：pc_menu_root StartMenu 的根节点 pi_rebuild 是否需要重新覆盖已存在的4sm 档案 回传值：none 用法：CALL cl_create_4sm(m01, TRUE) 函式名称：cl_create_qry 程序名称：cl_create_qry.4gl

14、 用途：动态产生窗口以供查询，并回传查询结果 传入参数：none 回传值：ms_ret1,ms_ret2,ms_ret3 回传数目依照对应的回传字段数 用法：CALL cl_create_qry() RETURNING g_oea.oea14 函式名称：cl_dynamic_qry 程序名称：cl_create_qry.4gl 用途：自定义/行业别字段动态产生开窗功能，并回传查询结果 传入参数：none 回传值：ms_ret1,ms_ret2,ms_ret3 回传数目依照对应的回传字段数 用法：CALL cl_dynamic_qry() RETURNING g_oea.oeaida001 函式

15、名称：cl_days 程序名称：cl_days.4gl 用途：取得该年月的天数 传入参数：p_year 年份 p_month 月份 回传值：l_days 天数 用法：let l_days=cl_days(p_yy,p_mm) 函式名称：cl_delb 程序名称：cl_delb.4gl 用途：询问是否确定取消此笔单身资料(Y/N)： (for 单文件建文件程序单身取消功能ON KEY F2) 传入参数：p_row,p_col 回传值：1 FOR TRUE 是 0 FOR FALSE 否 用法：IF cl_delb(0,0) THEN 函式名称：cl_delete 程序名称：cl_delete.4

16、gl 用途：询问是否删除此笔资料？ 传入参数：none 回传值：1 FOR TRUE 是 0 FOR FALSE 否 用法：IF (cl_delete() THEN 函式名称：cl_delh 程序名称：cl_delh.4gl 用途：询问是否确定删除此笔单头及所有单身数据(Y/N)： (for 单文件建文件程序单头删除功能) 传入参数：p_row,p_col 回传值：1 FOR TRUE 是 0 FOR FALSE 否 用法：if cl_delh(0,0) 函式名称：cl_delh1程序名称：cl_delh1.4gl用途：询问是否确定取消此笔单头及所有单身数据(Y/N)：(for 单文件建文件程

17、序单头取消功能)传入参数：p_row,p_col回传值：1 FOR TRUE 是0 FOR FALSE 否用法：if cl_delh1(0,0) 函式名称：cl_detail_input_auth程序名称：cl_detail_input_auth.4gl用途：检查是否允许在单身中有insert 或delete 的权限传入参数：ps_act_type STRING 要检查的字符串（insert/delete）回传值：1 FOR TRUE 是0 FOR FALSE 否用法：CALL cl_detail_input_auth(insert) 函式名称：cl_digcut程序名称：cl_digcut.

18、4gl用途：将数值依指定的小数位数做四舍五入传入参数：p_value 数值p_digit 允许小数位数回传值：p_value 四舍五入后的数值用法：LET a = cl_digcut(p_value,p_digit) 函式名称：cl_doc程序名称：cl_doc.4gl用途：相关档案维护传入参数：none回传值：none用法：LET g_doc.column1 = oea01LET g_doc.value1 = g_oea.oea01CALL cl_doc() 函式名称：cl_dynamic_locale程序名称：cl_dynamic_locale.4gl用途：动态转换画面语言别传入参数：no

19、ne回传值：none用法：CALL cl_dynamic_locale() 函式名称：cl_end程序名称：cl_end.4gl用途：显示作业结束，请按任何键继续：传入参数：p_row,p_col 无作用回传值：none用法：CALL cl_end(0,0) 函式名称：cl_end2程序名称：cl_end2.4gl用途：显示执行结果，并询问是否要继续作业传入参数：p_code （1 代表成功，2 代表失败）回传值：1 FOR TRUE 是0 FOR FALSE 否用法：CALL cl_end2(1) RETURNING l_flag 函式名称：cl_err程序名称：cl_err.4gl用途：显

20、示错误讯息传入参数：p_msg 错误讯息的附加说明err_code 错误讯息代码p_n 显示错误讯息后的停留秒数或是等用户按下确定0 ：不开启讯息窗口，只在状态列显示 1 ：停留秒数1 ：开启讯息窗口等待用户确定回传值：none用法：CALL cl_err(p_msg,err_code,p_n) 函式名称：cl_err_msg程序名称：cl_err_msg.4gl用途：显示错误讯息传入参数：ps_title 错误讯息的附加说明ps_err_code 错误讯息代码ps_replace_arg 欲替换的讯息字符串，以”| ”分隔字符串pi_idle_sec idle 秒数0 ：不开启讯息窗口，只在

21、状态列显示 1 ：停留秒数1 ：开启讯息窗口等待用户确定回传值：none用法：CALL cl_err_msg(Warning,1000,NULL,1) 函式名称：cl_err3程序名称：用途：显示数据库处理后的错误讯息（insert/update/delete/select）传入参数：Type 讯息的类型（ins、del、upd、sel）Tables 处理的table 代码Key1 Key1 的valueKey2 Key2 的valueDescription 额外讯息（讯息代码/讯息字符串）Action 讯息Action 代码（未来延伸功能，可不传）Mark 按下更多按键时显示的讯息Open

22、是否开窗（0/1）回传值：none用法：CALL cl_err3(ins,azb_file,g_azb01,SQLCA.sqlcode,0) 函式名称：cl_err_msg_log程序名称：cl_err_msg.4gl用途：纪录错误讯息传入参数：none回传值：none用法：WHENEVER ERROR CALL cl_err_msg_log 函式名称：cl_exp程序名称：cl_exp.4gl用途：询问此笔资料是否确定无效(Y/N)：或此笔资料是否恢复有效(Y/N)：(for 单文件建文件无效功能)传入参数：p_row,p_colp_old_acticode 有效码Y/N回传值：1 FOR

23、TRUE 是0 FOR FALSE 否用法：IF cl_exp(0,0,g_pmw.pmwacti) THEN 函式名称：cl_export_to_excel程序名称：cl_export_to_excel.4gl用途：传入参数：n 画面的根节点组件ui.Interface.getRootNode()t、t1、t2 单身的数据若有两个以上的单身才会用到t1、t2回传值：none用法：CALL cl_export_to_excel(ui.Interface.getRootNode(),base.TypeInfo.create(g_pmx),) 函式名称：cl_facfor程序名称：cl_facfo

24、r.4gl用途：将INPUT DECLIAM(16,8) 数值转为9 位字符的格式若值为12345678 , 将传回12345678若值为1234567 , 将传回1234567.0若值为123456 , 将传回123456.00若值为12345.67 , 将传回12345.670若值为1.234567 , 将传回1.2345670若值为.1234567 , 将传回.12345670传入参数：p_fac 数值回传值：l_str FORMAT 后的数值，以CHAR 型态RETURN用法：LET a = cl_facfor(p_fac); PRINT aPRINT cl_facfor(p_fac)

25、 函式名称：cl_field_format程序名称：cl_field_format.4gl用途：转换p_per 内自由格式设定的format传入参数：ps_currency CHAR(04) 当前无用处pc_frm_name CHAR(10) 画面档名回传值：none用法：CALL cl_field_format(g_aza.aza17, mc_frm_name) 函式名称：cl_fld_doc程序名称：cl_fld_doc.4gl用途：字段的相关档案维护传入参数：ps_field STRING 字段名称回传值：url 档案的URL用法：CALL cl_fld_doc(ima01) 函式名称：

26、cl_fldhelp程序名称：cl_fldhelp.4gl用途：显示字段说明传入参数：g_frm_name 画面档名称g_fld_name 字段名称g_lang 语言别回传值：none用法：CALL cl_fldhelp(g_frm_name,g_fld_name,g_lang) 函式名称：cl_flow_notify程序名称：cl_flow_notify.4gl用途：透过JavaMail 传送工作流程通知传入参数：ps_doc_no STRING 单据编号pc_state CHAR(1) 功能类别(I.新增U.更改D.删除Y.确认S.过帐V.作废)回传值：none用法：CALL cl_flo

27、w_notify(g_pmw.pmw01,I) 函式名称：cl_forupd_sql程序名称：cl_forupd_sql.4gl用途：判断SELECT . FOR UPDATE 是否加上其它语法(byDatabase)传入参数：ps_forupd_sql STRING 原传入SQL 字符串回传值：ps_forupd_sql STRING 调整过的SQL 字符串用法：CALL cl_forupd_sql(ps_forupd_sql) 函式名称：cl_get_column_info程序名称：cl_get_column_info.4gl用途：取得字段型态及长度传入参数：p_tabname TABLE

28、 名称p_colname 字段名称回传值：字段型态not null FOR TRUE：有回传值：null FOR FALSE：否长度not null FOR TRUE：有回传值：null FOR FALSE：否用法：CALL cl_get_column_info(p_tabname,p_colname)RETURNING l_coldatatype,l_collength 函式名称：cl_get_feldname程序名称：cl_get_feldname.4gl用途：依字段代码取出系统字段名称设定维护作业(p_feldname)内的字段名称传入参数：p_gaq01 字段代码p_lang 语言别回

29、传值：l_gaq03 字段说明用法：LET g_msg = cl_get_feldname(p_gaq01,p_lang) 函式名称：cl_get_progdesc程序名称：cl_get_progdesc.4gl用途：取得程序代码说明(若有客制码=Y的优先回传)传入参数：p_gaz01 程序代码p_lang 语言别回传值：l_gaz03 程序代码说明用法：LET g_msg = cl_get_progdesc(g_prog,p_lang) 函式名称：cl_getmsg程序名称：cl_getmsg.4gl用途：依讯息代码取出系统错误讯息文件(ze_file)内的错误讯息传入参数：p_code 讯息代码p_lang 语言别回传值：l_msg 错误讯息.用法：LET g_msg = cl_getmsg(p_code,p_lang) 函式名称：cl_insert_top_menu程序名称：cl_insert_top_menu.4gl用途：插入TopMenu传入参数：pc_prog CHAR(10) 程序代号回传值：none用法：CALL cl_insert_top_menu(NULL) 函式名称：cl_itemname_by_lang程序名称：cl_itemname_by_lang.4gl用途：多语言记录功能查询