Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
en:user_management_api [2022/10/05 15:46] sungjun [BS2User] |
en:user_management_api [2024/05/28 17:11] kkshin |
||
|---|---|---|---|
| Line 23: | Line 23: | ||
| * [[BS2_GetUserSmallDatas]]: [+ 2.6.3] Gets selected data of user with efficient use of memory. | * [[BS2_GetUserSmallDatas]]: [+ 2.6.3] Gets selected data of user with efficient use of memory. | ||
| * [[BS2_GetUserSmallDatasEx]]: [+ 2.6.3] Gets selected data of user with efficient use of memory. | * [[BS2_GetUserSmallDatasEx]]: [+ 2.6.3] Gets selected data of user with efficient use of memory. | ||
| - | * [[BS2_EnrollUserFaceEx]]: [+ 2.7.1] ''FaceStation F2'' Enrolls new user. | + | * [[BS2_EnrollUserFaceEx]]: [+ 2.7.1] ''Visual Face Support'' Enrolls new user. |
| - | * [[BS2_GetUserInfosFaceEx]]: [+ 2.7.1] ''FaceStation F2'' Gets the user information of the given user ID. | + | * [[BS2_GetUserInfosFaceEx]]: [+ 2.7.1] ''Visual Face Support'' Gets the user information of the given user ID. |
| - | * [[BS2_GetUserDatasFaceEx]]: [+ 2.7.1] ''FaceStation F2'' Gets selected data of user. | + | * [[BS2_GetUserDatasFaceEx]]: [+ 2.7.1] ''Visual Face Support'' Gets selected data of user. |
| + | * [[BS2_PartialUpdateUser]]: [+ 2.8.3] Updates partial information of an already registered user. | ||
| + | * [[BS2_PartialUpdateUserEx]]: [+ 2.8.3] Updates partial information of an already registered user. (including Job code and User phrase) | ||
| + | * [[BS2_PartialUpdateUserSmall]]: [+ 2.8.3] Updates partial information of an already registered user with efficient use of memory. | ||
| + | * [[BS2_PartialUpdateUserSmallEx]]: [+ 2.8.3] Updates partial information of an already registered user with efficient use of memory. | ||
| + | * [[BS2_PartialUpdateUserFaceEx]]: [+ 2.8.3] ''Visual Face Support'' Updates partial information of an already registered user. | ||
| + | * [[BS2_GetUserStatistic]]: [+ 2.8.3] Gets the user-related statistics that the device has. | ||
| Line 72: | Line 78: | ||
| **8. //infoMask//** \\ | **8. //infoMask//** \\ | ||
| [+ 2.8.3] This indicates what information the user has. By changing the information at infoMask and sending the information to change to the device, it is possible to partially change the selected user’s information. \\ | [+ 2.8.3] This indicates what information the user has. By changing the information at infoMask and sending the information to change to the device, it is possible to partially change the selected user’s information. \\ | ||
| - | At this moment, Partial update families of functions([[BS2_PartialUpdateUser]], [[BS2_PartialUpdateUserEx]], [[BS2_PartialUpdateUserSmall]], [[BS2_PartialUpdateUserSmallEx]], [[BS2_PartialUpdateUserFaceEx]]) and user mask argument must match (refer to the table below). \\ | + | At this moment, Partial Update families of functions([[BS2_PartialUpdateUser]], [[BS2_PartialUpdateUserEx]], [[BS2_PartialUpdateUserSmall]], [[BS2_PartialUpdateUserSmallEx]], [[BS2_PartialUpdateUserFaceEx]]) and user mask argument must match (refer to the table below). \\ |
| <WRAP group 50%> | <WRAP group 50%> | ||
| Line 85: | Line 91: | ||
| |0x80 |BS2_USER_INFO_MASK_FACE | | |0x80 |BS2_USER_INFO_MASK_FACE | | ||
| </WRAP> | </WRAP> | ||
| - | **''Acquiring user information''** \\ | + | **''Get user information''** \\ |
| - | The infoMask indicates what information is assigned to the current user when acquiring the user information. \\ \\ | + | The infoMask indicates what information is allocated to the current user when getting the user information. \\ \\ |
| <WRAP group 50%> | <WRAP group 50%> | ||
| ^User information ^BS2_USER_MASK ^infoMask ^ | ^User information ^BS2_USER_MASK ^infoMask ^ | ||
| Line 94: | Line 100: | ||
| </WRAP> | </WRAP> | ||
| **''Partial removal of user information''** \\ | **''Partial removal of user information''** \\ | ||
| - | Choose unmasking for the information to be removed at all sections (infoMask, partial update families of functions, and user mask agreements). \\ \\ | + | Choose unmasking for the information to be removed at all sections (infoMask, Partial Update families of functions, and user mask agreements). \\ \\ |
| **''Partial edit of user information''** \\ | **''Partial edit of user information''** \\ | ||
| - | Choose masking for the information to be edited at all sections (infoMask, partial update families of functions, and user mask agreements). \\ \\ \\ \\ | + | Choose masking for the information to be edited at all sections (infoMask, Partial Update families of functions, and user mask agreements). \\ \\ |
| **''Default setting of user information''** \\ | **''Default setting of user information''** \\ | ||
| - | Choose masking for infoMask and unmasking for partial update familes of functions and user mask agreements. \\ \\ | + | Choose masking for infoMask and unmasking for Partial Update familes of functions and user mask agreements. \\ \\ |
| **''Changing credential information (Card/Fingerprint/Face)''** \\ | **''Changing credential information (Card/Fingerprint/Face)''** \\ | ||
| It checks if the credential information is allocated or not such as [numCards, numFingers, or numFaces is 0], [fingerObjs, cardObjs, faceObjs, or faceExObjs is NULL]. Plus, it checks infoMask. \\ | It checks if the credential information is allocated or not such as [numCards, numFingers, or numFaces is 0], [fingerObjs, cardObjs, faceObjs, or faceExObjs is NULL]. Plus, it checks infoMask. \\ | ||
| Line 118: | Line 124: | ||
| <WRAP tip 70%> | <WRAP tip 70%> | ||
| **Tip**\\ | **Tip**\\ | ||
| - | <wrap em>Other than FaceStation F2</wrap> \\ | + | Please use [[user management api#BS2UserSettingEx|BS2UserSettingEx]] to set <wrap em>the personal authentication mode</wrap> of <wrap em>FaceStation F2, BioStation 3</wrap>. |
| - | Please use [[user management api#BS2UserSettingEx|BS2UserSettingEx]] for <wrap em>FaceStation F2</wrap>. | + | |
| </WRAP> | </WRAP> | ||
| <code cpp> | <code cpp> | ||
| Line 291: | Line 296: | ||
| |FaceStation F2 |V1.0.0 or higher | | |FaceStation F2 |V1.0.0 or higher | | ||
| |X-Station 2 |V1.0.0 or higher | | |X-Station 2 |V1.0.0 or higher | | ||
| + | |BioStation 3 |V1.0.0 or higher | | ||
| </WRAP> | </WRAP> | ||
| **11. //accessGroupId//** \\ | **11. //accessGroupId//** \\ | ||
| Line 381: | Line 387: | ||
| <WRAP tip 70%> | <WRAP tip 70%> | ||
| **Tip**\\ | **Tip**\\ | ||
| - | <wrap em>FaceStation F2 Only</wrap> \\ | + | Please use [[user management api#BS2UserSetting|BS2UserSetting]] to set <wrap em>the personal authentication mode</wrap> for devices other than <wrap em>FaceStation F2 and BioStation 3</wrap>. |
| - | Please use [[user management api#BS2UserSetting|BS2UserSetting]] <wrap em>other than</wrap> FaceStation F2. | + | |
| </WRAP> | </WRAP> | ||
| <code cpp> | <code cpp> | ||