Dcn Api; Introduction; Dcnapi.dll; Dcnole.exe - Bosch DCN Manual

External Interface Manual
5

DCN API

5.1

Introduction

Delegate information, which is normally modified by means of the Delegate Database application and stored
in the DCN database engine can be activated by selecting a names-file in the startup application. The
selected names-files will then be the current working environment for delegate information.
Two libraries (a 16 bits DLL and an OLE automation server, the one used depends on the preferences and
environment of the caller) provide the ability to download delegate information into the current working
environment. I.e. the information is NOT stored in the database but only in memory. The download overwrites
or replaces the names-file which is present in the current working environment.
5.1.1

DCNAPI.DLL

The standard 16 bits Windows DLL (DCNAPI.DLL) allows an external program to perform Apply operations
and to produce ID-cards and their labels. In order to use the API functions, the Delegate Database application
must be present (but not necessarily running). A C/C++ include file that prototypes the functions, defines
result codes and contains some C examples is provided with the DCN software (DCNAPI.H).
5.1.2

DCNOLE.EXE

To allow other applications (32 bit) to call the functions from DCNAPI.DLL, an OLE automation server exists
(DCNOLE.EXE). This automation server is a wrapper for the original DCNAPI.DLL, but because it is an OLE
automation server it is easier to use from 32 bits applications, e.g. Microsoft Office 97.
5.2

API functions

5.2.1

ApplyAll

DLL format:
WORD DCNAPI_ApplyAll(LPCSTR ImportFileName);
OLE automation server format:
long ApplyAll(LPCSTR ImportFileName);
Inputs:
ImportFileName
Return values:
DCNAPI_NOERROR
DCNAPI_ERROR_DCN_NOT_RUNNING
DCNAPI_ERROR_NO_AUTHORISATION
DCNAPI_ERROR_NO_APPLY_ALLOWED
DCNAPI_GENERALERROR
Description:
The ApplyAll function will import all delegates present in the specified import file. The newly imported names
file will become the new current names file in Startup as if it was opened using "Open names file" in the file
menu of Startup.
Note: Because the information that is imported in this manner is sent directly to the connected CCU it
is not added to the DCN database as a regular names file. Therefore this names file cannot be used in
the Delegate Database application.
Bosch Security Systems B.V. | 2004 April | External Interface Manual
Filename including the full path for an "Apply format" import-file.
This format is described in section 5.3.
There are no errors.
DCN is not running.
The Delegate Database application is not available.
This function is not currently permitted because:
• A voting round is currently running.
• Attendance Registration is active.
• The DCN is running off-line i.e. is not connected
to a running CCU.
An internal error has occurred. Make sure the
import file is in the correct format and the
communication with the CCU is ok.
en | 23