This is an old revision of the document!

FIXME This page is not fully translated, yet. Please help completing the translation.
(remove this paragraph once the translation is finished)

User Management API > BS2_GetSupportedUserMask

BS2_GetSupportedUserMask

[+ 2.5.0] Gets user settings supported by the device.
This information can be different by device type.

Declaration

#include "BS_API.h"
 
int BS2_GetSupportedUserMask(void* context, uint32_t deviceId, BS2_USER_MASK* userMask);

Parameter

  • [In] context : Context
  • [In] deviceId : Device ID
  • [Out] userMask : User mask
Value Description
0x0004 User name
0x0008 Image
0x0010 PIN
0x0020 Card
0x0040 Fingerprint
0x0080 Face
0x0200 Jobcode
0x0400 Phrase
0xFFFF All information

Return Value

If successfully done, BS_SDK_SUCCESS will be returned. If there is an error, the corresponding error code will be returned.