1# IExecutorCallback
2
3
4## 概述
5
6定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。
7
8**起始版本：** 3.2
9
10**相关模块：**[HdfPinAuth](_hdf_pin_auth_v20.md)
11
12
13## 汇总
14
15
16### Public 成员函数
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [OnResult](#onresult) ([in] int result, [in] unsigned char[] extraInfo) | 回调函数，返回认证结果。 |
21| [OnTip](#ontip) ([in] int tip, [in] unsigned char[] extraInfo) | 返回操作的过程提示信息。 |
22| [OnGetData](#ongetdata) ([in] unsigned char[] algoParameter, [in] unsigned long authSubType, [in] unsigned int algoVersion, [in] unsigned char[] challenge) | 定义请求获取口令数据回调函数。 |
23| [OnMessage](#onmessage) ([in] int destRole, [in] unsigned char[] msg) | 返回操作的过程交互消息。 |
24
25
26## 成员函数说明
27
28
29### OnGetData()
30
31```
32IExecutorCallback::OnGetData ([in] unsigned char[] algoParameter, [in] unsigned long authSubType, [in] unsigned int algoVersion, [in] unsigned char[] challenge )
33```
34
35**描述**
36
37定义请求获取口令数据回调函数。
38
39**起始版本：** 3.2
40
41**参数:**
42
43| 名称 | 描述 |
44| -------- | -------- |
45| algoParameter | 算法相关参数。 |
46| authSubType | 口令子类型，如六位数字PIN码等[PinAuthTypes](_pin_auth_types_8idl_v20.md)。 |
47| algoVersion | 算法版本。 |
48| challenge | 用于防重放。 |
49
50**返回：**
51
520 表示操作成功。
53
54非0 表示操作失败。
55
56
57### OnMessage()
58
59```
60IExecutorCallback::OnMessage ([in] int destRole, [in] unsigned char[] msg )
61```
62
63**描述**
64
65返回操作的过程交互消息。
66
67**起始版本：** 5.0
68
69**参数:**
70
71| 名称 | 描述 |
72| -------- | -------- |
73| destRole | 目标执行器角色[ExecutorRole](_hdf_pin_auth_v20.md#executorrole)。 |
74| msg | 消息。 |
75
76**返回：**
77
780 表示操作成功。
79
80非0 表示操作失败。
81
82
83### OnResult()
84
85```
86IExecutorCallback::OnResult ([in] int result, [in] unsigned char[] extraInfo )
87```
88
89**描述**
90
91回调函数，返回认证结果。
92
93**起始版本：** 3.2
94
95**参数:**
96
97| 名称 | 描述 |
98| -------- | -------- |
99| result | 操作请求处理结果。 |
100| extraInfo | 其他相关信息，如用户认证通过时用于返回执行器签发的认证令牌等。 |
101
102**返回：**
103
1040 表示操作成功。
105
106非0 表示操作失败。
107
108
109### OnTip()
110
111```
112IExecutorCallback::OnTip ([in] int tip, [in] unsigned char[] extraInfo )
113```
114
115**描述**
116
117返回操作的过程提示信息。
118
119**起始版本：** 5.0
120
121**参数:**
122
123| 名称 | 描述 |
124| -------- | -------- |
125| tip | 提示码。 |
126| extraInfo | 其他相关信息。 |
127
128**返回：**
129
1300 表示操作成功。
131
132非0 表示操作失败。
133