WOSAXFS 310 中文版 09.docx
《WOSAXFS 310 中文版 09.docx》由会员分享，可在线阅读，更多相关《WOSAXFS 310 中文版 09.docx（73页珍藏版）》请在冰豆网上搜索。
WOSAXFS310中文版09
欧洲标准化委员会
专题协定
CWA15748-9
2008年7月
ICS35.240.50
中文版
金融服务扩展（XFS）接口说明（3.10版）第九部分：
文本终端单元设备类接口；
程序员参考
此欧洲标准化委员会专题协定（CWA）由相关方代表专题研究组起草并通过，该专题研究组的与会成员在本协定前言部分中列出。
该专题研究组编制本协定的正式会程已经欧洲标准化委员会的各会员国背书，但欧洲标准化委员会的各会员国和欧洲标准化委员会管理中心均不对本CWA的技术性内容或与其他标准或法规可能存在的矛盾负责。
不得以任何形式将本CWA视作由欧洲标准化委员会及其成员编制的正式标准。
本CWA可以公开用作欧洲标准化委员会的会员国标准化组织的参考文件。
欧洲标准化委员会的成员包括下列国家的国家标准化组织：
奥地利、比利时、保加利亚、塞浦路斯、捷克共和国、丹麦、爱沙尼亚、芬兰、法国、德国、希腊、匈牙利、冰岛、爱尔兰、意大利、拉脱维亚、立陶宛、卢森堡、马尔他、荷兰、挪威、波兰、葡萄牙、罗马尼亚、斯洛伐克、斯洛文尼亚、西班牙、瑞典、瑞士、和英国。
欧洲标准化委员会
COMITÉEUROPÉENDENORMALISATION
EUROPÄISCHESKOMITEEFÜRNORMUNG
管理中心地址：
布鲁塞尔斯达沙特街36B-1050（ruedeStassart,36B-1050Brussels）
版权所有©2008欧洲标准化委员会，为欧洲标准化委员会会员国在全球范围内保留以任何形式和方法进行利用的所有权利。
参考号：
CWA15748-9:
2008D/E/F
目录
前言4
1.绪论7
1.1颁布3.10版本的背景7
1.2XFS服务专用程序7
2.文本终端设备8
3.参考资料9
4.信息命令10
4.1WFS_INF_TTU_STATUS10
4.2WFS_INF_TTU_CAPABILITIES12
4.3WFS_INF_TTU_FORM_LIST14
4.4WFS_INF_TTU_QUERY_FORM15
4.5WFS_INF_TTU_QUERY_FIELD16
4.6WFS_INF_TTU_KEY_DETAIL18
5.信息命令20
5.1WFS_CMD_TTU_BEEP20
5.2WFS_CMD_TTU_CLEARSCREEN21
5.3WFS_CMD_TTU_DISPLIGHT22
5.4WFS_CMD_TTU_SET_LED23
5.5WFS_CMD_TTU_SET_RESOLUTION24
5.6WFS_CMD_TTU_WRITE_FORM25
5.7WFS_CMD_TTU_READ_FORM26
5.8WFS_CMD_TTU_WRITE28
5.9WFS_CMD_TTU_READ30
5.10WFS_CMD_TTU_RESET33
5.11WFS_CMD_TTU_DEFINE_KEYS34
5.12WFS_CMD_TTU_POWER_SAVE_CONTROL36
6.事件37
6.1WFS_EXEE_TTU_FIELDERROR37
6.2WFS_EXEE_TTU_FIELDWARNING38
6.3WFS_EXEE_TTU_KEY39
6.4WFS_SRVE_TTU_DEVICEPOSITION40
6.5WFS_SRVE_TTU_POWER_SAVE_CHANGE41
7.表格和域定义42
7.1语法定义42
7.2XFS表格/媒介在多厂商环境下的定义文件43
7.3表格定义①44
7.4域定义②45
8.C-头文件47
前言
本CWA是XFS接口说明的3.10版。
欧洲标准化委员会/信息系统标准化委员会（CEN/ISSS）XFS专题研究组召集了供应商、银行和其他金融服务公司参与研讨。
可以从CEN/ISSS秘书处获得参与该专题研究组并给予本CWA支持的公司名录。
本CWA于2007年11月29日经XFS专题研究组正式批准通过。
欧洲标准化委员会/信息系统标准化委员会（CEN/ISSS）XFS专题研究组将持续对该规范进行评审和提出意见。
因此，以后还会适时发行此CWA规范的修订版本，更新版本将取代本3.10版。
发行的CWA由以下多个部分组成：
第1部分：
应用程序编程接口（API）–服务提供程序接口（SPI）–程序员参考
第2部分：
服务分类说明–程序员参考
第3部分：
打印机和扫描仪设备类接口–程序员参考
第4部分：
身份证件识别设备类接口–程序员参考
第5部分：
现金取款设备类接口–程序员参考
第6部分：
PIN键盘设备类接口–程序员参考
第7部分：
支票读取器/扫描设备类接口–程序员参考
第8部分：
存放设备类接口–程序员参考
第9部分：
文本终端单元设备类接口–程序员参考
第10部分：
传感器和指示器单元设备类接口–程序员参考
第11部分：
由供应商依赖模式设备类接口–程序员参考
第12部分：
摄像头设备类接口–程序员参考
第13部分：
报警设备类接口–程序员参考
第14部分：
信用卡凸字识别单元设备类接口–程序员参考
第15部分：
现金存入设备类接口–程序员参考
第16部分：
发卡机设备类接口–程序员参考
第17部分：
条形码读取设备类接口–程序员参考
第18部分：
物品处理单元设备类接口–程序员参考
第19部分到第28部分：
保留将来备用。
第29部分到第47部分是对本CWA的可选补充内容。
这些部分定义了SNMP标准和服务提供程序输出统计信息的状态设置的整合。
第29部分：
XFSMIB结构和SNMP扩展–程序员参考
第30部分：
XFSMIB设备专用定义–打印机类
第31部分：
XFSMIB设备专用定义–ID卡设备类
第32部分：
XFSMIB设备专用定义–现金取款设备类
第33部分：
XFSMIB设备专用定义–PIN键盘设备类
第34部分：
XFSMIB设备专用定义–支票读取器/扫描设备类
第35部分：
XFSMIB设备专用定义–存放设备类
第36部分：
XFSMIB设备专用定义–文本终端单元设备类
第37部分：
XFSMIB设备专用定义–传感器和指示器单元设备类
第38部分：
XFSMIB设备专用定义–摄像头设备类
第39部分：
XFSMIB设备专用定义–报警设备类
第40部分：
XFSMIB设备专用定义–信用卡凸字识别系统类
第41部分：
XFSMIB设备专用定义–现金存入设备类
第42部分：
保留将来备用。
第43部分：
XFSMIB设备专用定义–供应商依赖模式设备类
第44部分：
XFSMIB应用管理
第45部分：
XFSMIB设备专用定义–发卡机设备类
第46部分：
XFSMIB设备专用定义–条形码读取设备类
第47部分：
XFSMIB设备专用定义–物品处理单元设备类
第48部分到第60部分保留将来备用。
第61部分：
应用程序编程接口（API）–服务提供程序接口（SPI）–3.10版（本CWA）移植3.0版（CWA14050）–程序员参考
第62部分：
打印机设备类接口–3.10版（本CWA）移植3.0版（CWA14050）–程序员参考
第63部分：
身份证识别设备类接口–3.10版（本CWA）移植3.02版（CWA14050）–程序员参考
第64部分：
现金取款设备类接口–3.10版（本CWA）移植3.0版（CWA14050）–程序员参考
第65部分：
PIN键盘设备类接口–3.10版（本CWA）移植3.03版（CWA14050）–程序员参考
第66部分：
支票读取器/扫描设备类接口–3.10版（本CWA）移植3.0版（CWA14050）–程序员参考
第67部分：
存款设备类接口–3.10版（本CWA）移植3.0版（CWA14050）–程序员参考
第68部分：
文本终端单元设备类接口–3.10版（本CWA）移植3.0版（CWA14050）–程序员参考
第69部分：
传感器和指示器单元设备类接口–3.10版（本CWA）移植3.01版（CWA14050）–程序员参考
第70部分：
供应商依赖模式设备类接口–3.10版（本CWA）移植3.0版（CWA14050）–程序员参考
第71部分：
摄像头设备类接口–3.10版（本CWA）移植3.0版（CWA14050）–程序员参考
第72部分：
报警设备类接口–3.10版（本CWA）移植3.0版（CWA14050）–程序员参考
第73部分：
信用卡凸字识别设备类接口–3.10版（本CWA）移植3.0版（CWA14050）–程序员参考
第74部分：
现金存入设备类接口–3.10版（本CWA）移植3.02版（CWA14050）–程序员参考
除了上述程序员参考规范外，本CWA的读者还应参考本文的补充性文件——《版本注释》。
《版本注释》包括对CWA规范的解释和说明，而非要求进行功能变更。
可以从http:
//www.cen.eu/isss/Workshop/XFS上找到现行的《版本注释》版本。
该文件中的信息代表该主题研究组截止到发行之日对其所包含的问题的现有见解。
仅供参考，可能对其进行更改，恕不另行通知。
CEN/ISSS不对该文件做任何明示或默示保证。
本CWA可以公开用作欧洲标准化委员会的会员国标准化组织的参考文件：
AENOR、AFNOR、ASRO、BDS、BSI、CSNI、CYS、DIN、DS、ELOT、EVS、IBN、IPQ、IST、LVS、LST、MSA、MSZT、NEN、NSAI、ON、PKN、SEE、SIS、SIST、SFS、SN、SNV、SUTN和UNI。
欢迎用户就CWA提出意见和建议，如有这些意见和建议请联系欧洲标准化委员会管理中心。
修订历史：
1.0
1993年5月24日
API和SPI规范的最初版本
1.11
1995年2月3日
为API/SPI和服务类别定义分别编制单独规范；而且进行了更新。
2.0
1996年11月11日
发行更新版本，其中包括自助服务环境。
3.0
2000年10月18日
详细情况见日期为2000年10月18日的《CWA14050-16API/SPI文件移植2.0版生成3.0版，1.00修订版》。
3.10
2007年11月29日
有关变更详情，请见《CWA15748-61:
2007API/SPI移植3.0版（见CWA14050）生成3.10版》。
1.绪论
1.1颁布3.10版本的背景
CEN/ISSSXFS专题研究组旨在推动规范的制定，以清晰明确地定义财务周边设备的多供应商软件接口。
金融服务扩展（XFS）说明是经欧洲标准化委员会/信息系统标准化委员会（CEN/ISSS）专题研究组环境下编制的。
CEN/ISSS专题研究组旨在就某一事项在欧洲范围内达成一致意见，形成可以发行的欧洲标准化委员会专题协定（CWA）。
CEN/ISSSXFS专题研究组鼓励银行和供应商能够积极参与工业标准的制定。
CEN/ISSSXFS专题研究组通过下设的研究小组以电子方式针对议题进行合作，并且每季度召开一次例会。
3.10版XFS规范的制定以CAPI为基础，坚持以保护现有应用的技术投入为承诺。
一系列因素促成了XFS规范这个版本的发行。
技术的改进要求对现有规范的范围进行扩展，使该规范范围覆盖新设备，如：
条形码读取、发卡机和物品处理单元。
此外，还有通过实施经验和附加要求，带来的对规范现已覆盖的设备功能和能力的扩展压力。
1.2XFS服务专用程序
特殊程序由它们各自的特殊服务命令和相关的数据结构，错误码，信息等构成。
这些特殊命令用来请求特定于一个或多个类别服务驱动的函数，由于不通用于全部的服务驱动，因此不包括在通用的函数或管理API函数中。
当一个特殊服务命令通用于两个或更多服务驱动时，此令的语法在所有的服务中要尽可能类似，因为XFS的一个主要目标是指定各种服务的功能代码和结构。
例如，利用WFSExecute函数，从不同服务所读取的各种数据命令将尽可能的在语意和数据结构上相似。
通常，某一服务类型的特殊命令集被定义为某特殊能力的扩展集，它很可能由该服务类型的研发者提供。
因而任何特定读卡器，通常只支持一种指定命令系列的子集。
在以下三种情况下，服务驱动可能会收到它不支持的特殊服务的命令：
XFS指定书为服务驱动的类别定义了性能要求，然而厂商的特定服务工具却不支持它，而且不受支持的性能未被考虑为此服务的基本性能。
在此种情况中，服务驱动将返回一个成功完成的消息，但实际并不运转。
一个实例便是，应用程序请求开启存折打印机的控制指示灯，服务驱动认可此命令，但由于存折打印机的管理不包括这个指示灯，服务驱动将不运做，并给用程序传回一个成功完成申请的消息。
XFS指定书为服务驱动的类别定义了性能要求，然而厂商的特定服务工具却不支持它，而且不受支持的性能不被考虑为此服务的基本性能。
在此种情况中，服务驱动将返回一个成功完成的消息，但实际并不运转。
一个实例便是，应用程序请求现金取款器分配硬币，服务驱动认可此命令，但由于现金取款器只能管理钞票取款，则将返回此请求为错误。
XFS指定书没有为服务驱动的类别定义性能要求。
在此种情况中，将给发出调用的应用程序传回一个WFS_ERR_INVALID_COMMAND错误代码。
此种设计允许服务能在一定的范围内使用应用程序，为它们的服务类型所定义的函数提供不同的子集。
应用程序能够使用WFSGetInfo和WFSAsyncGetInfo命令来查询它将使用的服务的性能，并相应地对自己的动作做出调整；或者它们可使用函数，然后再对返回的WFS_ERR_UNSUPP_
COMMAND错误代码做出相应处理，从而决定如何使用此服务。
2.文本终端设备
此规范描述XFS下的文本终端单元（TTU）服务所提供的功能，定义了SP可以用WFSGetInfo，WFSAsyncGetInfo，WFSExecute和WFSAsyncExecute函数发出的特殊服务命令。
此部分描述一般的文本终端单元（TTU）服务所提供的功能。
文本终端单元是应用在ATM操作盘和具备显示的设备上的文本输入/输出设备，例如密码键盘和打印机。
此服务允许下列功能类型：
•表格定向输入和输出
•直接显示输出
•键盘输入
•LED设置和控制
所有位置索引基础置为零，列为零，横位零——此为左上位。
如果设备没有shift键，WFS_CMD_TTU_READ_FORM和WFS_CMD_TTU_READ命令将返回仅支持大写。
如果设备有shift键，这些命令将返回用户使用此按键时将可以进行大小写控制。
3.参考资料
1.XFS应用程序接口（API），服务提供接口（SPI），程序员参考3.10版
4.信息命令
4.1WFS_INF_TTU_STATUS
描述：
此命令报告所有范围的有效信息，包括SP提供的信息。
输入参数：
无。
输出参数：
LPWFSTTUSTATUSlpStatus;
typedefstruct_wfs_ttu_status
{
WORDfwDevice;
WORDwKeyboard;
WORDwKeylock;
WORDwLEDs[WFS_TTU_LEDS_MAX];
WORDwDisplaySizeX;
WORDwDisplaySizeY;
LPSTRlpszExtra;
WORDwDevicePosition;
USHORTusPowerSaveRecoveryTime;
}WFSTTUSTATUS,*LPWFSTTUSTATUS;
fwDevice
设置文本终端单元为下列的状态之一：
值
涵义
WFS_TTU_DEVONLINE
设备在线（即通有电源并在运行）
WFS_TTU_DEVOFFLINE
设备离线（管理员按动开关或拉出设备使设备脱机）。
WFS_TTU_DEVPOWEROFF
设备电源关闭或实际上未接通电源。
WFS_TTU_DEVBUSY
设备繁忙，此时无法处理执行命令。
WFS_TTU_DEVNODEVICE
无此设备。
比如，该类型的自助银行不包含这样的设备或内部没有配置这样的设备。
WFS_TTU_DEVHWERROR
由于硬件错误导致设备无法运行。
WFS_TTU_DEVUSERERROR
设备存在，但人为阻止了设备运行。
WFS_TTU_DEVFRAUDATTEMPT
设备正常，但侦测到一个欺骗尝试
wKeyboard
设备文本终端单元中的键盘状态为下列值之一：
值
涵义
WFS_TTU_KBDON
键盘被激活
WFS_TTU_KBDOFF
键盘没有被激活
WFS_TTU_KBDNA
键盘没有激活能力
wKeylock
设备文本终端单元中的键盘锁状态为下列值之一：
值
涵义
WFS_TTU_KBDLOCKON
键盘锁开关被激活
WFS_TTU_KBDLOCKOFF
键盘锁开关没有被激活
WFS_TTU_KBDLOCKNA
键盘锁开关没有激活能力
wLEDs[WFS_TTU_LEDS_MAX]
设置LED的状态。
最大指示灯索引为WFS_TTU_LEDS_MAX。
有效的LED值能被WFS_INF_TTU_CAPABILITIES信息命令恢复。
此数组的所有元素被设置为下列标志中之一：
值
涵义
WFS_TTU_LEDNA
状态不可使用
WFS_TTU_LEDOFF
LED被关闭
WFS_TTU_LEDSLOWFLASH
LED慢闪
WFS_TTU_LEDMEDIUMFLASH
LED中频闪动
WFS_TTU_LEDQUICKFLASH
LED快闪
WFS_TTU_LEDCONTINUOUS
灯持续开启（常亮）
wDisplaySizeX
设置文本终端单元显示的水平大小（能被显示的列数）。
wDisplaySizeY
设置文本终端单元显示的垂直大小（能被显示的行数）。
lpszExtra
指向厂商特有或任何其它扩展信息的一个列表。
返回信息为一系列“键=值”字符串以便SP进行轻松扩展。
每一个字符串都是以空字符NULL结束的，最后一个字符串以两个空字符NULL结束。
一个空列表可通过一个空指针或两个连续的空字符NULL来表示。
wDevicePosition
设置设备的位置。
设备位置值与fwDevice无关，例如，当设备的位置报告为WFS_
TTU_DEVICENOTINPOSITION时，fwDevice可能是被定义的任何值（包括WFS_
TTU_DEVONLINE或WFS_TTU_DEVOFFLINE）。
此参数可能是下列值之一：
值
涵义
WFS_TTU_DEVICEINPOSITION
设备处于正常操作位，或固定无法被移动
WFS_TTU_DEVICENOTINPOSITION
设备被从正常操作位移开
WFS_TTU_DEVICEPOSUNKNOWN
由于硬件错误或其它情况，设备的位置无法确定
WFS_TTU_DEVICEPOSNOTSUPP
物理设备没有侦测位置的能力
usPowerSaveRecoveryTime
设置设备从当前省电模式恢复到正常操作状态所需要的实际秒数。
如果省电模式没有被激活或设备不具备省电模式，此参数值为零。
错误代码：
此命令仅产生定义在[参考一]的一般错误代码。
注释：
应用程序所依赖的参数lpszExtra可能没有设备或与厂商无关。
在此情况，与设备间的通讯将会丢失，当设备被移除时fwDevice将报告WFS_CDM_DEVPOWEROFF。
当通讯意外中断时候将报告WFS_CDM_
DEVHWERROR。
所有其他结果将包含一个基于下列规则的值：
1.报告值未知
2.报告值为一般H/W错误
3.报告值为最后已知值
4.2WFS_INF_TTU_CAPABILITIES
描述：
此命令用于检索文本终端单元的能力。
输入参数：
无。
输出参数：
LPWFSTTUCAPSlpCaps;
typedefstruct_wfs_ttu_caps
{WORDwClass;
WORDfwType;
LPWFSTTURESOLUTION*lppResolutions;
WORDwNumOfLEDs;
BOOLbKeyLock;
BOOLbDisplayLight;
BOOLbCursor;
BOOLbForms;
WORDfwCharSupport;
LPSTRlpszExtra;
BOOLbPowerSaveControl;
}WFSTTUCAPS,*LPWFSTTUCAPS;
wClass
设置逻辑服务类为WFS_SERVICE_CLASS_TTU。
fwType
设置文本终端单元的类型为下列值之一:
值
涵义
WFS_TTU_FIXED
文本终端单元是一个固定设备
WFS_TTU_REMOVABLE
文本终端单元是一个移动设备
lppResolutions
指向一个以NULL结尾的WFSTTURESOLUTION结构指针数组。
设置物理显示设备所支持的分辨率（关于
WFSTTURESOLUTION的定义请参考WFS_CMD_TTU_SET_RESOLUTION命令）。
第一个位置的分辨指示率为
默认分辨率，当SP通过WFS_CMD_TTU_RESET命令初始化或复位时，设备将设置成此分辨率。
wNumOfLEDs
设置文本终端单元的LED的可使用数。
bKeyLock
设置文本终端单元是否具备锁键开关。
可能是FALSE（无效）或TRUE（有效）。
bDisplayLight
设置文本终端单元是否有显示灯可以通过WFS_CMD_TTU_DISPLIGHT命令打开和关闭。
参数值可能是
FALSE（无效）或TRUE（有效）。
bCursor
设置文本终端单元显示是否支持光标。
可能是FALSE（无效）或TRUE（有效）。
bForms
设置文本终端单元服务是否支持表格定向输入和输出。
可能是FALSE（无效）或TRUE（有效）。
fwCharSupport
设置字符的一个或多个标志，除此之外使用单字节的ASCII，被SP支持：
值
涵义
WFS_TTU_ASCII
ASCII被XFS表格所支持
WFS_TTU_UNICODE
UNICODE被XFS表格所支持
对于fwCharSupport，SP仅支持ASCII或ASCII和UNICODE的表格。
SP在没有ASCII表格的情况下
不支持UNICODE表格。
lpszExt
升级会员 