TIPTOP内置函数.docx
《TIPTOP内置函数.docx》由会员分享，可在线阅读，更多相关《TIPTOP内置函数.docx（46页珍藏版）》请在冰豆网上搜索。
TIPTOP内置函数
TIPTOP内置函数
函式名称：
cl_about
程序名称：
cl_about.4gl
用途：
程序信息
传入参数：
none
回传值：
none
用法：
CALLcl_about（）
函式名称：
cl_anykey
程序名称：
cl_anykey.4gl
用途：
请按任何键继续
传入参数：
p_swNotused
回传值：
none
用法：
CALLcl_anykey（）
函式名称：
cl_autotime
程序名称：
cl_autotime.4gl
用途：
自动累加时间，累加级数为1
传入参数：
time1累加起始时间
sw累加类型H:
小时M:
分钟S:
秒钟
lay累加级数Default=1
回传值：
Time时间
用法：
CALLcl_autotime（'09:
30','H',1）
函式名称：
cl_batch_proc
程序名称：
cl_batch_proc.4gl
用途：
动态产生批次数据处理画面
传入参数：
ps_headers（Table的Header字符串，中间以逗号分隔）
回传值：
none
用法：
LETls_headers="img01,img02,img03,img04,imk09"
CALLcl_batch_proc（ls_headers）
函式名称：
cl_cal
程序名称：
cl_cal.4gl
用途：
传入当前日期，要增加的月份及天数取得计算过后的日期
传入参数：
p_date日期
p_month月份
p_day日
回传值：
l_year,l_month,l_day
用法：
LETl_date=cl_cal（p_date,p_mm,p_dd）
函式名称：
cl_chg_comp_att
程序名称：
cl_chg_comp_att.4gl
用途：
更动原有对象的attribute
传入参数：
ps_fieldSTRING欲更动字段名称
ps_attsSTRING字段type属性
ps_valuesSTRING字段type属性值
回传值：
none
用法：
CALLcl_chg_comp_att
（"ima01","NOENTRY|ITEMS","1|（1,2,3）,（red,blue,green）"）
函式名称：
cl_chg_win_title
程序名称：
cl_chg_win_title.4gl
用途：
转换程序Title显示
传入参数：
ps_str显示字符串
回传值：
none
用法：
CALLcl_chg_win_title（“用户参数设定作业”）
函式名称：
cl_chk_act_auth
程序名称：
cl_chk_act_auth.4gl
用途：
检查ACTION的权限﹝检查前务必指定g_action_choice值﹞
传入参数：
none
回传值：
1FORTRUE是
0FORFALSE否
用法：
LETg_action_choice=“insert”
IFcl_chk_act_auth（）THEN
函式名称：
cl_chk_data_continue
程序名称：
cl_chk_data_continue.4gl
用途：
检查资料是否连续
传入参数：
ps_sourceSTRING来源资料
回传值：
1FORTRUE是
0FORFALSE否
用法：
IFNOTcl_chk_data_continue（g_pmw.pmw01[5,10]）THEN
函式名称：
cl_chk_str_correct
程序名称：
cl_chk_data_continue.4gl
用途：
检查字符串是否符合0~9,a~z
传入参数：
ps_sourceSTRING来源资料
ps_countSMALLINT检查几码，如果未传几码，则会以
来源字符串长度当作ps_count
li_resultSMALLINT回传结果
回传值：
1FORTRUE是
0FORFALSE否
用法：
IFNOTcl_chk_data_continue（g_pmw.pmw01[1,3]）THEN
函式名称：
cl_chkym
程序名称：
cl_chkym.4gl
用途：
检查文字型态变量是否为年月型态
传入参数：
p_strCHAR（6）文字型态变量
回传值：
1FORTRUE是
0FORFALSE否
用法：
IFcl_chkym（p_str）
函式名称：
cl_choice
程序名称：
cl_choice.4gl
用途：
让用户输入选择
传入参数：
l_msgCHAR（100）窗口上显示的说明文字
回传值：
l_choice
用法：
CALLcl_choice（l_msg）RETURNINGg_choice
函式名称：
cl_open_url
程序名称：
cl_client_app.4gl
用途：
藉由explorer开启传入的网址
传入参数：
ps_urlSTRING网址
回传值：
1FORTRUE是
0FORFALSE否
用法：
CALLcl_open_url（"http:
//www"）
函式名称：
cl_open_doc
程序名称：
cl_client_app.4gl
用途：
开启档案
传入参数：
ps_docSTRING档案位置
回传值：
1FORTRUE是
0FORFALSE否
用法：
CALLcl_open_doc（"C:
/tiptop/tiptop.txt"）
函式名称：
cl_open_prog
程序名称：
cl_client_app.4gl
用途：
藉由指定的程序开启档案
传入参数：
ps_progSTRING程序工具
ps_argSTRING档案位置
回传值：
1FORTRUE是
0FORFALSE否
用法：
CALLcl_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代表确定结案
回传值：
1FORTRUE是
0FORFALSE否
用法：
IFcl_close（0,0,”Y”）
函式名称：
cl_cmdask
程序名称：
cl_cmdask.4gl
用途：
询问用户欲执行的程序，并执行之
传入参数：
none
回传值：
none
用法：
CALLcl_cmdask（）
函式名称：
cl_cmdat
程序名称：
cl_cmdat.4gl
用途：
指定时间延后执行UNIX指令
传入参数：
p_time指定时间
p_cmdUNIX指令
回传值：
none
用法：
CALLcl_cmdat（p_code,p_time,p_cmd）
函式名称：
cl_cmdrun
程序名称：
用途：
执行UNIX指令
传入参数：
ps_cmd程序代码或UNIX执行指令
回传值：
none
用法：
CALLcl_cmdrun（'axmq450'）
函式名称：
cl_cmdrun_wait
程序名称：
用途：
执行UNIX指令，需等待此指令结束后才可继续原程序的执行
传入参数：
ps_cmd程序代码或UNIX执行指令
回传值：
none
用法：
LETl_cmd="axmp800'",g_oea.oea01,"''",g_oea.oea905,"'"
CALLcl_cmdrun_wait（l_cmd）
函式名称：
cl_cmmsg
程序名称：
cl_cmmsg.4gl
用途：
显示异动更新成功讯息
传入参数：
p_code讯息种类1及4代表异动更新完成
2及3代表此张单据异动更新完成
回传值：
none
用法：
CALLcl_cmmsg
（1）
函式名称：
cl_conf3
程序名称：
cl_conf3.4gl
用途：
根据MESSAGECODE取出正确讯息，询问
﹝配合发票的使用，本作业允许用户不输入数据﹞
传入参数：
p_row,p_col无作用
p_msgcode
回传值：
1FORTRUE是
0FORFALSE否
用法：
IFcl_conf（0,0,p_msgcode）THEN
函式名称：
cl_confirm
程序名称：
cl_confirm.4gl
用途：
依照讯息代码将数据显示在画面上，询问〝是否…〞
传入参数：
ps_msg讯息代码或讯息字符串
回传值：
1FORTRUE是
0FORFALSE否
用法：
IF（cl_confirm（"agl-021"））THEN
函式名称：
cl_cont
程序名称：
cl_cont.4gl
用途：
询问"是否继续执行本作业（Y/N）：
"
传入参数：
p_row,p_col无作用
回传值：
1FORTRUE是
0FORFALSE否
用法：
IFcl_cont（0,0）THEN
函式名称：
cl_create_4sm
程序名称：
cl_create_4sm.4gl
用途：
产生udm_tree所需要的StartMenu档案
传入参数：
pc_menu_rootStartMenu的根节点
pi_rebuild是否需要重新覆盖已存在的4sm档案
回传值：
none
用法：
CALLcl_create_4sm（"m01",TRUE）
函式名称：
cl_create_qry
程序名称：
cl_create_qry.4gl
用途：
动态产生窗口以供查询，并回传查询结果
传入参数：
none
回传值：
ms_ret1,ms_ret2,ms_ret3回传数目依照对应的回传字段数
用法：
CALLcl_create_qry（）RETURNINGg_oea.oea14
函式名称：
cl_dynamic_qry
程序名称：
cl_create_qry.4gl
用途：
自定义/行业别字段动态产生开窗功能，并回传查询结果
传入参数：
none
回传值：
ms_ret1,ms_ret2,ms_ret3回传数目依照对应的回传字段数
用法：
CALLcl_dynamic_qry（）RETURNINGg_oea.oeaida001
函式名称：
cl_days
程序名称：
cl_days.4gl
用途：
取得该年月的天数
传入参数：
p_year年份
p_month月份
回传值：
l_days天数
用法：
letl_days=cl_days（p_yy,p_mm）
函式名称：
cl_delb
程序名称：
cl_delb.4gl
用途：
询问"是否确定取消此笔单身资料（Y/N）：
"
（for单文件建文件程序单身取消功能ONKEYF2）
传入参数：
p_row,p_col
回传值：
1FORTRUE是
0FORFALSE否
用法：
IFcl_delb（0,0）THEN
函式名称：
cl_delete
程序名称：
cl_delete.4gl
用途：
询问〝是否删除此笔资料？
〞
传入参数：
none
回传值：
1FORTRUE是
0FORFALSE否
用法：
IF（cl_delete（））THEN
函式名称：
cl_delh
程序名称：
cl_delh.4gl
用途：
询问"是否确定删除此笔单头及所有单身数据（Y/N）：
"
（for单文件建文件程序单头删除功能）
传入参数：
p_row,p_col
回传值：
1FORTRUE是
0FORFALSE否
用法：
ifcl_delh（0,0）
函式名称：
cl_delh1
程序名称：
cl_delh1.4gl
用途：
询问"是否确定取消此笔单头及所有单身数据（Y/N）：
"
（for单文件建文件程序单头取消功能）
传入参数：
p_row,p_col
回传值：
1FORTRUE是
0FORFALSE否
用法：
ifcl_delh1（0,0）
函式名称：
cl_detail_input_auth
程序名称：
cl_detail_input_auth.4gl
用途：
检查是否允许在单身中有insert或delete的权限
传入参数：
ps_act_typeSTRING要检查的字符串（insert/delete）
回传值：
1FORTRUE是
0FORFALSE否
用法：
CALLcl_detail_input_auth（"insert"）
函式名称：
cl_digcut
程序名称：
cl_digcut.4gl
用途：
将数值依指定的小数位数做四舍五入
传入参数：
p_value数值
p_digit允许小数位数
回传值：
p_value四舍五入后的数值
用法：
LETa=cl_digcut（p_value,p_digit）
函式名称：
cl_doc
程序名称：
cl_doc.4gl
用途：
相关档案维护
传入参数：
none
回传值：
none
用法：
LETg_doc.column1="oea01"
LETg_doc.value1=g_oea.oea01
CALLcl_doc（）
函式名称：
cl_dynamic_locale
程序名称：
cl_dynamic_locale.4gl
用途：
动态转换画面语言别
传入参数：
none
回传值：
none
用法：
CALLcl_dynamic_locale（）
函式名称：
cl_end
程序名称：
cl_end.4gl
用途：
显示"作业结束，请按任何键继续：
"
传入参数：
p_row,p_col无作用
回传值：
none
用法：
CALLcl_end（0,0）
函式名称：
cl_end2
程序名称：
cl_end2.4gl
用途：
显示执行结果，并询问是否要继续作业
传入参数：
p_code（1代表成功，2代表失败）
回传值：
1FORTRUE是
0FORFALSE否
用法：
CALLcl_end2
（1）RETURNINGl_flag
函式名称：
cl_err
程序名称：
cl_err.4gl
用途：
显示错误讯息
传入参数：
p_msg错误讯息的附加说明
err_code错误讯息代码
p_n显示错误讯息后的停留秒数或是等用户按下确定
0：
不开启讯息窗口，只在状态列显示
>1：
停留秒数
1：
开启讯息窗口等待用户确定
回传值：
none
用法：
CALLcl_err（p_msg,err_code,p_n）
函式名称：
cl_err_msg
程序名称：
cl_err_msg.4gl
用途：
显示错误讯息
传入参数：
ps_title错误讯息的附加说明
ps_err_code错误讯息代码
ps_replace_arg欲替换的讯息字符串，以”|”分隔字符串
pi_idle_secidle秒数
0：
不开启讯息窗口，只在状态列显示
>1：
停留秒数
1：
开启讯息窗口等待用户确定
回传值：
none
用法：
CALLcl_err_msg（"Warning","1000",NULL,1）
函式名称：
cl_err3
程序名称：
用途：
显示数据库处理后的错误讯息（insert/update/delete/select）
传入参数：
Type讯息的类型（ins、del、upd、sel）
Tables处理的table代码
Key1Key1的value
Key2Key2的value
Description额外讯息（讯息代码/讯息字符串）
Action讯息Action代码（未来延伸功能，可不传）
Mark按下〝更多〞按键时显示的讯息
Open是否开窗（0/1）
回传值：
none
用法：
CALLcl_err3（"ins","azb_file",g_azb01,"",SQLCA.sqlcode,"","",0）
函式名称：
cl_err_msg_log
程序名称：
cl_err_msg.4gl
用途：
纪录错误讯息
传入参数：
none
回传值：
none
用法：
WHENEVERERRORCALLcl_err_msg_log
函式名称：
cl_exp
程序名称：
cl_exp.4gl
用途：
询问"此笔资料是否确定无效（Y/N）：
"
或"此笔资料是否恢复有效（Y/N）：
"
（for单文件建文件无效功能）
传入参数：
p_row,p_col
p_old_acticode有效码﹝Y/N﹞
回传值：
1FORTRUE是
0FORFALSE否
用法：
IFcl_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
用法：
CALLcl_export_to_excel
（ui.Interface.getRootNode（）,base.TypeInfo.create（g_pmx）,'',''）
函式名称：
cl_facfor
程序名称：
cl_facfor.4gl
用途：
将INPUTDECLIAM（16,8）数值转为9位字符的格式
若值为12345678,将传回'^12345678'
若值为1234567,将传回'1234567.0'
若值为123456,将传回'123456.00'
若值为12345.67,将传回'12345.670'
若值为1.234567,将传回'1.2345670'
若值为.1234567,将传回'.12345670'
传入参数：
p_fac数值
回传值：
l_strFORMAT后的数值，以CHAR型态RETURN
用法：
LETa=cl_facfor（p_fac）;PRINTa
PRINTcl_facfor（p_fac）
函式名称：
cl_field_format
程序名称：
cl_field_format.4gl
用途：
转换p_per内自由格式设定的format
传入参数：
ps_currencyCHAR（04）﹝当前无用处﹞
pc_frm_nameCHAR（10）画面档名
回传值：
none
用法：
CALLcl_field_format（g_aza.aza17,mc_frm_name）
函式名称：
cl_fld_doc
程序名称：
cl_fld_doc.4gl
用途：
字段的相关档案维护
传入参数：
ps_fieldSTRING字段名称
回传值：
url档案的URL
用法：
CALLcl_fld_doc（"ima01"）
函式名称：
cl_fldhelp
程序名称：
cl_fldhelp.4gl
用途：
显示字段说明
传入参数：
g_frm_name画面档名称
g_fld_name字段名称
g_lang语言别
回传值：
none
用法：
CALLcl_fldhelp（g_frm_name,g_fld_name,g_lang）
函式名称：
cl_flow_notify
程序名称：
cl_flow_notify.4gl
用途：
透过JavaMail传送工作流程通知
传入参数：
ps_doc_noSTRING单据编号
pc_stateCHAR
（1）功能类别
（I.新增U.更改D.删除Y.确认S.过帐V.作废）
回传值：
none
用法：
CALLcl_flow_notify（g_pmw.pmw01,'I'）
函式名称：
cl_forupd_sql
程序名称：
cl_forupd_sql.4gl
用途：
判断SELECT...FORUPDATE是否加上其它语法（by
Database）
传入参数：
ps_forupd_sqlSTRING原传入SQL字符串
回传值：
ps_forupd_sqlSTRING调整过的SQL字符串
用法：
CALLcl_forupd_sql（ps_forupd_sql）
函式名称：
cl_get_column_info
程序名称：
cl_get_column_info.4gl
用途：
取得字段型态及长度
传入参数：
p_tabnameTABLE名称
p_colname字段名称
回传值：
字段型态notnullFORTRUE：
有回传值：
nullFORFALSE：
否
长度notnullFORTRUE：
有回传值：
nullFORFALSE：
否
用法：
CALLcl_get_column_info（p_tabname,p_colname）
RETURNINGl_coldatatype,l_collength
函式名称：
cl_get_feldname
程序名称：
cl_get_feldname.4gl
用途：
依字段代码取出系统字段名称设定维护作业（p_feldname）内的
字段名称
传入参数：
p_gaq01字段代码
p_lang语言别
回传值：
l_gaq03字段说明
用法：
LETg_msg=cl_get_feldname（p_gaq01,p_lang）
函式名称：
cl_get_progdesc
程序名称：
cl_get_progdesc.4gl
用途：
取得程序代码说明（若有客制码='Y'的优先回传）
传入参数：
p_gaz01程序代码
p_lang语言别
回传值：
l_gaz03程序代码说明
用法：
LETg_msg=cl_get_progdesc（g_prog,p_lang）
函式名称：
cl_getmsg
程序名称：
cl_getmsg.4gl
用途：
依讯息代码取出系统错误讯息文件（ze_file）内的错误讯息
传入参数：
p_code讯息代码
p_lang语言别
回传值：
l_msg错误讯息.
用法：
LETg_msg=cl_getmsg（p_code,p_lang）
函式名称：
cl_insert_top_menu
程序名称：
cl_insert_top_menu.4gl
用途：
插入TopMenu
传入参数：
pc_progCHAR（10）程序代号
回传值：
none
用法：
CALLcl_insert_top_menu（NULL）
函式名称：
cl_itemname_by_lang
程序名称：
cl_itemname_by_lang.4gl
用途：
多语言记录功能查询
升级会员 