EKS.h File Reference

#include <Windows.h>
#include <stdexcept>

Go to the source code of this file.

Classes
class	EKSError

Macros
#define	EKSAPI   __declspec(dllexport) __stdcall

Enumerations
enum class	ResponseCode : BYTE {   SUCCESS = 0x00 , ERR_NO_KEY_DETECTED = 0x02 , ERR_PARITY_BIT = 0x03 , ERR_WRITE_BLOCKSIZE = 0x06 ,   ERR_CAN_ONLY_READ_R_KEYS = 0x17 , ERR_CAN_ONLY_READ_RW_KEYS = 0x18 , ERR_UNKNOWN = 0x40 , ERR_WRITE_PROTECTED = 0x50 ,   ERR_IO = 0xF1 , ERR_COMMUNICATION = 0xF2 , ERR_CONNECTION = 0xF3 , SUCCESS = 0x00 ,   ERR_NO_KEY_DETECTED = 0x02 , ERR_PARITY_BIT = 0x03 , ERR_WRITE_BLOCKSIZE = 0x06 , ERR_CAN_ONLY_READ_R_KEYS = 0x17 ,   ERR_CAN_ONLY_READ_RW_KEYS = 0x18 , ERR_UNKNOWN = 0x40 , ERR_WRITE_PROTECTED = 0x50 , ERR_IO = 0xF1 ,   ERR_COMMUNICATION = 0xF2 , ERR_CONNECTION = 0xF3 }

Functions
VOID EKSAPI	GetSysComm (BYTE *buffer)
HANDLE EKSAPI	OpenComm (unsigned char port, unsigned int baud_rate=9600)
VOID EKSAPI	CloseComm (HANDLE pCom)
DWORD EKSAPI	GetKeyStatus (HANDLE pCom)
DWORD EKSAPI	GetSerialNumber (HANDLE pCom, BYTE *buffer)
DWORD EKSAPI	ReadKeyData (HANDLE pCom, const BYTE startByte, const BYTE length, BYTE *buffer)
DWORD EKSAPI	WriteKeyData (HANDLE pCom, const BYTE startByte, const BYTE length, const BYTE *buffer)

Variables
constexpr ULONGLONG	timeout = 2000
constexpr BYTE	STX = 0x02
constexpr BYTE	ETX = 0x03
constexpr BYTE	DLE = 0x10
constexpr BYTE	NAK = 0x15
constexpr BYTE	CMD_SEND = 0x54
constexpr BYTE	CMD_RESPONSE = 0x52
constexpr BYTE	CMD_WRITE = 0x50
constexpr BYTE	CMD_READ = 0x4C
constexpr BYTE	CMD_RES_STATUS = 0x46

Macro Definition Documentation

EKSAPI

#define EKSAPI   __declspec(dllexport) __stdcall

Enumeration Type Documentation

ResponseCode

enum class ResponseCode : BYTE

strong

Enumerator
SUCCESS
ERR_NO_KEY_DETECTED
ERR_PARITY_BIT
ERR_WRITE_BLOCKSIZE
ERR_CAN_ONLY_READ_R_KEYS
ERR_CAN_ONLY_READ_RW_KEYS
ERR_UNKNOWN
ERR_WRITE_PROTECTED
ERR_IO
ERR_COMMUNICATION
ERR_CONNECTION
SUCCESS
ERR_NO_KEY_DETECTED
ERR_PARITY_BIT
ERR_WRITE_BLOCKSIZE
ERR_CAN_ONLY_READ_R_KEYS
ERR_CAN_ONLY_READ_RW_KEYS
ERR_UNKNOWN
ERR_WRITE_PROTECTED
ERR_IO
ERR_COMMUNICATION
ERR_CONNECTION

Function Documentation

CloseComm()

VOID EKSAPI CloseComm

(

HANDLE

pCom

)

GetKeyStatus()

DWORD EKSAPI GetKeyStatus

(

HANDLE

pCom

)

GetSerialNumber()

DWORD EKSAPI GetSerialNumber	(	HANDLE	pCom,
		BYTE *	buffer )

GetSysComm()

VOID EKSAPI GetSysComm

(

BYTE *

buffer

)

OpenComm()

HANDLE EKSAPI OpenComm	(	unsigned char	port,
		unsigned int	baud_rate = 9600 )

ReadKeyData()

DWORD EKSAPI ReadKeyData	(	HANDLE	pCom,
		const BYTE	startByte,
		const BYTE	length,
		BYTE *	buffer )

WriteKeyData()

DWORD EKSAPI WriteKeyData	(	HANDLE	pCom,
		const BYTE	startByte,
		const BYTE	length,
		const BYTE *	buffer )

Variable Documentation

CMD_READ

BYTE CMD_READ = 0x4C

constexpr

CMD_RES_STATUS

BYTE CMD_RES_STATUS = 0x46

constexpr

CMD_RESPONSE

BYTE CMD_RESPONSE = 0x52

constexpr

CMD_SEND

BYTE CMD_SEND = 0x54

constexpr

CMD_WRITE

BYTE CMD_WRITE = 0x50

constexpr

DLE

BYTE DLE = 0x10

constexpr

ETX

BYTE ETX = 0x03

constexpr

NAK

BYTE NAK = 0x15

constexpr

STX

BYTE STX = 0x02

constexpr

timeout

ULONGLONG timeout = 2000

constexpr