Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
en:use_exported_control_api [2017/09/05 14:50] 127.0.0.1 external edit |
en:use_exported_control_api [2022/04/25 09:06] kkshin |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Usb Exported Control API ====== | + | ====== USB Exported Control API ====== |
- | This API allows to control/manage Usb Exported. \\ | + | This API allows to control/manage USB Exported. \\ |
- | * [[BS2_GetUserListFromDir]]: Gets the enrolled user ID list from storage path in device. | + | * [[BS2_AllocateUsbContext]]: ''[Depredated]''Allocates context which manages & controls USB device. |
- | * [[BS2_GetUserInfosFromDir]]: Gets the user information of the given user ID from storage path in device. | + | * [[BS2_ReleaseUsbContext]]: ''[Depredated]''Releases context which manages & controls USB device. |
- | * [[BS2_GetUserInfosExFromDir]]: Gets the user information of the given user ID from storage path in device. (Including Job, phrase after v2.4) | + | * [[BS2_GetUserDatabaseInfoFromDir]]: Gets total user information(Number of user/card/fingerprint/face) from USB exported data. |
- | * [[BS2_GetLogFromDir]]: Gets certain amount of logs from storage path in device. | + | * [[BS2_GetUserListFromDir]]: Gets the enrolled user ID list from USB exported data. |
- | * [[BS2_GetLogBlobFromDir]]: Gets certain amount of logs based on the event mask from storage path in device. | + | * [[BS2_GetUserInfosFromDir]]: Gets the user information of the given user ID from USB exported data. |
- | * [[BS2_GetFilteredLogFromDir]]: Gets filtered logs from storage path in device. | + | * [[BS2_GetUserDatasFromDir]]: Gets the user information of the given user ID & usermask from USB exported data. |
+ | * [[BS2_GetUserInfosExFromDir]]: Gets the user information of the given user ID from USB exported data. (Including Job, phrase) | ||
+ | * [[BS2_GetUserDatasExFromDir]]: Gets the user information of the given user ID & usermask from USB exported data. (Including Job, phrase) | ||
+ | * [[BS2_GetUserSmallInfosFromDir]]: [+ 2.6.3] Gets the user information of the given user ID from USB exported data. | ||
+ | * [[BS2_GetUserSmallDatasFromDir]]: [+ 2.6.3] Gets the user information of the given user ID & usermask from USB exported data. | ||
+ | * [[BS2_GetUserSmallInfosExFromDir]]: [+ 2.6.3] Gets the user information of the given user ID from USB exported data. (Including Job, phrase) | ||
+ | * [[BS2_GetUserSmallDatasExFromDir]]: [+ 2.6.3] Gets the user information of the given user ID & usermask from USB exported data. (Including Job, phrase) | ||
+ | * [[BS2_GetLogFromDir]]: Gets certain amount of logs from USB exported data. | ||
+ | * [[BS2_GetLogBlobFromDir]]: Gets certain amount of logs based on the event mask from USB exported data. | ||
+ | * [[BS2_GetFilteredLogFromDir]]: Gets filtered logs from USB exported data. | ||
+ | * [[BS2_GetLogSmallBlobFromDir]]: [+ 2.6.4] Gets certain amount of logs based on the event mask from USB exported data in an efficient way. | ||
+ | * [[BS2_GetLogSmallBlobExFromDir]]: [+ 2.7.1] Gets certain amount of logs including temperature information based on the event mask from USB exported data in an efficient way. | ||
+ | * [[BS2_GetUserInfosFaceExFromDir]]: [+2.7.1] Gets the user information of the given user ID from USB exported data. | ||
+ | * [[BS2_GetUserDatasFaceExFromDir]]: [+2.7.1] Gets the user information of the given user ID & usermask from USB exported data. | ||
+ | |||
+ | [+2.8.2] API for managing USB Exported. \\ | ||
+ | Key user-related sensitive information is stored encrypted with predefined key values within the device. | ||
+ | If you have changed the user information encryption key of the device using the [[BS2_SetDataEncryptKey]] function, you must pass the value of the key to use the USB-related API. | ||
+ | |||
+ | * [[BS2_GetUserDatabaseInfoFromDirWithKey]]: [+2.8.2] Gets total user information(Number of user/card/fingerprint/face) from USB exported data. | ||
+ | * [[BS2_GetUserListFromDirWithKey]]: [+2.8.2] Gets the enrolled user ID list from USB exported data. | ||
+ | * [[BS2_GetUserInfosFromDirWithKey]]: [+2.8.2] Gets the user information of the given user ID from USB exported data. | ||
+ | * [[BS2_GetUserDatasFromDirWithKey]]: [+2.8.2] Gets the user information of the given user ID & usermask from USB exported data. | ||
+ | * [[BS2_GetUserInfosExFromDirWithKey]]: [+2.8.2] Gets the user information of the given user ID from USB exported data. (Including Job, phrase) | ||
+ | * [[BS2_GetUserDatasExFromDirWithKey]]: [+2.8.2] Gets the user information of the given user ID & usermask from USB exported data. (Including Job, phrase) | ||
+ | * [[BS2_GetUserSmallInfosFromDirWithKey]]: [+2.8.2] Gets the user information of the given user ID from USB exported data. | ||
+ | * [[BS2_GetUserSmallDatasFromDirWithKey]]: [+2.8.2] Gets the user information of the given user ID & usermask from USB exported data. | ||
+ | * [[BS2_GetUserSmallInfosExFromDirWithKey]]: [+2.8.2] Gets the user information of the given user ID from USB exported data. (Including Job, phrase) | ||
+ | * [[BS2_GetUserSmallDatasExFromDirWithKey]]: [+2.8.2] Gets the user information of the given user ID & usermask from USB exported data. (Including Job, phrase) | ||
+ | * [[BS2_GetLogFromDirWithKey]]: [+2.8.2] Gets certain amount of logs from USB exported data. | ||
+ | * [[BS2_GetLogBlobFromDirWithKey]]: [+2.8.2] Gets certain amount of logs based on the event mask from USB exported data. | ||
+ | * [[BS2_GetFilteredLogFromDirWithKey]]: [+2.8.2] Gets filtered logs from USB exported data. | ||
+ | * [[BS2_GetLogSmallBlobFromDirWithKey]]: [+2.8.2] Gets certain amount of logs based on the event mask from USB exported data in an efficient way. | ||
+ | * [[BS2_GetLogSmallBlobExFromDirWithKey]]: [+2.8.2] Gets certain amount of logs including temperature information based on the event mask from USB exported data in an efficient way. | ||
+ | * [[BS2_GetUserInfosFaceExFromDirWithKey]]: [+2.8.2] Gets the user information of the given user ID from USB exported data. | ||
+ | * [[BS2_GetUserDatasFaceExFromDirWithKey]]: [+2.8.2] Gets the user information of the given user ID & usermask from USB exported data. |