1# IExecutor 2 3 4## 概述 5 6定义执行器接口，用于获取执行器，获取凭据模版信息，注册指纹特征模版，进行用户指纹认证，删除指纹特征模版等。 7 8**起始版本：** 3.2 9 10**相关模块：**[HdfFingerprintAuth](_hdf_fingerprint_auth_v10.md) 11 12 13## 汇总 14 15 16### Public 成员函数 17 18| 名称 | 描述 | 19| -------- | -------- | 20| [GetExecutorInfo](#getexecutorinfo) ([out] struct [ExecutorInfo](_executor_info_fingerauth_v10.md) executorInfo) | 获取执行器信息。 | 21| [GetTemplateInfo](#gettemplateinfo) ([in] unsigned long templateId, [out] struct [TemplateInfo](_template_info_fingerauth_v10.md) templateInfo) | 获取凭据模板信息。 | 22| [OnRegisterFinish](#onregisterfinish) ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo) | 完成执行器注册，对指纹特征模版进行对账，用于删除无效的指纹特征模板及相关信息。 | 23| [Enroll](#enroll) ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_i_executor_callback_fingerauth_v10.md) callbackObj) | 注册指纹特征模版。 | 24| [Authenticate](#authenticate) ([in] unsigned long scheduleId, [in] unsigned long[] templateIdList, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_i_executor_callback_fingerauth_v10.md) callbackObj) | 指纹认证。 | 25| [Identify](#identify) ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_i_executor_callback_fingerauth_v10.md) callbackObj) | 指纹识别。 | 26| [Delete](#delete) ([in] unsigned long[] templateIdList) | 删除指纹特征模版。 | 27| [Cancel](#cancel) ([in] unsigned long scheduleId) | 取消操作请求。 | 28| [SendCommand](#sendcommand) ([in] int commandId, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_i_executor_callback_fingerauth_v10.md) callbackObj) | 发送指纹认证功能相关操作命令。 | 29 30 31## 成员函数说明 32 33 34### Authenticate() 35 36``` 37IExecutor::Authenticate ([in] unsigned long scheduleId, [in] unsigned long[] templateIdList, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj ) 38``` 39**描述** 40指纹认证。 41 42**起始版本：** 3.2 43 44**参数:** 45 46| 名称 | 描述 | 47| -------- | -------- | 48| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 | 49| templateIdList | 指定要认证的模版ID列表。 | 50| extraInfo | 其他相关信息，用于支持信息扩展。 | 51| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback_fingerauth_v10.md)。 | 52 53**返回：** 54 550 表示操作成功。 56 57非0 表示操作失败。 58 59 60### Cancel() 61 62``` 63IExecutor::Cancel ([in] unsigned long scheduleId) 64``` 65**描述** 66取消操作请求。 67 68**起始版本：** 3.2 69 70**参数:** 71 72| 名称 | 描述 | 73| -------- | -------- | 74| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 | 75 76**返回：** 77 780 表示操作成功。 79 80非0 表示操作失败。 81 82 83### Delete() 84 85``` 86IExecutor::Delete ([in] unsigned long[] templateIdList) 87``` 88**描述** 89删除指纹特征模版。 90 91**起始版本：** 3.2 92 93**参数:** 94 95| 名称 | 描述 | 96| -------- | -------- | 97| templateIdList | 指定要删除的模版ID列表。 | 98 99**返回：** 100 1010 表示操作成功。 102 103非0 表示操作失败。 104 105 106### Enroll() 107 108``` 109IExecutor::Enroll ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj ) 110``` 111**描述** 112注册指纹特征模版。 113 114**参数:** 115 116| 名称 | 描述 | 117| -------- | -------- | 118| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 | 119| extraInfo | 其他相关信息，用于支持信息扩展。 | 120| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback_fingerauth_v10.md)。 | 121 122**返回：** 123 1240 表示操作成功。 125 126非0 表示操作失败。 127 128 129### GetExecutorInfo() 130 131``` 132IExecutor::GetExecutorInfo ([out] struct ExecutorInfo executorInfo) 133``` 134**描述** 135获取执行器信息。 136 137**参数:** 138 139| 名称 | 描述 | 140| -------- | -------- | 141| executorInfo | 执行器信息[ExecutorInfo](_executor_info_fingerauth_v10.md)。 | 142 143**返回：** 144 1450 表示操作成功。 146 147非0 表示操作失败。 148 149 150### GetTemplateInfo() 151 152``` 153IExecutor::GetTemplateInfo ([in] unsigned long templateId, [out] struct TemplateInfo templateInfo ) 154``` 155**描述** 156获取凭据模板信息。 157 158**起始版本：** 3.2 159 160**参数:** 161 162| 名称 | 描述 | 163| -------- | -------- | 164| templateId | 凭据模板ID。 | 165| templateInfo | 凭据模板信息[TemplateInfo](_template_info_fingerauth_v10.md)。 | 166 167**返回：** 168 1690 表示操作成功。 170 171非0 表示操作失败。 172 173 174### Identify() 175 176``` 177IExecutor::Identify ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj ) 178``` 179**描述** 180指纹识别。 181 182**起始版本：** 3.2 183 184**参数:** 185 186| 名称 | 描述 | 187| -------- | -------- | 188| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 | 189| extraInfo | 其他相关信息，用于支持信息扩展。 | 190| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback_fingerauth_v10.md)。 | 191 192**返回：** 193 1940 表示操作成功。 195 196非0 表示操作失败。 197 198 199### OnRegisterFinish() 200 201``` 202IExecutor::OnRegisterFinish ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo ) 203``` 204**描述** 205完成执行器注册，对指纹特征模版进行对账，用于删除无效的指纹特征模板及相关信息。 206 207**参数:** 208 209| 名称 | 描述 | 210| -------- | -------- | 211| templateIdList | 用户认证框架内由该执行器注册的指纹特征模版ID列表。 | 212| frameworkPublicKey | 用户认证框架的公钥，用于校验用户认证框架私钥签名的信息。 | 213| extraInfo | 其他相关信息，用于支持信息扩展。 | 214 215**返回：** 216 2170 表示操作成功。 218 219非0 表示操作失败。 220 221 222### SendCommand() 223 224``` 225IExecutor::SendCommand ([in] int commandId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj ) 226``` 227**描述** 228发送指纹认证功能相关操作命令。 229 230**起始版本：** 3.2 231 232**参数:** 233 234| 名称 | 描述 | 235| -------- | -------- | 236| commandId | 操作命令ID[CommandId](_hdf_fingerprint_auth_v10.md#commandid)。 | 237| extraInfo | 其他相关信息，用于支持信息扩展。 | 238| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback_fingerauth_v10.md)。 | 239 240**返回：** 241 2420 表示操作成功。 243 244非0 表示操作失败。 245