Lock System DLL Interface Specification

Lock System Interface Fucntion (SDK) Sepcification

(LockDLL.DLL Function Sepcification)
A. Function Sepcification
1. StartSession
Initialization, Function definition:
DWORD StartSession (LONG LockCard,LPSTR Server,LPSTR LogUser);
Parameter:
LockCard [in]: Assign Lock software, Refer to Remark 2.
Server [in]: Assign Server name (SQL Server) where lock system database insalled.
LogUser [in]: User Name, with it lock system will record opeators
Return Value: Refer to Remark 1.

2 EndSession
End session. Function definition:
DWORD EndSession (void);
Parameter: no
Return Value: Refer to Remark 1.

3. ChangeLogUser
Change operator. Function definition:
void ChangeLogUser (LPSTR LogUser);
Parameter:
LogUser [in]: User Name, with it lock system will record opeators
Return Value: no

4. NewKey
Issue new guest card, this funciton will erase existing guest cards, unlocking with the new
guest card, original guest cards will be terminated.
Function definition:
int NewKey(LONG Port ,LPSTR RoomNo,LPSTR CommonDoor,LPSTR
LiftFloor,LPSTR TimeStr,LPSTR Holder,LPSTR IDNo, LONG breakfast, LONG overflag,
LONG *CardNo);
Parameter:
Port [in]: Port of Encoder, Refer to Remark 4.
RoomNo [in]: Room Number, it must be the room number which set by lock system.
CommonDoor [in]: Common door, assign common door code, separate with comma
when one more common doors authorized, Example.: 001,002,003means
authrize 3 common doors of 001,002,003. Null allowed
LiftFloor [in]: Lift Floor, assign floor code, separate with comma when one more floors
authorized, Example.: 0001,0002,0003means authrize 3 floors of
0001,0002,0003. Null allowed
TimeStr [in]: Start and end time, format: yyyymmddhhnnyyyymmddhhnn, Example.:
200801011230200801051230means from 12:30 1 st, Jan.,2008 to 12:30 5th ,
1
July, 2011

Lock System DLL Interface Specification

Jan., 2008.
Holder [in]: Card holders name, Null allowed.
IDNo [in]: ID number of card holder, Null allowed.
breakfast [in]: Int, Breakfast flag. 1 - Yes, 0 No.
Overfla [in]: Int, Replace the data in current card or not. 1 - replace, erase automatically
current card if it is not a new card (must be Guest card); 0 do not
replace, return if it is not a new card.
Cardno [out]: Pointer to long int, receive card number (the sole code assigned when issue
card). Null allowed.
Return Value: Refer to Remark 1.

5. DupKey
Duplicate Guest card, when it is issued, the original guest card will not be affectted, both
them will unlocking, and their effective time is same.
Function definition:
int DupKey(LONG Port ,LPSTR RoomNo,LPSTR CommonDoor,LPSTR
LiftFloor,LPSTR TimeStr,LPSTR Holder,LPSTR IDNo, LONG breakfast, LONG overflag,
LONG *CardNo);
Parameter:
Refer to NewKey Function definition
Return Value: Refer to Remark 1.

6. ReadKeyCard
Read Card. Function definition:
int ReadKeyCard (LONG Port ,LPSTR RoomNo,LPSTR CommonDoor,LPSTR
LiftFloor,LPSTR TimeStr, LPSTR Holder, LPSTR IDNo,LONG *CardNo, LONG *Status, LONG
*Breakfast);
Parameter:
Port [in]: Port of Encoder, Refer to Remark 4.
RoomNo [out]: Receive returned room number. Null allowed
CommonDoor [out]: Receive returned authorized common door. Null allowed.
LiftFloor[out]: Receive returned authorized Lift Floor. Null allowed.
TimeStr[out]: Receive the cards validity term. Null allowed.
Holder [out]: Receive returned card holders name. Null allowed.
IDNo [out]: Receive returned ID number of card holder. Null allowed.
CardNo [out]: Pointer to long int, receive returned card number. Null allowed.
Status [out]: Pinter to int, Receive returned state of card.Refer to Remark3. Null
allowed.
Breakfast [out]: Pinter to int, Receive returned breakfast flag. Null allowed.
Return Value: refer to Remark 1.

7 EraseKeyCard
Erase card, at the same time, renew data in database. Function definition:
int EraseKeyCard (LONG Port,LONG CardNo);
2
July, 2011

Lock System DLL Interface Specification

Parameter:
Port [in]: Port of encoder. Refer to Remark 4.
CardNo [in]: Card number, 0 allowed. If parameter is o,then read card number
automatically and erase it.
Return Value: refer to Remark 1.

8. CheckOut
Check out, only renew data in database, do not erase card. Function definition:
int CheckOut (LPSTR RoomNo, LONG CardNo);
Parameter:
RoomNo [in]: Room number
CardNo [in]: Card number, 0allowed, If the parameter is 0, then all guest cards for
the room will be marked check-out
Return Value: Refer to Remark 1

9. ReadCardID
Read Card ID. Function definition:
int ReadCardID (LONG Port ,LONG *CardID);
Parameter:
Port [in]: Port of Encoder, Refer to Remark 4.
CardID [out]: Pointer to long int, receive returned card ID. Null allowed.
Return Value: refer to Remark 1.
Remark: 1. Return Value of Functions
0x00000000 - Successful Operation
0x8010000C - IC car not find
0x80100069 - Card removed
0x81100001 - Password erro
0x81100002 - Card damaged
0x81300001 - Communication erro
0xFFFF0001 - Card type erro
0xFFFF0002 - Card replaced
0xFFFF0003 - Blank card
0xFFFF0004 - Illegle card
0xFFFF0005 - Group Card
0xFFFF0006 - Blank group card
0xFFFF0007 - Not blank card
0xFFFF0008 - COM Port open erro
0xFFFF0009 - COM port communication erro.
0xFFFF1001 - Initialization function was not invoked
0xFFFF1002 - Defined guest not exist.
0xFFFF1003 - Card info not exist 0xFFFF1004 - Not guest ard
0xFFFF1005 - Wrong room no.
0xFFFF1006 - Wrong common door
0xFFFF3000 - SQL execution erro 0xFFFF3001 - SQL connect erro
0xFFFF3002 - System Parameter not exist 0xFFFF3003 - Wrong Serial Number
0xFFFF4000 - Interface authentication code not exist
3
July, 2011

Lock System DLL Interface Specification

0xFFFF4001 - Wrong interface authentication code

2. Constant of Lock System
Mifare lock system 1, Temic lock system 2
3. Card State Definition:
1 - Normall use
3 - Normall erase
4 - Lost erase
5 - Damage erase
6 - Auto erase
7 - Issue card erase
8 - Check-out erase
9 - Erase card erase
4. PORT Definition: 0-USB1-COM12-COM23-COM34-COM4 etc.
5. Invoke Method: According to Windows API standard stdcall.
6. Parameter Definiiton: [in] is input parameter,[out] is output parameter.

4
July, 2011

Lock System DLL Interface Specification

Funciones de la interfaz del sistema de bloqueo (SDK) Descripcin

(LockDLL.DLL descripcin de la funcin)
Nota especial: Esta funcin interfaz se utiliza directamente despus de la liberacin del
desarrollo secundario de software en el hotel tarjeta de cliente, gestin de seguridad y
Algunas tarjetas administradas se procesan en la cerradura y versin de software, las funciones
de interfaz necesitan para extraer informacin de las cerraduras de software de base de datos
durante la llamada, mientras que la emisin de la informacin para ser sincronizado para bloquear
el software, por lo que la necesidad de bloquear el software y la base de datos conexin. Si est
utilizando una versin independiente del software de bloqueo, software hotel debe utilizar el
software de bloqueo en el mismo equipo. Necesidad de utilizar ms de un ordenador, utilice la
versin de red de la cerradura de software. Por favor, consulte con el uso especfico de la funcin
de diferencia Descripcin (StartSession)
En primer lugar, la funcin Descripcin
1, StartSession
Funcin: inicializar, conexin a base de datos de software de bloqueo. Antes de otras llamadas
a funciones, primero debe realizar esta funcin.
Prototipo de la funcin:
DWORD StartSession (LARGO LockCard, LPSTR DBServer, LPSTR LOGUSER,
LARGO DBFlag);
Parmetros de la funcin:
LockCard [en]: Especifica el software de bloqueo, vase la nota 2.
DBFlag [en]: Bloqueo tipo de base de datos de software, 0 autnomo versin (ACCESS) 1Network Edition (MSSQL)
DBServer [en]: Especifica la instalacin de bases de datos del sistema de bloqueo de posicin.
ACCESO: El directorio de instalacin de software de bloqueo, como "C: \ Archivos de
programa \ XXX \ MHA V8.0 '.
MSSQL: SQL Server en el que el nombre del servidor.
LOGUSER [en]: nombre de usuario, por el operador del sistema de bloqueo de registro.
Devoluciones: Ver Nota 1.
2, EndSession
Funcin: final del perodo de trabajo.
Prototipo de la funcin:
DWORD EndSession (void);
Parmetros: Ninguno
Devoluciones: Ver Nota 1.
3, ChangeLogUser
Funcin: Cambia el operador.
Prototipo de la funcin:
5
July, 2011

Lock System DLL Interface Specification

anular ChangeLogUser (LPSTR LOGUSER);

Parmetros de la funcin:
LOGUSER [en]: nombre de usuario, por el operador del sistema de bloqueo de registro.
Devoluciones: Ninguno.

4, NewKey
Funcin: emitir nueva tarjeta de husped, esta funcin registra la tarjeta de cliente actual en
uso, despus de la emisin de la nueva tarjeta de invitado para abrir la puerta del original
No se utilizarn huspedes de la tarjeta.
Prototipo de la funcin:
int NewKey (LARGO Puerto, LPSTR RoomNo, LPSTR CommonDoor, LPSTR LiftFloor,
LPSTR TimeStr, Titular LPSTR, LPSTR idno, desayuno LARGO, overflag LARGO, LARGO
* Cardno);
Parmetros de la funcin:
Puerto [en]: emisin de interfaz de la mquina, vase la nota 4.
RoomNo [en]: el nmero de habitacin, debe ser fijado por el sistema bloquea el nmero de
habitacin.
CommonDoor [en]: canal, especifique el cdigo de canal, se autoriza a mltiples canales estn
divididos por comas.
Por ejemplo: "001002003" indica autorizados 001002003 tres canales. Puede ser NULL.
LiftFloor [en]: piso ascensor, cdigos pisos designados autorizar varios pisos estn separados
por comas.
Por ejemplo: "0001,0002,0003" indica autorizados 0001,0002,0003 tres plantas. Puede ser
NULL.
TimeStr [en]: inicio y hora de finalizacin, el formato yyyymmddhhnnyyyymmddhhnn,
Por ejemplo: "200801011230200801051230" representa a las 12:30 el 1 de enero de 2008 se
reparte al 2008
Sobre las 12:30 el 5 de enero.
Holder [en]: nombre del titular de la tarjeta, puede ser NULL.
Idno [en]: nmero de identificacin del titular, puede ser NULL.
desayuno [en]: plstico, bandera desayuno 1 - a 0 - no.
Overfla [en]: ciruga plstica, si desea sobrescribir el contenido de la tarjeta actual.
1- cubre la tarjeta actual no es una nueva tarjeta se cancela automticamente (debe ser la
tarjeta de husped).
0 - No cubra, no se devuelve la nueva tarjeta.
Cardno [out]: puntero entero largo, recibiendo el nmero de tarjeta (despus de emitir
asignado cdigo de tarjeta nica). Puede ser NULL.
Devoluciones: Ver Nota 1.
5, DupKey
Funcin: "Copiar" tarjeta de cliente, la nueva edicin de tarjetas de clientes con la tarjeta de
6
July, 2011

Lock System DLL Interface Specification

husped original puede ser utilizado de forma simultnea, y la hora de inicio

Lo mismo.
Prototipo de la funcin:
int DupKey (LARGO Puerto, LPSTR RoomNo, LPSTR CommonDoor, LPSTR LiftFloor,
LPSTR TimeStr, Titular LPSTR, LPSTR idno, desayuno LARGO, overflag LARGO, LARGO
* Cardno);
Parmetros de la funcin:
Ver descripcin de la funcin NewKey.
Devoluciones: Ver Nota 1.
6, ReadKeyCard
Funcin: lector.
Prototipo de la funcin:
int ReadKeyCard (LARGO Puerto, LPSTR RoomNo, LPSTR CommonDoor,
LPSTR LiftFloor, LPSTR TimeStr, LPSTR Holder, LPSTR idno, LONG * Cardno,
LARGO * Estado, LONG * Desayuno);
Parmetros de la funcin:
Puerto [en]: emisin de interfaz de la mquina, vase la nota 4.
RoomNo [out]: Devuelve el nmero de salas de recepcin, que puede ser NULL.
CommonDoor [out]: Devuelve la autorizacin recibida canal pblico, que puede ser NULL.
LiftFloor [out]: para recibir un piso ascensor de autorizacin de devolucin, que puede ser
NULL.
TimeStr [out]: la recepcin de la fecha de caducidad de la tarjeta, que puede ser NULL.
Holder [out]: Devuelve recibir el nombre del titular, que puede ser NULL.
Idno [out]: Devuelve los titulares de tarjetas recibidas nmero de identificacin, que puede ser
NULL.
Cardno [out]: puntero entero largo para recibir la devolucin del nmero de la tarjeta, que
puede ser NULL.
Estado [out]: punteros int, que reciben el regreso del estado de la tarjeta, vase la nota 3.
Puede ser NULL.
desayuno [out]: int punteros, recibi la bandera de desayuno puede ser NULL ..
Devoluciones: Ver Nota 1.
7, EraseKeyCard
Funcin: cancelacin de la tarjeta, y la base de datos de actualizacin de datos.
Prototipo de la funcin:
int EraseKeyCard (LARGO Puerto, LONG Cardno);
Parmetros de la funcin:
Puerto [en]: emisin de interfaz de la mquina, vase la nota 4.
Cardno [en]: el nmero de tarjeta, puede ser cero. Cuando este parmetro es 0: lee
automticamente la tarjeta y cierre la sesin.
Devoluciones: Ver Nota 1.
8, Salida
7
July, 2011

Lock System DLL Interface Specification

Funcin: Comprobar y los datos de base de datos al da solamente, tarjeta no se cancela.

Prototipo de la funcin:
int Caja (LPSTR RoomNo, LONG Cardno);
Parmetros de la funcin:
RoomNo [en]: el nmero de habitacin.
Cardno [en]: el nmero de tarjeta, puede ser cero. Cuando este parmetro es 0, que marcar la
tarjeta como habitaciones todas check-out.
Devoluciones: Ver Nota 1.
9, ReadCardID
Funcin: leer la tarjeta de identificacin.
Prototipo de la funcin:
int ReadCardID ((LARGO Puerto, LONG * CardID);
Parmetros de la funcin:
Puerto [en]: emisin de interfaz de la mquina, vase la nota 4.
CardID [out]: puntero entero largo para recibir la devolucin del nmero de identificacin de
la tarjeta, que puede ser NULL.
Devoluciones: Ver Nota 1.
Nota: En primer lugar, la funcin devuelve un valor:
0x00000000- operacin exitosa
Se retira 0x8010000C- no se detecta tarjeta 0x80100069- tarjeta IC
0x81100002- mquina de emisin de tarjetas no puede encontrar un 0x8010002E- daado
0xFFFF0001- tipo de tarjeta de error de la tarjeta 0xFFFF0002- se sustituye
0xFFFF0003- tarjeta en blanco 0xFFFF0004- tarjeta ilegal
0xFFFF0005- tarjeta en blanco tarjeta de grupo 0xFFFF0006- Grupo
0xFFFF0007- no la tarjeta en blanco 0xFFFF0008- error puerto abierto
0xFFFF0009- error de comunicacin en serie de errores 0xFFFF0011- contrasea
No 0xFFFF1001- llamar a la funcin de inicializacin 0xFFFF1002- especificadas no existen
los huspedes
Informacin de tarjeta de 0xFFFF1003- no existe 0xFFFF1004- tarjeta de husped
0xFFFF1005- nmero de habitacin equivocada 0xFFFF1006- canal equivocado
0xFFFF3000- ejecutar error de conexin Error SQL 0xFFFF3001- SQL
Nmero de serie 0xFFFF3003- usuario incorrecto de parmetros del sistema 0xFFFF3002- no
existe
0xFFFF4000- cdigo de autorizacin de interfaces no existe 0xFFFF4001- mal cdigo de
autorizacin interfaz
8
July, 2011

Lock System DLL Interface Specification

En segundo lugar, constantes del sistema de bloqueo:

Sistema de bloqueo de la tarjeta Mifare -2 -1 sistema de bloqueo de la tarjeta Temic
En tercer lugar, las descripciones de estado de la tarjeta:
1- normales 3- cancelacin de la normalidad
4- 5- daos cancelacin perdido cancelacin
6- 7- emisin cierre de sesin automtico de cierre de sesin
Compruebe 8- 9- cierre de sesin de cierre de sesin de cierre de sesin de tarjeta
En cuarto lugar, Puerto Descripcin: 0-USB, 1-COM1,2-COM2,3-COM3,4-COM4 y as
sucesivamente. NOTA: La cadena virtual de USB
Puerto COM al entrante favor consultar el nmero de serie de administrador de dispositivos
virtuales.
V. invocacin: siga las llamadas estndar API de Windows que stdcall.
Seis Parmetros: [en] como un parmetro de entrada, [fuera] como un parmetro de salida.
Siete ejemplos ilustran:
Por favor, consulte con el desarrollo de un ejemplo funcin de interfaz, siempre un ejemplo
del uso del software de la puerta ya instalado.
1, ejemplo DELPHI: '.. \ DelphiSample \ DLLSample.dpr'
2, C # ejemplo: '.. \ C # Muestra \ LockDllSample.csproj'

9
July, 2011