SBXPC Reference Manual

V3.1

TJI Prime Biometric Technology

6/8/2012

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

Revision History
Important Note:
We always guarantee backward compatibility of OCX for existing devices, new OCX always embraces all products.
Therefore it is strongly recommended to use new OCX.
Rev.
V3.0 Draft
V3.01 Draft

Date
7/4/2011
7/18/2011

V3.02 Draft
V3.03
V3.1

8/3/2011
11/18/2011
6/8/2012

Comments
Draft version for the unified OCX (supports all the types of machine)
Draft version.
If an interface gets time, then it always gets in second unit.
General operation by XML & general event firing by XML added, this means that
future modification or addition is forbidden, they must be implemented through
these XML interfaces.
Draft version. Brief description of XML operation is added.
New DLL mode support. See 5.DLL mode support.
Obsolete *_EXT functions were removed. These functions never used by customers,
so they were removed.
Multi-device safe, multi-thread safe support. See 6.Multi-device safe, Multi-thread
safe support.
"TCP active connection" mode support. See 7."TCP active connection" mode
support.
P2P support. See 8.P2P support.
See Appendix 2. Miscellaneous Items

-2-

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

Contents
Revision History ............................................................................. 2
Contents ................................................................................... 3
1.
Brief description .......................................................................... 5
1.1 Support machines ....................................................................... 5
1.2 SBXPC ............................................................................... 5
2.
Properties .............................................................................. 8
2.1 CommPort (deprecated) .................................................................. 8
2.2 Baudrate (deprecated) .................................................................... 8
2.3 ReadMark ............................................................................ 8
3.
Methods ............................................................................... 9
3.1 SetMachineType ........................................................................ 9
3.2 DotNET .............................................................................. 9
3.3 GetEnrollData ......................................................................... 10
3.4 GetEnrollData1(for .NET users) ............................................................. 11
3.5 SetEnrollData ......................................................................... 12
3.6 SetEnrollData1(for .NET users) ............................................................. 12
3.7 DeleteEnrollData ....................................................................... 13
3.8 ReadSuperLogData ..................................................................... 14
3.9 GetSuperLogData ...................................................................... 14
3.10
ReadGeneralLogData ................................................................. 16
3.11
GetGeneralLogData .................................................................. 16
3.12
ReadAllSLogData .................................................................... 19
3.13
GetAllSLogData ..................................................................... 19
3.14
ReadAllGLogData .................................................................... 20
3.15
GetAllGLogData ..................................................................... 20
3.16
GetDeviceStatus ..................................................................... 21
3.17
GetDeviceInfo....................................................................... 22
3.18
SetDeviceInfo ....................................................................... 23
3.19
EnableDevice ....................................................................... 24
3.20
EnableUser ......................................................................... 24
3.21
GetDeviceTime ...................................................................... 25
3.22
SetDeviceTime ...................................................................... 25
3.23
PowerOnAllDevice ................................................................... 26
3.24
PowerOffDevice ..................................................................... 26
3.25
ModifyPrivilege ..................................................................... 27
3.26
ReadAllUserID ...................................................................... 27
3.27
GetAllUserID ....................................................................... 28
3.28
GetSerialNumber .................................................................... 29
3.29
GetBackupNumber ................................................................... 29
3.30
GetProductCode ..................................................................... 29
3.31
ClearKeeperData ..................................................................... 30
3.32
EmptyEnrollData ..................................................................... 30
3.33
EmptyGeneralLogData ................................................................ 30
3.34
EmptySuperLogData .................................................................. 30
3.35
GetUserName ....................................................................... 31
3.36
GetUserName1(for .NET users) ........................................................... 31
3.37
SetUserName ....................................................................... 32
3.38
SetUserName1(for .NET users) ........................................................... 32
3.39
GetCompanyName ................................................................... 32
3.40
GetCompanyName1(for .NET users) ....................................................... 33
3.41
SetCompanyName ................................................................... 33
3.42
SetCompanyName1(for .NET users) ....................................................... 33
3.43
GetDoorStatus ...................................................................... 34
-3-

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.44
SetDoorStatus ...................................................................... 34
3.45
GetBellTime ........................................................................ 35
3.46
SetBellTime ........................................................................ 35
3.47
ConnectSerial ....................................................................... 36
3.48
ConnectTcpip ....................................................................... 36
3.49
Disconnect ......................................................................... 37
3.50
SetIPAddress (deprecated) ............................................................. 37
3.51
OpenCommPort (deprecated) ........................................................... 37
3.52
CloseCommPort (deprecated) ........................................................... 38
3.53
GetLastError ........................................................................ 38
3.54
GetDeviceLongInfo(deprecated).......................................................... 39
3.55
SetDeviceLongInfo(deprecated) .......................................................... 40
3.56
ModifyDuressFP(deprecated) ............................................................ 41
4.
Next generation of SBXPC with XML ........................................................... 42
4.1 GeneralOperationXML ................................................................... 42
5.
DLL mode support ....................................................................... 43
6.
Multi-device safe, Multi-thread safe support ..................................................... 44
7.
"TCP active connection" mode support ......................................................... 44
8.
P2P (Peer To Peer) support ................................................................. 46
8.1 ConnectP2p .......................................................................... 47
Appendix 1. Specific Machine Functionality .......................................................... 48
Appendix 2. Miscellaneous Items ................................................................. 49

-4-

 2004-2012 TJI Prime Biometric.

1.

Briefdescription

1.1

Support machines

SBXPC Reference Manualv3.1

S100 (SB2900), S300 (SB2960), SB3600, SB2910(EC500)

A30(AR1003), A50(AR1005)

1.2

SBXPC

SBXPC reference consists of SBXPC.OCXwhich is a Windows OCX component containing the properties, methods and event
handlersas the below. If you want to see more specificmachine functionalityit is strongly recommended to see Appendix 1.
Specific Machine Functionality first.
No

Properties/Methods

Description

2 Properties
1

CommPort (deprecated)

The port number of serial COM.

Baudrate(deprecated)

The baudrate of serial COM.

ReadMark

The flag which represents whether set a mark on the last read
record.

3 Methods
1

SetMachineType

Sets the machine type.

DotNET

Informsthat client development environment is .NET.

GetEnrollData

Gets an enrolled data from the machine.

GetEnrollData1

Gets an enrolled data from the machine(for .NET users).

SetEnrollData

Sets an enrolled data to the machine.

SetEnrollData1

Sets an enrolled data to the machine (for .NET users).

DeleteEnrollData

Removes an enrolled data from the machine.

ReadSuperLogData

Reads the new management records from the machine and

stores on memory.

GetSuperLogData

Gets a management record from the memory.

10

ReadGeneralLogData

Reads the new attendance records from the machine and

stores on memory.

11

GetGeneralLogData

Gets a attendance record from the memory.

12

ReadAllSLogData

Reads all the management records from the device and stores
on memory.

13

GetAllSLogData

Gets all the management records from the memory.

14

ReadAllGLogData

Reads all the attendance records from the machine and stores
on memory.

15

GetAllGLogData

Gets all the attendance records from the memory.

16

GetDeviceStatus

Gets the current device status from the machine.

17

GetDeviceInfo

Gets the device information from the machine.

-5-

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

18

SetDeviceInfo

Sets the device information to the machine.

19

EnableDevice

20

EnableUser

21

GetDeviceTime

Gets the date and time on the machine.

22

SetDeviceTime

Sets the data and time on the machine.

23

PowerOnAllDevice

Powers on all the machines.

24

PowerOffDevice

Powers off an machine.

25

ModifyPrivilege

Modifies the privilege of a user on the machine.

26

ReadAllUserID

Reads the data of all the enrolled users from the machine and
stores on memory.

27

GetAllUserID

Gets the data of all the enrolled users from the memory.

28

GetSerialNumber

Gets the serial number of the machine.

29

GetBackupNumber

Gets the management number of the machine.

30

GetProductCode

Gets the product code of the machine.

31

ClearKeeperData

Clears all the records and enrolled data.

32

EmptyEnrollData

Clears all the enrolled data on the machine.

33

EmptyGeneralLogData

Clears all the attendance(access) records.

34

EmptySuperLogData

Clears all the management records.

35

GetUserName

Gets the name of the specified user from the machine.

36

GetUserName1

Gets the name of a user from the machine(for .NET users).

37

SetUserName

Sets the name of the specified user to the machine.

38

SetUserName1

Sets the name of a user to the machine(for .NET users).

39

GetCompanyName

Gets the company name from the machine.

40

GetCompanyName1

Gets the company name from the machine(for .NET users).

41

SetCompanyName

Sets the company name to the machine.

42

SetCompanyName1

Sets the company name to the machine(for .NET users).

43

GetDoorStatus

Gets the doors status from the machine.

44

SetDoorStatus

Sets the doors status to the machine.

45

GetBellTime

Gets the bell time from the machine.

46

SetBellTime

Sets the bell time to the machine.

47

ConnectSerial

Connects to the machine via the serial port

(RS232, RS485) or USB.

48

ConnectTcpip

Connects to the machine via the ethernet(TCP/IP).

49

Disconnect

Disconnects the machine.

50

SetIPAddress(deprecated)

Informs the IP address of machine.

51

OpenCommPort(deprecated)

Connects the machine with current communication settings.

52

CloseCommPort(deprecated)

Disconnects the machine.

Enables(or disables) the machine(in order to get the

attendance records etc).
Enables(or disables) the machine(in order to get an attendance
record of a user).

-6-

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

53

GetLastError

Gets the last error code.

54

GeneralOperationXML

General operation by XML.

55

GetDeviceLongInfo(deprecated)

Gets the device long information from the machine.

56

SetDeviceLongInfo(deprecated)

Sets the device long information to the machine.

57

ModifyDuressFP(deprecated)

Modifies the fingerprint duress status on the machine.

58

GetMachineIP

Gets the dynamic IP address of the remote machine.

59

GetDepartName(deprecated)

Gets the department name from the machine.

60

SetDepartName(deprecated)

Sets the department name to the machine.

61

StartEventCapture

Starts capturing events from the machines.

62

StopEventCapture

Suspends capturing events from the machines.

63

ConnectP2p

P2P Connection establishment.

4 Event Handlers
1

OnReceiveEventXML

Called back (by XML) when receiving an event from a machine.

-7-

 2004-2012 TJI Prime Biometric.

2.

Properties

2.1

CommPort (deprecated)

SBXPC Reference Manualv3.1

The port number of serial communication.This property is set before call of OpenCommPort.
Type (C++)
long

CommPort

int

CommPort

Type (C#)

Initial Value
1(COM1)
Description
See OpenCommPort.

2.2

Baudrate (deprecated)
The baudrate of serial communication.This property is set before call of OpenCommPort.

Type (C++)
long

Baudrate

int

Baudrate

Type (C#)

Initial Value
115200
Description
See OpenCommPort.

2.3

ReadMark
The flag which represents whether obtained logs are marked as read.

Type (C++)
BOOL

ReadMark

bool

ReadMark

Type (C#)

Initial Value
TRUE
Description
See log getting functions.

-8-

 2004-2012 TJI Prime Biometric.

3.

Methods

3.1

SetMachineType

SBXPC Reference Manualv3.1

This function is used to set target machine type.

Syntax (C++)
BOOL SetMachineType(
BSTR lpszMachineType);
Syntax (C#)
bool SetMachineType(
string lpszMachineType);
Parameters
lpszMachineType

: String of machine type.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
It is normally needed for legacy devices only, because new devices inform its type while connecting.
String of a machine type is confidential, Smackbio makes customer-specific document for this information.
If there is no customer-specific document, do not care about machine type, DO NOT CALL THIS FUNCTION.

3.2

DotNET

Informs that client development environment is .NET.

Syntax (C++)
void DotNET();
Syntax (C#)
void DotNET();
Parameters
None.
Return Values
None.

-9-

 2004-2012 TJI Prime Biometric.

3.3

SBXPC Reference Manualv3.1

GetEnrollData

Gets an enrollment data from the machine.

Syntax (C++)
BOOL GetEnrollData(
long
dwMachineNumber,
long
dwEnrollNumber,
long
dwEMachineNumber,
long
dwBackupNumber,
long*
dwMachinePrivilege,
VARIANT*
dwEnrollData,
long*
dwPassWord);
Parameters
dwMachineNumber
dwEnrollNumber
dwEMachineNumber
dwBackupNumber

: Target machine ID.

: User ID.
: Not used, set as target machine ID.
: Backup number (originally, it means finger number) of the data to get.
Below are values of the backup numbers.

Value

Meaning

0~9

Fingerprint data for finger number from No.0 to

No.9

Future

10

Password data (beginning with 0 is not allowed.)

11

Card data

14

User Timezone

15

Password data(beginning with 0 is allowed.)

16

User department
dwMachinePrivilege

deprecated,
supported
for
SB2900,
SB2960(SB3600) only
deprecated,
supported
for
SB2900,
SB2960(SB3600) only
deprecated, supported for SB2960(SB3600)
only

: [OUT] User level.

Below are values of user levels.

Value

Level

Meaning

Employee

User

Administrator

Supervisor

Enrollment
manager

Manager who can enroll

and setup, cannot manage
supervisor
&
other
managers.

Setup manager

Setuponly

dwEnrollData
dwPassWord

: [OUT] The repository for fingerprint data. Its size is 1404+12 Bytes.
: [OUT]The repository for password or card value.
The password consists of four digits.
IfdwBackupNumber == 14, 16, then dwPassWord has special pattern
perproduct.Please refer sample source for more detail.
If dwBackupNumber == 15, then the value of dwPassWordwas encoded by
special ruleto preserve beginning zeros. So you should decode to get proper
value. Please refer sample source for more detail.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
- 10 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

Remarks
When dwBackupNumber is in 0~9, then value of dwPassWordis meaningless, only the value of dwEnrollData
is meaningful.
Of course, reverse case is also true.
.NET client software must use GetEnrollData1

3.4

GetEnrollData1(for .NET users)

It is same as GetEnrollData except for the type of the parameter dwEnrollData.

Syntax (C++)
BOOL GetEnrollData1(
long
dwMachineNumber,
long
dwEnrollNumber,
long
dwBackupNumber,
long*
dwMachinePrivilege,
long*
dwEnrollData,
long*
dwPassWord);
Syntax (C#)
bool GetEnrollData1(
int
dwMachineNumber,
int
dwEnrollNumber,
int
dwBackupNumber,
ref int
dwMachinePrivilege,
ref int
dwEnrollData,
ref int
dwPassWord);

- 11 -

 2004-2012 TJI Prime Biometric.

3.5

SBXPC Reference Manualv3.1

SetEnrollData

Sets an enrollment data to the machine.

Syntax (C++)
BOOL SetEnrollData(
long
dwMachineNumber,
long
dwEnrollNumber,
long
dwEMachineNumber,
long
dwBackupNumber,
long
dwMachinePrivilege,
VARIANT*
dwEnrollData,
long
dwPassWord);
Parameters
dwMachineNumber
dwEnrollNumber
dwEMachineNumber
dwBackupNumber

dwMachinePrivilege
dwEnrollData
dwPassWord

: Target machine ID.

: User ID.
: Not used, set as target machine ID.
: Backup number of the data to set. See GetEnrollData.
If backup number is in 0~9, then double checking of fingerprint data will be
required.
If backup number is in 20~29, then it is same as in 0~9, but double checking of
fingerprint data will not be required.
: User level.See GetEnrollData.
: The repository for fingerprint data. Its size is 1404+12 Bytes. It must be valid
fingerprint data, which was saved through GetEnrollData.
: The repository for password or card value.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
When dwBackupNumber is in 0~9 (20~29), then value of dwPassWordis meaningless, only the value of
dwEnrollData is meaningful.
Of course, reverse case is also true.
.NET client software must use SetEnrollData1

3.6

SetEnrollData1(for .NET users)

It is same as SetEnrollData except for the type of the parameter dwEnrollData.

Syntax (C++)
BOOL SetEnrollData1(
long
dwMachineNumber,
long
dwEnrollNumber,
long
dwBackupNumber,
long
dwMachinePrivilege,
long*
dwEnrollData,
long
dwPassWord);
Syntax (C++)
bool SetEnrollData1(
int
dwMachineNumber,
int
dwEnrollNumber,
int
dwBackupNumber,
int
dwMachinePrivilege,
ref int
dwEnrollData,
int
dwPassWord);

- 12 -

 2004-2012 TJI Prime Biometric.

3.7

SBXPC Reference Manualv3.1

DeleteEnrollData

Removes an enrollment data from the machine.

Syntax (C++)
BOOL DeleteEnrollData(
long
dwMachineNumber,
long
dwEnrollNumber,
long
dwEMachineNumber,
long
dwBackupNumber);
Syntax (C#)
bool DeleteEnrollData(
int
dwMachineNumber,
int
dwEnrollNumber,
int
dwEMachineNumber,
int
dwBackupNumber);
Parameters
dwMachineNumber
dwEnrollNumber
dwEMachineNumber
dwBackupNumber

: Target machine ID.

: User ID.
: Not used, set as target machine ID.
: Backup number of the data to delete.Below are values of the backup numbers.

Value

Meaning

0~9

Fingerprint data for finger number from No.0 to

No.9

10

Password data

11

Card data

12

Delete all fingerprint , password, card data

13

Delete all fingerprint data only.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

- 13 -

 2004-2012 TJI Prime Biometric.

3.8

SBXPC Reference Manualv3.1

ReadSuperLogData

Reads the newly recorded management logs from the machine and stores it into the PC memory.
Syntax (C++)
BOOL ReadSuperLogData(
long dwMachineNumber);
Syntax (C#)
bool ReadSuperLogData(
long dwMachineNumber);
Parameters
dwMachineNumber

: Target machine ID.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
Use GetSuperLogDatato parse stored logs.
If ReadMark property is TRUE, then stored logs are marked as read at the device.

3.9

GetSuperLogData

Parses a management log from the PC memory.

Syntax (C++)
BOOL GetSuperLogData(
long
dwMachineNumber,
long*
dwTMachineNumber,
long*
dwSEnrollNumber,
long*
dwSMachineNumber,
long*
dwGEnrollNumber,
long*
dwGMachineNumber,
long*
dwManipulation,
long*
dwBackupNumber,
long*
dwYear,
long*
dwMonth,
long*
dwDay,
long*
dwHour,
long*
dwMinute,
long*
dwSecond);
Syntax (C#)
bool GetSuperLogData(
int
dwMachineNumber,
ref int
dwTMachineNumber,
ref int
dwSEnrollNumber,
ref int
dwSMachineNumber,
ref int
dwGEnrollNumber,
ref int
dwGMachineNumber,
ref int
dwManipulation,
ref int
dwBackupNumber,
ref int
dwYear,
ref int
dwMonth,
ref int
dwDay,
ref int
dwHour,
ref int
dwMinute,
ref int
dwSecond);
Parameters
dwMachineNumber
dwTMachineNumber

:Target machine ID.

:[OUT] Not used, it is same as the target machine ID.
- 14 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

dwSEnrollNumber
dwSMachineNumber
dwGEnrollNumber
dwGMachineNumber
dwManipulation

:[OUT]The ID value of the manager, who performed the action.

If this value is 0, then it means that no manager enrolled.
:[OUT] Not used, it is same as the target machine ID.
:[OUT]The ID value of the user, who received the action.
If this value is 0, then it means that the action is related with the device itself.
:[OUT] Not used, it is same as the target machine ID.
:[OUT] Value of the action.
Below are the values of the action.

Value

Meaning

A user has been enrolled.

A manager has been enrolled.

A fingerprint data has been deleted.

A password data has been deleted.

A card data has been deleted.

All log data has been deleted.

A Setting has been changed.

10

The date/time has been changed.

11

A log setting has been changed.

12

A communication setting has been changed.

13

The time zonesetting been changed.

dwBackupNumber

:[OUT] Backup number, which the action was related with.

Below are values of the backup number.

Value

Meaning

0~9

Fingerprint data for finger number from No.0 to

No.9

10

Password data

13

Card data

dwYear, dwMonth, dwDay, dwHour, dwMinute, dwSecond

:[OUT] The time, when the action was occurred.
Return Values
TRUE (nonzero): success.
FALSE (zero): failure, it means that there are no more logs to parse.
Remarks
This function parses a management log from the PC memory, which filled by ReadSuperLogData.

- 15 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.10 ReadGeneralLogData
Reads the newly recorded time logs from the machine and stores it into the PC memory.
Syntax (C++)
BOOL ReadGeneralLogData(
long
dwMachineNumber);
Syntax (C#)
bool ReadGeneralLogData(
int
dwMachineNumber);
Parameters
dwMachineNumber

: Target machine ID.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
Use GetGeneralLogDatato parse stored logs.
If ReadMark property is TRUE, then stored logs are marked as read at the device.

3.11 GetGeneralLogData
Parses a time log from the PC memory.
Syntax (C++)
BOOL GetGeneralLogData(
long
dwMachineNumber,
long* dwTMachineNumber,
long* dwEnrollNumber,
long* dwEMachineNumber,
long* dwVerifyMode,
long* dwYear,
long* dwMonth,
long* dwDay,
long* dwHour,
long* dwMinute,
long* dwSecond);
Syntax (C#)
bool GetGeneralLogData(
int
dwMachineNumber,
ref int dwTMachineNumber,
ref int dwEnrollNumber,
ref int dwEMachineNumber,
ref int dwVerifyMode,
ref int dwYear,
ref int dwMonth,
ref int dwDay,
ref int dwHour,
ref int dwMinute,
ref int
dwSecond);
Parameters
dwMachineNumber
dwTMachineNumber

: Target machine ID.

:[OUT] Not used, it is same as the target machine ID. For some machine types it
has special meaning.

Machine
Type

Meaning

SB3600

Logged photo index, if -1, then it is invalid.

- 16 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

EC500
dwEnrollNumber
dwEMachineNumber
dwVerifyMode

Logged job code.

:[OUT]The ID value of the user, who clocked in/out.
:[OUT] Not used, it is same as the target machine ID.
:[OUT] Clocking mode.
Below values are available.

Little Endian LSB BYTE 0

Value

Meaning

Fingerprint-based

Password-based

Card-based

Fingerprint + Card

Fingerprint + Password

Card + Password

Fingerprint + Card + Password

51

In : Fingerprint-based

52

In : Password-based

53

In : Card-based

101

Out : Fingerprint-based

102

Out : Password-based

103

Out : Card-based

151

Extra: Fingerprint-based

152

Extra: Password-based

153

Extra: Card-based

10

(access control) Hand lock

11

(access control) Program lock

12

(access control) Program open

13

(access control) Program close

14

(access control) Auto recover

20

(access control) Lock over

21

(access control) Illegal open

22

(access control) Duress alarm

23

(access control) Tampering detected

Little Endian LSB BYTE 1 attendance status

0
duty on
1
duty off
2
overtime on
3
overtime off
4
go in
5
go out
Little Endian LSB BYTE 2 Anti-pass status
0
None
1
In
3
Out
- 17 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

dwYear, dwMonth, dwDay, dwHour, dwMinute, dwSecond

: [OUT] Clocking time.
Return Values
TRUE (nonzero): success.
FALSE (zero): failure, it means that there are no more logs to parse.
Remarks
This function parses a timelog from the PC memory, which filled by ReadGeneralLogData.

- 18 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.12 ReadAllSLogData
Reads all recorded management logs from the machine and stores it into the PC memory.
That is, this function ignores read mark.
Syntax (C++)
BOOL ReadAllSLogData(
long dwMachineNumber);
Syntax (C#)
boolReadAllSLogData(
long dwMachineNumber);
Parameters
dwMachineNumber

: Target machine ID.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
Use GetALLSLogDatato parse stored logs.

3.13 GetAllSLogData
Parses a management log from the PC memory.
Syntax (C++)
BOOL GetAllSLogData(
long
dwMachineNumber,
long*
dwTMachineNumber,
long*
dwSEnrollNumber,
long*
dwSMachineNumber,
long*
dwGEnrollNumber,
long*
dwGMachineNumber,
long*
dwManipulation,
long*
dwBackupNumber,
long*
dwYear,
long*
dwMonth,
long*
dwDay,
long*
dwHour,
long*
dwMinute,
long*
dwSecond);
Syntax (C#)
boolGetAllSLogData(
int
dwMachineNumber,
ref int
dwTMachineNumber,
ref int
dwSEnrollNumber,
ref int
dwSMachineNumber,
ref int
dwGEnrollNumber,
ref int
dwGMachineNumber,
ref int
dwManipulation,
ref int
dwBackupNumber,
ref int
dwYear,
ref int
dwMonth,
ref int
dwDay,
ref int
dwHour,
ref int
dwMinute,
ref int
dwSecond);
Remarks
This function is same as GetSuperLogData, except that it is used after calling of ReadAllSLogData.

- 19 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.14 ReadAllGLogData
Reads all recorded time logs from the machine and stores it into the PC memory.
That is, this function ignores read mark.
Syntax (C++)
BOOL ReadAllGLogData(
long
dwMachineNumber);
Syntax (C#)
boolReadAllGLogData(
int
dwMachineNumber);
Parameters
dwMachineNumber

: Target machine ID.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
Use GetALLGLogDatato parse stored logs.

3.15 GetAllGLogData
Parses a time log from the PC memory.
Syntax (C++)
BOOL GetAllGLogData(
long
dwMachineNumber,
long* dwTMachineNumber,
long* dwEnrollNumber,
long* dwEMachineNumber,
long* dwVerifyMode,
long* dwYear,
long* dwMonth,
long* dwDay,
long* dwHour,
long* dwMinute,
long* dwSecond);
Syntax (C#)
boolGetAllGLogData(
int
dwMachineNumber,
ref int dwTMachineNumber,
ref int dwEnrollNumber,
ref int dwEMachineNumber,
ref int dwVerifyMode,
ref int dwYear,
ref int dwMonth,
ref int dwDay,
ref int dwHour,
ref int dwMinute,
ref int
dwSecond);
Remarks
This function is same as GetGeneralLogData, except that it is used after calling of ReadAllGLogData.

- 20 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.16 GetDeviceStatus
Gets a current status of the device.
Syntax(C++)
BOOL GetDeviceStatus(
long
dwMachineNumber,
long
dwStatus,
long*
dwValue);
Syntax(C#)
bool GetDeviceStatus(
int
dwMachineNumber,
int
dwStatus,
ref int
dwValue);
Parameters
dwMachineNumber
dwStatus

: Target machine ID.

: Type of the status info to get
Below are available values of this parameter.

Value

Meaning

The number of managers currently enrolled on the device

The number of users currently enrolledon the device

3
4
5

The number of fingerprints currently enrolledon the

device
The number of passwords currently enrolled on the
device
The number of management log currently recorded on
the device

The number of time log currently recorded on the device

The number of cards currently enrolled on the device

Alarm status
bit 0 Opening time over
bit 1 Illegal open
bit 2 Duress verification
bit 3 Tampering detected

dwValue

: [OUT] The repository for the value of the status information

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

- 21 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.17 GetDeviceInfo
Gets a device parameter (setting)from the machine.
Syntax(C++)
BOOL GetDeviceInfo(
long
dwMachineNumber,
long
dwInfo,
long*
dwValue);
Syntax(C#)
bool GetDeviceInfo(
int
dwMachineNumber,
int
dwInfo,
ref int
dwValue);
Parameters
dwMachineNumber
dwInfo
dwValue

: Target machine ID.

: Type of the device parameterto get
:[OUT] The repository for the value of the device parameter.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
Below are available values of the dwInfo paramter.
Value

Meaning

Range

Maximum number of managers

0~10

The machine ID.

1~255

UI Language

English

Chinese (simplified)

Chinese (Traditional)

Auto power-off interval (minute)

0~9999

Door opening time(second)

0~10

6
7
8

10

11

Time log warning, if available space for time recording

is less than this value, then an alarm will be occurred.
Management log warning, if available space of
management recording is less than this value, then an
alarm will be occurred.
Re-verification interval (minute)

0~1000
0~100
0~255

Serial Baud rate

Serial Parity check

(no effect)
Serial Stop bit
(no effect)
- 22 -

9,600 bps

19,200 bps

38,400 bps

57,600 bps

115,200 bps

No making parity check

Even check

Odd check

Stop bit 1

Stop bit 2

 2004-2012 TJI Prime Biometric.

12

13

14

15

SBXPC Reference Manualv3.1

Date separator

Verification mode

Mode of controlling the door

Door sensor type

FP or Card or PWD

FP & Card

FP & PWD

Card & PWD

FP & Card & PWD

Unconditional Close

Unconditional Open

Auto

None

Always Open

Always Close

16

Door opening timeout (minute)

0~255

17

Anti-pass

18

Auto sleep interval (minute)

0~9999

19

Daylight offset

0~3

Disable

Enable

3.18 SetDeviceInfo
Sets a device parameter (setting) to the machine.
Syntax(C++)
BOOL SetDeviceInfo(
long
dwMachineNumber,
long
dwInfo,
long
dwValue);
Syntax(C#)
bool SetDeviceInfo(
int
dwMachineNumber,
int
dwInfo,
int
dwValue);
Parameters
dwMachineNumber
dwInfo
dwValue

: Target machine ID.

: Type of the device parameter to set
: New value of the device parameter.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
For more information, see GetDeviceInfo.

- 23 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.19 EnableDevice
Enables(or disables) the machinefor mutual access from the PC.
Syntax(C++)
BOOL EnableDevice(
long
dwMachineNumber,
long
bFlag);
Syntax(C#)
bool EnableDevice(
int
dwMachineNumber,
int
bFlag);
Parameters
dwMachineNumber
bflag

: Target machine ID.

: TRUE: enable the machine to allow user access.
FALSE: disable the machine for mutual access from the PC.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
It is recommended to disable the machine while accessing from the PC.
It is mandatory to disable the machine while transactional operation from the PC

3.20 EnableUser
Enables(or disables) a user.
Syntax(C++)
BOOL EnableUser(
long
dwMachineNumber,
long
dwEnrollNumber,
long
dwEMachineNumber,
long
dwBackupNumber,
long
bFlag);
Syntax(C#)
bool EnableUser(
int
dwMachineNumber,
int
dwEnrollNumber,
int
dwEMachineNumber,
int
dwBackupNumber,
int
bFlag);
Parameters
dwMachineNumber
dwEnrollNumber
dwEMachineNumber
dwBackupNumber
bflag

: Target machine ID.

: User ID
: Not used, set as target machine ID.
: Backup number, see dwBackupNumber of DeleteEnrollData.
: TRUE:enable the user.
FALSE: disable the user.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
Most products do not support individual enabling/disabling per credential (indicated by backup number),
that is, enabling/disabling state is unique per user.
This means that dwBackupNumber is really meaningless.

- 24 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.21 GetDeviceTime
Gets the current time of the machine.
Syntax(C++)
BOOL GetDeviceTime(
long
dwMachineNumber,
long*
dwYear,
long*
dwMonth,
long*
dwDay,
long*
dwHour,
long*
dwMinute,
long*
dwSecond,
long*
dwDayOfWeek);
Syntax(C#)
bool GetDeviceTime(
int
dwMachineNumber,
ref int dwYear,
ref int dwMonth,
ref int dwDay,
ref int dwHour,
ref int dwMinute,
ref int dwSecond,
ref int dwDayOfWeek);
Parameters
dwMachineNumber
: Target machine ID.
dwYear, dwMonth, dwDay, dwHour, dwMinute, dwSecond
: [OUT] Current time of the machine.
dwDayOfWeek
: [OUT] The value of current weekday of the machine
Value
Meaning
1

Sunday

Monday

Tuesday

Wednesday

Thursday

Friday

Saturday

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

3.22 SetDeviceTime
Sets the current time of the machine.
Syntax(C++)
BOOL SetDeviceTime(
long
dwMachineNumber);
Syntax(C#)
boolSetDeviceTime(
int
dwMachineNumber);
Parameters
dwMachineNumber

: Target machine ID.

- 25 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
Current PC time will be transferred.

3.23 PowerOnAllDevice
Powers on all the machines, which connected at the same RS-485 network.
Syntax(C++)
void

PowerOnAllDevice( void );

void

PowerOnAllDevice( void );

Syntax(C#)
Parameters
None.
Return Values
None.
Remarks
Some products maybe do not support RS-485 power on.

3.24 PowerOffDevice
Powers off a machine.
Syntax(C++)
BOOL PowerOffDevice(
long
dwMachineNumber);
Syntax(C#)
bool PowerOffDevice(
long
dwMachineNumber);
Parameters
dwMachineNumber

: Target machine ID.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

- 26 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.25 ModifyPrivilege
Modifies the level of a user.
Syntax(C++)
BOOL ModifyPrivilege(
long
dwMachineNumber,
long
dwEnrollNumber,
long
dwEMachineNumber,
long
dwBackupNumber,
long
dwMachinePrivilege);
Syntax(C#)
bool ModifyPrivilege(
int
dwMachineNumber,
int
dwEnrollNumber,
int
dwEMachineNumber,
int
dwBackupNumber,
int
dwMachinePrivilege);
Parameters
dwMachineNumber
dwEnrollNumber
dwEMachineNumber
dwBackupNumber
dwMachinePrivilege

: Target machine ID.

: User ID
: Not used, set as target machine ID.
: Backup number, see dwBackupNumber of DeleteEnrollData.
: User level, see dwMachinePrivilege of GetEnrollData.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
Most products do not support individual level per credential (indicated by backup number), that is, user level
value is unique per user.
This means that dwBackupNumber is really meaningless.

3.26 ReadAllUserID
Reads the database summaryof the machine and stores it into PC memory.
Syntax(C++)
BOOL ReadAllUserID(
long
dwMachineNumber);
Syntax(C#)
bool ReadAllUserID(
int
dwMachineNumber);
Parameters
dwMachineNumber

: Target machine ID.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
Use GetALLUserIDto parse stored summary.

- 27 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.27 GetAllUserID
Parses an item of the database summary from the PC memory.
Syntax(C++)
BOOL GetAllUserID(
long
dwMachineNumber,
long*
dwEnrollNumber,
long*
dwEMachineNumber,
long*
dwBackupNumber,
long*
dwMachinePrivilege,
long*
dwEnable);
Syntax(C#)
bool GetAllUserID(
int
dwMachineNumber,
ref int
dwEnrollNumber,
ref int
dwEMachineNumber,
ref int
dwBackupNumber,
ref int
dwMachinePrivilege,
ref int
dwEnable);
Parameters
dwMachineNumber
dwEnrollNumber
dwEMachineNumber
dwBackupNumber
dwMachinePrivilege
dwEnable

: Target machine ID.

:[OUT] User ID.
:[OUT] Not used, it is same as the target machine ID.
:[OUT]Backup number
:[OUT]User level
:[OUT]Value indicating users enable/disable state, see below.

Little Endian LSB BYTE 0

Value

Meaning

Record of an attendance of this user has been permitted.

Record of an attendance of this user has been forbidden, that is, his/her
attendance is not recorded in spite of his/her registration.

Little Endian LSB BYTE 1

Value

Meaning

Normalfingerprint.

Duress fingerprint(emit duress alarm on verification)

Return Values
TRUE (nonzero): success.
FALSE (zero): failure, it means that there are no more items to parse.
Remarks
This function parsesan item of the database summary from the PC memory, which filled by ReadAllUserID.

- 28 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.28 GetSerialNumber
Gets the serial number of the machine.
Syntax(C++)
BOOL GetSerialNumber(
long
dwMachineNumber,
BSTR*
dwSerialNumber);
Syntax(C#)
bool GetSerialNumber(
int
dwMachineNumber,
ref string
dwSerialNumber);
Parameters
dwMachineNumber
dwSerialNumber

: Target machine ID.

: [OUT] Serial number of the machine, its type is string.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

3.29 GetBackupNumber
Gets the maximum allowable count of finger per user.
Syntax(C++)
long GetBackupNumber(
long
dwMachineNumber);
Syntax(C++)
int GetBackupNumber(
int
dwMachineNumber);
Parameters
dwMachineNumber

: Target machine ID.

Return Values
Maximum allowable count of finger per user. Normally, its value is 3 or 10.
(Some products report other value, which has not above meaning.)

3.30 GetProductCode
Gets the product code of the machine.
Syntax(C++)
BOOL GetProductCode(
long
dwMachineNumber,
BSTR*
lpszProductCode);
Syntax(C#)
bool GetProductCode(
int
dwMachineNumber,
ref string
lpszProductCode);
Parameters
dwMachineNumber
lpszProductCode

: Target machine ID.

: [OUT] Product code of the machine, its type is string.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

- 29 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.31 ClearKeeperData
Clears all the (management & time) logs and user database.
Syntax(C++)
BOOL ClearKeeperData(
long
dwMachineNumber);
Syntax(C#)
bool ClearKeeperData(
int
dwMachineNumber);
Parameters
dwMachineNumber

: Target machine ID.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

3.32 EmptyEnrollData
Clears user database.
Syntax(C++)
BOOL EmptyEnrollData(
long
dwMachineNumber);
Syntax(C#)
bool EmptyEnrollData(
int
dwMachineNumber);
Parameters
dwMachineNumber

: Target machine ID.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

3.33 EmptyGeneralLogData
Clears all time logs.
Syntax(C++)
BOOL EmptyGeneralLogData(
long
dwMachineNumber);
Syntax(C#)
bool EmptyGeneralLogData(
int
dwMachineNumber);
Parameters
dwMachineNumber

: Target machine ID.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

3.34 EmptySuperLogData
Clears all management logs.

- 30 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

Syntax(C++)
BOOL EmptySuperLogData(
long
dwMachineNumber);
Syntax(C#)
bool EmptySuperLogData(
int
dwMachineNumber);
Parameters
dwMachineNumber

: Target machine ID.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

3.35 GetUserName
Gets the name of a user.
Syntax(C++)
BOOL GetUserName(
long
DeviceKind,
long
dwMachineNumber,
long
dwEnrollNumber,
long
dwEMachineNumber,
VARIANT*
dwUserName);
Parameters
DeviceKind
dwMachineNumber
dwEnrollNumber
dwEmachineNumber
dwUserName

: Not used
: Target machine ID.
: User ID
:Not used, set as target machine ID.
:[OUT] The repository for name string.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
.NET client software must use GetUserName1

3.36 GetUserName1(for .NET users)

It is same as GetUserName except for the type of the parameter dwUserName.
Syntax(C++)
BOOL GetUserName1(
long
dwMachineNumber,
long
dwEnrollNumber,
BSTR*
dwUserName);
Syntax(C#)
bool GetUserName1(
int
dwMachineNumber,
int
dwEnrollNumber,
ref string
dwUserName);

- 31 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.37 SetUserName
Sets the name of a user.
Syntax(C++)
BOOL SetUserName(
long
DeviceKind,
long
dwMachineNumber,
long
dwEnrollNumber,
long
dwEMachineNumber,
VARIANT*
dwUserName);
Parameters
DeviceKind
dwMachineNumber
dwEnrollNumber
dwEmachineNumber
dwUserName

: Not used
: Target machine ID.
: User ID
: Not used, set as target machine ID.
: The repository for name string.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
.NET client software must use SetUserName1

3.38 SetUserName1(for .NET users)

It is same as SetUserName except for the type of the parameter dwUserName.
Syntax(C++)
BOOL SetUserName1(
long
dwMachineNumber,
long
dwEnrollNumber,
BSTR*
dwUserName);
Syntax(C#)
bool SetUserName1(
int
dwMachineNumber,
int
dwEnrollNumber,
ref string
dwUserName);

3.39 GetCompanyName
Gets the company name of the machine.
Syntax(C++)
BOOL GetCompanyName(
long
dwMachineNumber,
VARIANT*
dwCompanyName);
Parameters
dwMachineNumber
dwCompanyName

: Target machine ID.

: [OUT] The repository for company name string.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
.NET client software must use GetCompanyName1
- 32 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.40 GetCompanyName1(for .NET users)

It is same as GetCompanyName except for the type of the parameter dwCompanyName.
Syntax(C++)
BOOL GetCompanyName1(
long
dwMachineNumber,
BSTR*
dwCompanyName);
Syntax(C#)
bool GetCompanyName1(
int
dwMachineNumber,
ref string
dwCompanyName);

3.41 SetCompanyName
Sets the company name of the machine.
Syntax(C++)
BOOL SetCompanyName(
long
dwMachineNumber,
long
vKind,
VARIANT*
dwCompanyName);
Parameters
dwMachineNumber
vKind
dwCompanyName

: Target machine ID.

: The flag which determines whether display company name.
1 : Display, 0 : Do not display.
: The repository for company name string.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
.NET client software must use GetCompanyName1

3.42 SetCompanyName1(for .NET users)

It is same as SetCompanyName except for the type of the parameter dwCompanyName.
Syntax(C++)
BOOL SetCompanyName1(
long
dwMachineNumber,
long
vKind,
BSTR*
dwCompanyName);
Syntax(C#)
bool SetCompanyName1(
int
dwMachineNumber,
int
vKind,
ref string
dwCompanyName);

- 33 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.43 GetDoorStatus
Gets the door status of the machine.
Syntax(C++)
BOOL GetDoorStatus(
long
dwMachineNumber,
long*
dwValue);
Syntax(C#)
bool GetDoorStatus(
int
dwMachineNumber,
ref int
dwValue);
Parameters
dwMachineNumber
dwValue

: Target machine ID.

: [OUT]Current door status of the machine.
1 : Forced open
2 : Forced close
3 : Open
4 : Auto recover.
5 : Close
6 : Watching for Close
7 : Illegal Open.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

3.44 SetDoorStatus
Sets the door status of the machine.
Syntax(C++)
BOOL SetDoorStatus(
long
dwMachineNumber,
long
dwValue);
Syntax(C#)
bool SetDoorStatus(
int
dwMachineNumber,
int
dwValue);
Parameters
dwMachineNumber
dwValue

: Target machine ID.

: New door status of the machine.
1 : Forced open
2 : Forced close
3 : Program open
4 : Auto recover.
5 : Reboot
6 : Cancel Warning.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

- 34 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.45 GetBellTime
Gets the ringing time of the machine.
Syntax(C++)
BOOL GetBellTime(
long
dwMachineNumber,
long*
dwValue,
long*
dwBellInfo);
Syntax(C#)
bool GetBellTime(
int
dwMachineNumber,
ref int
dwValue,
ref int
dwBellInfo);
Parameters
dwMachineNumber
dwValue
dwBellInfo

: Target machine ID.

: [OUT]Current ringing count. (1~12)
:[OUT] The repository for ringing times. 12 ringing times are allowed. 3 bytes
(Validation flag, hour, minute) are required per a ringing time. So, dwBellInfo is
a pointer to 36 bytes array. See sample source for more detail.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
The structure of dwBellInfo depends on machine type, so please refer proper sample source code per
machine type.

3.46 SetBellTime
Sets the ringing time of the machine.
Syntax(C++)
BOOL SetBellTime(
long
dwMachineNumber,
long
dwValue,
long*
dwBellInfo);
Syntax(C#)
bool SetBellTime(
int
dwMachineNumber,
int
dwValue,
ref int
dwBellInfo);
Parameters
dwMachineNumber
dwValue
dwBellInfo

: Target machine ID.

: New ringing count. (1~12)
:The repository for ringing times. 12 ringing times are allowed. 3 bytes
(Validation flag, hour, minute) are required per a ringing time. So, dwBellInfo is
a pointer to 36 bytes array. See sample source for more detail.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
The structure of dwBellInfo depends on machine type, so please refer proper sample source code per
machine type.

- 35 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.47 ConnectSerial
Connects to the machine via the serial port(RS232, RS485) or USB.
Syntax(C++)
BOOL ConnectSerial(
long
dwMachineNumber,
long
dwCommPort,
long
dwBaudRate);
Syntax(C#)
bool ConnectSerial(
int
dwMachineNumber,
int
dwCommPort,
int
dwBaudRate);
Parameters
dwMachineNumber
dwCommPort

: Target machine ID.

: Communication port of the PC.

Value

Meaning

USB

COM1

COM2

COM3

COM4

dwBaudRate

: Baudrate of the communication port.

Value
9600
19200
38400
57600
115200

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

3.48 ConnectTcpip
Connects to the machine via the Ethernet (TCP/IP).
Syntax(C++)
BOOL ConnectTcpip(
long
dwMachineNumber,
BSTR*
lpszIPAddress,
long
dwPortNumber,
long
dwPassWord);
Syntax(C#)
bool ConnectTcpip(
int
dwMachineNumber,
ref string
lpszIPAddress,
- 36 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

int
int

dwPortNumber,
dwPassWord);

Parameters
dwMachineNumber
lpszIPAddress
dwPortNumber
dwPassword

: Target machine ID.

: IP address of the marching, string format.
: TCP Port number of the machine.
Default is 5005. This value must be 5005 for SB2880.
: Password for network communication.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

3.49 Disconnect
Disconnects the machine.
Syntax(C++)
Void

Disconnect(

void

Syntax(C#)
Void

Disconnect(

void

Parameters
None.
Return Values
None.

3.50 SetIPAddress (deprecated)

Set IP address of target machine. This function is called before call of OpenCommPort.
Syntax(C++)
BOOL SetIPAddress(
BSTR*
IPAddress,
long
dwPortNumber,
long
dwPassword);
Syntax(C#)
bool SetIPAddress(
ref string
IPAddress,
int
dwPortNumber,
int
dwPassword);
Parameters
IPAddress
dwPortNumber
dwPassword

: IP address of the marching, string format.

: TCP Port number of the machine.
Default is 5005. This value must be 5005 for SB2880.
: Password for network communication.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

3.51 OpenCommPort (deprecated)

Connects to the machine via the serial port (RS232, RS485) or USB or TCP/IP.
If client software changes CommPort or Baudrate property, then communication channel will be serial port.
If client software calls SetIPAddress, then communication channel will be TCP/IP.
- 37 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

Syntax(C++)
BOOL OpenCommPort(
long

dwMachineNumber);

bool OpenCommPort(
int

dwMachineNumber);

dwMachineNumber

:Target machine ID.

Syntax(C#)

Parameters

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

3.52 CloseCommPort (deprecated)

This is an alias of Disconnect.

3.53 GetLastError
Gets the last error code.
Syntax(C++)
void GetLastError(
long*

dwErrorCode);

void GetLastError(
ref long

dwErrorCode);

dwErrorCode

: [OUT] The repository for error code

Syntax(C#)

Parameters

Value

Meaning

Success.

Cannot open serial port.

Error on transmitting data.

Error on receiving data

Invalid parameter

Failure

No more data to parse.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

- 38 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.54 GetDeviceLongInfo(deprecated)
Gets a device parameter (big, its length > 4bytes) from the machine.
Syntax(C++)
BOOL GetDeviceLongInfo(
long
dwMachineNumber,
long
dwInfo,
long*
dwValue);
Syntax(C#)
bool GetDeviceLongInfo(
int
dwMachineNumber,
int
dwInfo,
ref int
dwValue);
Parameters
dwMachineNumber
dwInfo
dwValue

: Target machine ID.

: Type of the device parameter to get
: [OUT] The repository for the value of the device parameter. The data size is
variable depending on dwInfo.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
The data acquired by this function are the same as those shown on the Settings menu on the terminal
excepting the date separator.
Below are values of the setup information.
Value

Meaning

Data size

Daylight start time

16bytes

Daylight end time

16bytes

Time zone

6400bytes

Verification mode time zone

200bytes

- 39 -

Structure
array of long-type values(month, day,
hour, minute)
array of long-type values(month, day,
hour, minute)
(50 set) * (8 day/set) * (4 long-type
value/day)
Day : Sunday~Saturday,Holiday
Value : Start hour, Start minute, End
hour, End minute
(10 set) * (5 long-type value/set)
Value : Mode, Start hour, Start minute,
End hour, End minute
Mode :
0
FP or Card or PWD
1
FP & Card
2
FP & PWD
3
Card & PWD
4
FP & Card & PWD

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

Attendance status time zone

200bytes

Holiday

3072bytes

(10 set) * (5 long-type value/set)

value : Mode, Start hour, Start minute,
End hour, End minute
Mode :
0
duty on
1
duty off
2
overtime on
3
overtime off
4
go in
5
go out
(256 set) * (3 long-type value/set)
value : month, day, period
0 <= period<= 7
) If any one of month, day and period
is zero, the set is invalid.

3.55 SetDeviceLongInfo(deprecated)
Sets a device parameter (big, its length > 4bytes) to the machine.
Syntax(C++)
BOOL SetDeviceInfo(
long
long
long*

dwMachineNumber,
dwInfo,
dwValue);

bool SetDeviceInfo(
int
int
ref int

dwMachineNumber,
dwInfo,
dwValue);

Syntax(C#)

Parameters
dwMachineNumber
dwInfo
dwValue

: Target machine ID.

: Type of the device parameter to set, the meaning of this parameter is same
as in GetDeviceLongInfo.
: The repository for the value of the device parameter,the meaning of this
parameter is sameas in GetDeviceLongInfo.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

- 40 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

3.56 ModifyDuressFP(deprecated)
Modifies duress status of afingerprint.
Syntax(C++)
BOOL ModifyDuressFP (
long
dwMachineNumber,
long
dwEnrollNumber,
long
dwBackupNumber,
long
dwDuressSetting);
Syntax(C#)
bool ModifyDuressFP (
int
dwMachineNumber,
int
dwEnrollNumber,
int
dwBackupNumber,
int
dwDuressSetting);
Parameters
dwMachineNumber
dwEnrollNumber
dwBackupNumber
dwDuressSetting

: Target machine ID.

: User ID.
: fingerprint number, 0~9
: 0 Normal fingerprint, 1 duress fingerprint(alarm on verification).

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.

- 41 -

 2004-2012 TJI Prime Biometric.

4.

SBXPC Reference Manualv3.1

Next generation of SBXPC with XML

To support (almost) all products with same OCX, new specs will be implemented through GeneralOperationXML.
More spec modification is forbidden.

4.1

GeneralOperationXML

Send XML request & receive XML response.

Syntax(C++)
BOOL

GeneralOperationXML( BSTR FAR* lpszReqNResXML );

bool

GeneralOperationXML( ref string lpszReqNResXML );

Syntax(C#)
Parameters
lpszReqNResXML

: [IN] XML Request.

[OUT] XML Response.

Return Values
TRUE (nonzero): success.
FALSE (zero): failure.
Remarks
The syntax of XML request & XML response depend on machine type & operation.
Best reference is only sample source, please see proper sample source.
To make XML & parse XML, following helper functions are supported.
Syntax(MIDL)
long XML_ParseInt(BSTR* lpszXML, BSTR lpszTagname);
long XML_ParseLong(BSTR* lpszXML, BSTR lpszTagname);
boolean XML_ParseBoolean(BSTR* lpszXML, BSTR lpszTagname);
boolean XML_ParseString(BSTR* lpszXML, BSTR lpszTagname, BSTR* lpszValue);
boolean XML_ParseBinaryByte(BSTR* lpszXML, BSTR lpszTagname, BYTE* pData, long dwLen);
boolean XML_ParseBinaryWord(BSTR* lpszXML, BSTR lpszTagname, WORD* pData, long dwLen);
boolean XML_ParseBinaryLong(BSTR* lpszXML, BSTR lpszTagname, long* pData, long dwLen);
boolean XML_ParseBinaryUnicode(BSTR* lpszXML, LPCTSTR lpszTagname, BSTR* pData, long dwLen);
boolean XML_AddInt(BSTR* lpszXML, BSTR lpszTagname, int nValue);
boolean XML_AddLong(BSTR* lpszXML, BSTR lpszTagname, long dwValue);
boolean XML_AddBoolean(BSTR* lpszXML, BSTR lpszTagname, boolean bValue);
boolean XML_AddString(BSTR* lpszXML, BSTR lpszTagname, BSTR lpszValue);
boolean XML_AddBinaryByte(BSTR* lpszXML, BSTR lpszTagname, BYTE* dwData, long dwLen);
boolean XML_AddBinaryWord(BSTR* lpszXML, BSTR lpszTagname, WORD* dwData, long dwLen);
boolean XML_AddBinaryLong(BSTR* lpszXML, BSTR lpszTagname, long* dwData, long dwLen);
boolean XML_AddBinaryUnicode(BSTR* lpszXML, BSTR lpszTagname, BSTR* lpszData);
boolean XML_AddBinaryGlyph(BSTR* lpszXML, BSTR lpszMessage, long width, long height,
lpszFontDescriptor);
If an operation is supported through both raw & XML interface, then the XML interface is preferred.

- 42 -

BSTR

 2004-2012 TJI Prime Biometric.

5.

SBXPC Reference Manualv3.1

DLL mode support

To help native C++ developers & OCX-customers, SBXPC is separated intowrapper part (OCX format) and core part(DLL
format).
Below is its diagram.

The device

SBPCCOMM.DLL

SMACKBIO (Device Initial Setting Software)

SBXPCDLL.DLL
(Core Part)

DLL users (VC++, JAVA)

SBXPC.OCX
(Wrapper Part)

OCX Users (VB6, VB.NET, C#, Delphi)

For OCX users, SBXPC.OCX, SBXPCDLL.DLL,SBPCCOMM.DLLshould be installed in same folder.

For DLL users, SBXPCDLL.DLL,SBPCCOMM.DLLshould be installed in same folder.
SBXPC.OCX is deployed as source; this will help C++ developers & OCX-customers.
SMACKBIO guarantees binary-level compatibility for all versions of SBXPC.OCX.
SBXPCDLL_API.h describes C syntax of SBXPCDLL.DLL API.
All functions have same syntax as OCX interface, except for leading underscore.
SBXPCDLL.lib is import library for SBXPCDLL.DLL.
Below are notes for C++ developers.

If a BSTR* argument has __needfree specifier, C++ application SHOULD free return BSTR value using SysFreeString.
If a function has a VARIANT argument, C++ application SHOULD not use it.
If a function has _EXT suffix, it is for old SB3000 series, DO NOT TRY TO CALL IT.

- 43 -

 2004-2012 TJI Prime Biometric.

6.

SBXPC Reference Manualv3.1

Multi-device safe, Multi-thread safe support

One hosting program can make several OCX instances.

Several OCX instances will be distinguished by machine number, that is, different OCX instances must connect to the
different machine ID.
This means that SBXPC is multi-device safe.
Moreover each OCX instances can be controlled concurrently.
This means that SBXPC is multi-thread safe.

7.

"TCP active connection" mode support

There is a condition where the device cannot accept TCP/IP connection from the PC.
In this condition SBXPC accepts TCP/IP connection from the device.
(This function is supported in EC500.)
To use "TCP active connection", the hosting program calls connection-establishment functions with target devices IP =
0.0.0.0.
Below is detailed description.
Changes from the previous version are as follows.
A new submenu item TCP connect mode has been created in Set IP menu.
When this parameter is set to Passive(default value), EC500 time clock works just same as before. (PC starts
connection.)

When this parameter is set to Active, user should set IP address parameter to 0.0.0.0 while calling
ConnectTcpip function.In this case, time clock starts TCP connection.

- 44 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

NOTE: As time clock tries to connect to PC in every 10s, it may take about 5~10s after you press Open button in
the above sample.

Setting value of
TCP connect mode option
Passive

Required parameters in time

clock
Time clocks TCP port number

Active

PCs IP address and TCP port

number

- 45 -

Required
parameters
in
ConnectTcpip function
Time clocks IP address and TCP
port number
PCs port number
(Set IP address to 0.0.0.0)

 2004-2012 TJI Prime Biometric.

8.

SBXPC Reference Manualv3.1

P2P (Peer To Peer) support

Before, to connect to a device through TCP/IP, the user must know the devices IP address.
Therefore controlling of the device through the Internet was impossible, because the device cannot have public IP address.
P2P mode resolves such problem.
Premise:There is a global server with public IP, the server supports global bridge service. Theoretically, it is need only one
server in the Earth.
Users activity:

No change for management software excepting connection-establishment part.

When connecting to the device, enter [Servers public IP & TCP port] and [The devices global unique ID, 8bytes].
The user can see the devices global unique ID at the diagnostics screen which appeared when press ESC (or MENU)
key while booting.
S100
S300

The device is configured as using DHCP. The device is connected to the Internet. The device has menu item to
enter [Servers public IP & TCP port].

Technical Insight:

Relay Connection
Global Server

Internet
Router

P2P Connection

Router

User

Device

- 46 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

The server makes best effective connection (P2P connection) between the user PC & the device. If the P2P connection is once
established, the server does not interfere.
For example, if both the user PC & the device are in same LAN, the P2P connection will be established without the Internet.
If P2P connection was not established for some reason (firewall, NAT configuration), the server relays between the user PC &
the device, this connection is relay connection.
Maybe, relay connections speed is lower than P2P connection.
New OCX interface is as below.

8.1

ConnectP2p

Establish P2P connection.

Syntax(C++)
long ConnectP2p(
BSTR* lpszMachineID,
BSTR*lpszServerIPAddress,
long dwServerPortNumber,
long dwPassWord,
long* pnError);
Syntax(C#)
int
ref
ref
int
int
ref

ConnectP2p(
string lpszMachineID,
string lpszServerIPAddress,
dwServerPortNumber,
dwPassWord,
int pnError);

Parameters
lpszMachineID
lpszServerIPAddress
dwServerPortNumber
dwPassWord
pnError

: [IN] The devices global unique ID, 8bytes hexadecimal string. For example,
15FADA4F825D1010
: [IN] The servers IP address.
: [IN] The servers TCP port number. Default value is 4000.
: [IN] The devices communication password.
: [OUT] Extended error value.

Value

Meaning

The connection is P2P connection

established.
Unknown error if connection failed.

Connection failed, Cannot connect to the server

Connection failed, Device not found

Connection failed, Password mismatched

Connection established, but relayed connection

Connection established, but direct local connection (the

user PC & the device are in same LAN or the device has
public IP.)

if

connection

Return Values
Nonzero (0x10001 ~ 0x1FFFF): success.Connection established. The return value is OCX Device ID.
0: failure. Connection failed
Remarks
The return value is OCX Device ID. This mean that all subsequent OCX calls must use this returned OCX
Device ID for dwMachineNumber parameter.

- 47 -

 2004-2012 TJI Prime Biometric.

SBXPC Reference Manualv3.1

Appendix 1. Specific Machine Functionality

+ refers to support, empty refers to NOT support

Machines
Methods
1 GetEnrollData/
GetEnrollData1
2 SetEnrollData/
SetEnrollData1
3 DeleteEnrollData
4 ReadSuperLogData
5 GetSuperLogData
6 ReadGeneralLogData
7 GetGeneralLogData
8 ReadAllSLogData
9 GetAllSLogData
10 ReadAllGLogData
11 GetAllGLogData
12 GetDeviceStatus
13 GetDeviceInfo
14 SetDeviceInfo
15 EnableDevice
16 EnableUser
17 GetDeviceTime
18 SetDeviceTime
19 PowerOnAllDevice
20 PowerOffDevice
21 ModifyPrivilege
22 ReadAllUserID
23 GetAllUserID
24 GetSerialNumber
25 GetBackupNumber
26 GetProductCode
27 ClearKeeperData
28 EmptyEnrollData
29 EmptyGeneralLogData
30 EmptySuperLogData
31 GetUserName/
GetUserName1
32 SetUserName/
SetUserName1
33 GetCompanyName/
GetCompanyName1
34 SetCompanyName/
SetCompanyName1
35 GetDoorStatus
36 SetDoorStatus
37 GetBellTime
38 SetBellTime
39 ConnectSerial
40 ConnectTcpip
41 Disconnect
42 SetIPAddress
43 OpenCommPort

S100
(SB2900)

S300
(SB2960)

SB3600

SB2910
(EC500)

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+
+

+
+
+
+
+
+
+
+
+
+
+
- 48 -

 2004-2012 TJI Prime Biometric.

44
45
46
47
48
49
50
51
52
53
54
55
56

SBXPC Reference Manualv3.1

CloseCommPort
GetLastError
GeneralOperationXML
GetDeviceLongInfo
SetDeviceLongInfo
ModifyDuressFP
GetMachineIP
GetDepartName
SetDepartName
StartEventCapture
StopEventCapture
OnReceiveEventXML
ConnectP2p
Machines

Methods

+
+
+
+
+
+

+
+
+
+
+
+

+
+
+
+
+
+

+
+
+
+

+
+
+
+
+
+

+
+
+
+
+
+

S100
(SB2900)

S300
(SB2960)

SB3600

Appendix 2. Miscellaneous Items

OCX registration in WIN7

How to view logged photo in SB3600

- 49 -

+
+
+

+
+
+
+
SB2910
(EC500)