TIPTOPGP 公用程序(一)

函式名称：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 = 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

用途：传入当前日期，要增加的月份及天数取得计算过后的日期

传入参数：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,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_choice = “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.pmw01[5,10]) THEN

 

函式名称：cl_chk_str_correct

程序名称：cl_chk_data_continue.4gl

用途：检查字符串是否符合0~9,a~z

传入参数：ps_source STRING 来源资料

ps_count SMALLINT 检查几码，如果未传几码，则会以

来源字符串长度当作ps_count

li_result SMALLINT 回传结果

回传值：1 FOR TRUE 是

0 FOR FALSE 否

用法：IF NOT cl_chk_data_continue(g_pmw.pmw01[1,3]) THEN

 

函式名称：cl_chkym

程序名称：cl_chkym.4gl

用途：检查文字型态变量是否为年月型态

传入参数：p_str CHAR(6) 文字型态变量

回传值：1 FOR TRUE 是

0 FOR FALSE 否

用法：IF cl_chkym(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.yahoo.com.tw")

 

函式名称：cl_open_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", "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_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 指令，需等待此指令结束后才可继续原程序的执行

传入参数：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 取出正确讯息，询问

﹝配合发票的使用，本作业允许用户不输入数据﹞

传入参数：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/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

用途：动态产生窗口以供查询，并回传查询结果

传入参数：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

 

函式名称：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.4gl

用途：询问〝是否删除此笔资料？〞

传入参数：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 单文件建文件程序单头取消功能)

传入参数：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.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 = "oea01"

LET g_doc.value1 = g_oea.oea01

CALL cl_doc()

 

函式名称：cl_dynamic_locale

程序名称：cl_dynamic_locale.4gl

用途：动态转换画面语言别

传入参数：none

回传值：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

用途：显示错误讯息

传入参数：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 ：不开启讯息窗口，只在状态列显示

> 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 的value

Key2 Key2 的value

Description 额外讯息（讯息代码/讯息字符串）

Action 讯息Action 代码（未来延伸功能，可不传）

Mark 按下〝更多〞按键时显示的讯息

Open 是否开窗（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_col

p_old_acticode 有效码﹝Y/N﹞

回传值：1 FOR 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_facfor.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 a

PRINT cl_facfor(p_fac)

 

函式名称：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")

 

函式名称：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_flow_notify(g_pmw.pmw01,'I')

 

函式名称：cl_forupd_sql

程序名称：cl_forupd_sql.4gl

用途：判断SELECT ... FOR UPDATE 是否加上其它语法(by

Database)

传入参数：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 名称

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 语言别

回传值：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

用途：多语言记录功能查询

传入参数：l_gbc01 档案代码(Table ID) "zx_file"

l_gbc02 字段代码"zx02"

l_gbc03 KEY 值序列，多组时以，隔开"001"

l_gbc04 语言别g_lang

l_gbc05 数据多语言名称"中文名称"

回传值：lc_gbc05 对应语言别的名称

用法：CALL cl_itemname_by_lang("ima_file","ima02",g_ima.ima01

CLIPPED,g_lang,g_ima.ima02) RETURNING g_ima.ima02

 

函式名称：cl_load_act_list

程序名称：cl_load_act_list.4gl

用途：载入ActionList ﹝程序所属的4ad，ex. axmt410.4ad﹞

传入参数：ps_prog STRING 程序代号

回传值：none

用法：CALL cl_load_act_list(NULL)

 

函式名称：cl_load_act_sys

程序名称：cl_load_act_sys.4gl

用途：加载ActionList ﹝系统标准的4ad，tiptop.4ad﹞

传入参数：ps_prog STRING 程序代号

回传值：none

用法：CALL cl_load_act_sys(NULL)

 

函式名称：cl_load_action_view

程序名称：cl_load_action_view.4gl

用途：载入TopMenu 与ToolBar

传入参数：none

回传值：none

用法：CALL cl_load_action_view()

 

函式名称：cl_load_style_list

程序名称：cl_load_style_list.4gl

用途：载入StyleList

传入参数：ps_prog STRING 程序代号

回传值：none

用法：CALL cl_load_style_list(NULL)

 

函式名称：cl_msgany

程序名称：cl_msgany.4gl

用途：显示讯息，然后按任何键继续

传入参数：p_row,p_col 无作用

p_msg 讯息代码

回传值：none

用法：CALL cl_prompt(0,0,l_msg)

 

函式名称：cl_navigator_setting

程序名称：cl_navigator_setting.4gl

用途：设定ToolBar 上浏览上下笔数据的按钮状态

传入参数：pi_curr_index 当前Cursor 索引值

pi_row_count 资料笔数

回传值：none

用法：CALL cl_navigator_setting( g_curs_index, g_row_count )

 

函式名称：cl_null

程序名称：cl_null.4gl

用途：检查字符串是否为Null 或是空字符串

传入参数：ps_source （来源字符串）

回传值：1 FOR TRUE 是

0 FOR FALSE 否

用法：IF NOT cl_null(g_pmx[l_ac].pmx02) THEN

 

函式名称：cl_numchk

程序名称：cl_numchk.4gl

用途：检查'p_str' 是否为数值型态

传入参数：p_str 欲检查字符串

p_len 检查的长度

回传值：1 FOR TRUE 是

0 FOR FALSE 否

用法：IF cl_numchk(p_str,p_len) THEN

 

函式名称：cl_numfor

程序名称：cl_numfor.4gl

用途：将数值依指定的打印长度及小数字数做FORMAT，以便打印

若值为0，将传回0.00，并非空白

传入参数：p_value 数值

p_len 允许打印长度

回传值：l_str FORMAT 后的数值，以CHAR 型态RETURN

用法：LET a = cl_numfor(amt,17)；PRINT a