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 43**起始版本：** 3.2 44 45**参数:** 46 47| 名称 | 描述 | 48| -------- | -------- | 49| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 | 50| templateIdList | 指定要认证的模版ID列表。 | 51| extraInfo | 其他相关信息，用于支持信息扩展。 | 52| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback_fingerauth_v10.md)。 | 53 54**返回：** 55 560 表示操作成功。 57 58非0 表示操作失败。 59 60 61### Cancel() 62 63``` 64IExecutor::Cancel ([in] unsigned long scheduleId) 65``` 66**描述** 67 68取消操作请求。 69 70**起始版本：** 3.2 71 72**参数:** 73 74| 名称 | 描述 | 75| -------- | -------- | 76| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 | 77 78**返回：** 79 800 表示操作成功。 81 82非0 表示操作失败。 83 84 85### Delete() 86 87``` 88IExecutor::Delete ([in] unsigned long[] templateIdList) 89``` 90**描述** 91 92删除指纹特征模版。 93 94**起始版本：** 3.2 95 96**参数:** 97 98| 名称 | 描述 | 99| -------- | -------- | 100| templateIdList | 指定要删除的模版ID列表。 | 101 102**返回：** 103 1040 表示操作成功。 105 106非0 表示操作失败。 107 108 109### Enroll() 110 111``` 112IExecutor::Enroll ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj ) 113``` 114**描述** 115 116注册指纹特征模版。 117 118**参数:** 119 120| 名称 | 描述 | 121| -------- | -------- | 122| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 | 123| extraInfo | 其他相关信息，用于支持信息扩展。 | 124| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback_fingerauth_v10.md)。 | 125 126**返回：** 127 1280 表示操作成功。 129 130非0 表示操作失败。 131 132 133### GetExecutorInfo() 134 135``` 136IExecutor::GetExecutorInfo ([out] struct ExecutorInfo executorInfo) 137``` 138**描述** 139 140获取执行器信息。 141 142**参数:** 143 144| 名称 | 描述 | 145| -------- | -------- | 146| executorInfo | 执行器信息[ExecutorInfo](_executor_info_fingerauth_v10.md)。 | 147 148**返回：** 149 1500 表示操作成功。 151 152非0 表示操作失败。 153 154 155### GetTemplateInfo() 156 157``` 158IExecutor::GetTemplateInfo ([in] unsigned long templateId, [out] struct TemplateInfo templateInfo ) 159``` 160**描述** 161 162获取凭据模板信息。 163 164**起始版本：** 3.2 165 166**参数:** 167 168| 名称 | 描述 | 169| -------- | -------- | 170| templateId | 凭据模板ID。 | 171| templateInfo | 凭据模板信息[TemplateInfo](_template_info_fingerauth_v10.md)。 | 172 173**返回：** 174 1750 表示操作成功。 176 177非0 表示操作失败。 178 179 180### Identify() 181 182``` 183IExecutor::Identify ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj ) 184``` 185**描述** 186 187指纹识别。 188 189**起始版本：** 3.2 190 191**参数:** 192 193| 名称 | 描述 | 194| -------- | -------- | 195| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 | 196| extraInfo | 其他相关信息，用于支持信息扩展。 | 197| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback_fingerauth_v10.md)。 | 198 199**返回：** 200 2010 表示操作成功。 202 203非0 表示操作失败。 204 205 206### OnRegisterFinish() 207 208``` 209IExecutor::OnRegisterFinish ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo ) 210``` 211**描述** 212 213完成执行器注册，对指纹特征模版进行对账，用于删除无效的指纹特征模板及相关信息。 214 215**参数:** 216 217| 名称 | 描述 | 218| -------- | -------- | 219| templateIdList | 用户认证框架内由该执行器注册的指纹特征模版ID列表。 | 220| frameworkPublicKey | 用户认证框架的公钥，用于校验用户认证框架私钥签名的信息。 | 221| extraInfo | 其他相关信息，用于支持信息扩展。 | 222 223**返回：** 224 2250 表示操作成功。 226 227非0 表示操作失败。 228 229 230### SendCommand() 231 232``` 233IExecutor::SendCommand ([in] int commandId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj ) 234``` 235**描述** 236 237发送指纹认证功能相关操作命令。 238 239**起始版本：** 3.2 240 241**参数:** 242 243| 名称 | 描述 | 244| -------- | -------- | 245| commandId | 操作命令ID[CommandId](_hdf_fingerprint_auth_v10.md#commandid)。 | 246| extraInfo | 其他相关信息，用于支持信息扩展。 | 247| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback_fingerauth_v10.md)。 | 248 249**返回：** 250 2510 表示操作成功。 252 253非0 表示操作失败。 254