Copyright 2013 by Suprema Inc.

BioStar SDK Reference Manual

Rev. 1.62

Copyright 2013 by Suprema Inc.

Revision History Rev

No.

Issued

date

Description

1.0 2008

Nov. 4

Initial Release.

1.1 2008

Dec. 3

Incorporated BioLite Net.

1.2 2009

Jun.17

- Supports integration with 3rd

- subevent field in BSLogRecord is described.

party RF device

1.25 2009

Nov.10

- useFastIDMatchingfiled in BSOPModeConfig is described.

- Supports server APIs which can be used for making server

applications.

- Supports interactive APIs, which can be used for

displaying user define messages and user define images,

user define sounds.

1.26 2010

Apr. 6

- Incorporated Xpass.

- BS_OpenSocketEx function is added. BS_OpenSocketEx

function can open the network interface to the target IP

with specific host IP.

- 'disableAutoResult' field in BSDisplayConfig is added.

- 'openOnce' field in BSDoor is added.

- 'deviceID' field in BSInputFunction is added.

- 'deviceID' field in BSOuptutEvent is added.

- 'support100BaseT' field in BEConfigData and

BEConfigDataBLN is added.

- 'useTermination' field in BEConfigDataBLN is added.

1.3 2010

Jul 6

- Incorporated D-Station

- themefield in BSDisplayConfig is added.

- DSTnaEventConfig ,DSTnaEventExConfig,

DSSerialConfig, DS485NetworkConfig

DSOPModeConfig, DSFaceConfig, DSDisplayConfig,

DSInputConfig , DSFingerprintConfig, DSWLANPreset,

DSSaveImageEventConfig and DSWLANConfig are added.

- BSLogRecordEx and BSImageLogHdr are added.

- Communication API

Copyright 2013 by Suprema Inc.

BS_OpenUSBEx is added.

- Log Management API

BS_ClearLogCacheEx, BS_ReadLogCacheEx,

BS_ReadLogEx and

BS_ReadNextLogEx are added.

- Image Log Management API

BS_ReadImageLog, BS_GetImageLogCount,

BS_DeleteImageLog,

BS_DeleteAllImageLog and

BS_ReadSpecificImageLog are added

- Display Setup API

BS_SendNoticeEx

- User Management API

BS_GetUserImage,

BS_SetUserImage,

BS_GetUserFaceInfo,

BS_EnrollFace,

BS_EnrollUserDStation,

BS_EnrollMultipleUserDStation,

BS_GetAllUserInfoDStation,

BS_GetUserInfoDStation,

BS_GetUserDStation and

BS_ReadFaceData are added.

- Configuration API

BS_WriteDSTnaEventConfig,

BS_ReadDSTnaEventConfig,

BS_WriteDSTnaEventExConfig,

BS_ReadDSTnaEventExConfig,

BS_SetDSProtection,

BS_WriteDSSaveImageEventConfig,

BS_ReadDSSaveImageEventConfig,

BS_WriteFaceConfig,

BS_ReadFaceConfig,

BS_WriteDSInputConfig,

BS_ReadDSInputConfig,

BS_WriteDSWiegandConfig,

Copyright 2013 by Suprema Inc.

BS_ReadDSWiegandConfig,

BS_WriteDS485NetworkConfig,

BS_ReadDS485NetworkConfig,

BS_WriteDSSerialConfig,

BS_ReadDSSerialConfig,

BS_WriteDSOPModeConfig,

BS_ReadDSOPModeConfig,

BS_WriteDSDisplayConfig,

BS_ReadDSDisplayConfig,

BS_WriteDSFingerprintConfig,i

BS_ReadDSFingerprintConfig,

BS_WriteDSWLANConfig and

BS_ReadDSWLANConfig are added

1.31 2010

Aug 10

- Incorporated iCLASS

- fullCardCustomID item in BEUserHdr is added.

- fullCardCustomID item in BECommandCard is added.

- customID item in BSUserHdrEx is changed to unsigned

int.

- BSiClassConfig and BSiClassCardHeader are added.

- BSBlacklistItemEx struct is added.

- Configuration API

BS_WriteiClassConfiguration,

BS_ReadiClassConfiguration,

BS_ChangeiClassKey,

BS_WriteiClassCard,

BS_ReadiClassCard,

BS_FormatiClassCard,

BS_AddBlacklistEx,

BS_DeleteBlacklistEx,

BS_ReadBlacklistEx are added.

1.35 2010

Dec 8

- Incorporated X-Station

- XSTnaEventConfig, XSTnaEventExConfig struct are added.

- XSSerialConfig, XS485NetworkConfig struct are added.

- XSOPModeConfig struct is added.

- XSSaveImageEventConfig struct is added.

- XSDisplayConfig struct is added.

Copyright 2013 by Suprema Inc.

- XSInputConfig struct is added.

- XSUserHdr struct is added.

- XSWiegandConfig struct is added.

- User Management API

BS_EnrollUserXStation,

BS_EnrollMultipleUserXStation,

BS_GetAllUserInfoXStation,

BS_GetUserInfoXStation,

BS_GetUserXStation are added.

- Configuration API

BS_WriteXSTnaEventConfig,

BS_ReadXSTnaEventConfig,

BS_WriteXSTnaEventExConfig,

BS_ReadXSTnaEventExConfig,

BS_WriteXSSaveImageEventConfig,

BS_ReadXSSaveImageEventConfig,

BS_WriteXSInputConfig,

BS_ReadXSInputConfig,

BS_WriteXSWiegandConfig,

BS_ReadXSWiegandConfig,

BS_WriteXS485NetworkConfig,

BS_ReadXS485NetworkConfig,

BS_WriteXSSerialConfig,

BS_ReadXSSerialConfig,

BS_WriteXSOPModeConfig,

BS_ReadXSOPModeConfig,

BS_WriteXSDisplayConfig,

BS_ReadXSDisplayConfig are added.

- Server API

BS_SetImageLogCallback is added.

1.5 2011

June 30

- Incorporated BioStation2.

- BS2TnaEventConfig, BS2TnaEventExConfig struct are

added.

- BS2SerialConfig,BS2485NetworkConfig struct is added.

- BS2OPModeConfig struct is added.

- BS2SaveImageEventConfig struct is added.

Copyright 2013 by Suprema Inc.

- BS2DisplayConfig struct is added.

- BS2InputConfig struct is added.

- BS2UserHdr struct is added.

- BS2WiegandConfig struct is added.

- BS2FingerprintConfig struct is added.

- BS2WLANPreset, BS2WLANConfig struct is added.

- User Management API

BS_EnrollUserBiotation2,

BS_EnrollMultipleUserBioStation2,

BS_GetAllUserInfoBioStation2,

BS_GetUserInfoBioStation2,

BS_GetUserBioStation2,

BS_ReadImageEx are added.

- Configuration API

BS_WriteBS2TnaEventConfig,

BS_ReadBS2TnaEventConfig,

BS_WriteBS2TnaEventExConfig,

BS_ReadBS2TnaEventExConfig,

BS_WriteBS2SaveImageEventConfig,

BS_ReadBS2SaveImageEventConfig,

BS_WriteBS2InputConfig,

BS_ReadBS2InputConfig,

BS_WriteBS2WiegandConfig,

BS_ReadBS2WiegandConfig,

BS_WriteBS2485NetworkConfig,

BS_ReadBS2485NetworkConfig,

BS_WriteBS2SerialConfig,

BS_ReadBS2SerialConfig,

BS_WriteBS2OPModeConfig,

BS_ReadBS2OPModeConfig,

BS_WriteBS2DisplayConfig,

BS_ReadBS2DisplayConfig,

BS_WriteBS2FingerprintConfig,

BS_ReadBS2FingerprintConfig,

BS_WriteBS2WLANConfig,

BS_ReadBS2WLANConfig,

Copyright 2013 by Suprema Inc.

BS_WriteBS2InterphoneConfig,

BS_ReadBS2InterphoneContifg are added.

1.52 2011

Jan 16

- Incorporated Xpass Slim.

- Xpass Slim is all same with Xpass, but not supporting

Mifare data card.

1.6 2012

Apr 10

- Incorporated FaceStation. - FSTnaEventConfig, FSTnaEventExConfig structure are

added.

- FSUSBConfig, FSSerialConfig and FS485NetworkConfig

structure are added.

- FSSaveImageEventConfig is added.

- FSWLANPreset, FSWLANConfig structure are added.

- FSDisplayConfig is added.

- FSInterphoneConfig is added.

- FSOPModeConfig is added.

- FSFaceConfig is added.

- FSInputConfig is added.

- FSUserHdr and FSUserTemplateHdr are added.

- FSWiegandConfig is added.

- User Management API

BS_EnrollMultipleUserFStation,

BS_GetAllUserInfoFStation,

BS_GetUserInfoFStation,

BS_GetUserFStation,

BS_ScanFaceTemplate are added.

- Configuration API

BS_WriteFSTnaEventConfig,

BS_ReadFSTnaEventConfig,

BS_WriteFSTnaEventExConfig,

BS_ReadFSTnaEventExConfig,

BS_WriteFSSaveImageEventConfig,

BS_ReadFSSaveImageEventConfig,

BS_WriteFSInputConfig,

BS_ReadFSInputConfig,

BS_WriteFSWiegandConfig,

BS_ReadFSWiegandConfig,

Copyright 2013 by Suprema Inc.

BS_WriteFS485NetworkConfig,

BS_ReadFS485NetworkConfig,

BS_WriteFSSerialConfig,

BS_ReadFSSerialConfig,

BS_WriteFSOPModeConfig,

BS_ReadFSOPModeConfig,

BS_WriteFSDisplayConfig,

BS_ReadFSDisplayConfig,

BS_WriteFSFaceConfig,

BS_ReadFSFaceConfig,

BS_WriteFSWLANConfig,

BS_ReadFSWLANConfig,

BS_WriteFSInterphoneConfig,

BS_ReadFSInterphoneConfig,

BS_WriteFSUSBConfig,

BS_ReadFSUSBConfig,

BS_WriteBSVideophoneConfig,

BS_ReadBSVideophoneConfig are added.

1.61 2012

Jun 25

- Incorporated BioEntry W

- BioEntry W is all same with BioEntryPlus.

1.62 2013

Jan 2

- FSUserHdrEx struct is added.

- User Management API

BS_EnrollUserFStationEx is added.

BS_EnrollMultipleUserFStationEx is added.

BS_GetAllUserInfoFStationEx is added.

BS_GetUserInfoFStationEx is added.

BS_GetUserFStationEx is added.

- Miscellaneous API

BS_UTF8ToString is added.

BS_UTF16ToString is added.

BS_EncryptSHA256 is added.

Copyright 2013 by Suprema Inc.

Important Notice Information in this document is provided in connection with Suprema products. No license, express or implied, by estoppel or otherwise, to any intellectual property rights is granted by this docume