Alarm Management API Sample Program | CIMPLICITY 11 Documentation

Overview

A sample Microsoft Visual C++ project, named amaru_demo_exe.vcxproj, is provided to build the sample program. Use this project as a basis for constructing projects for your own applications.

Depending on how you installed Visual C++, the INCLUDE, LIB, and PATH environment variables may not be automatically set when you install MSDEV. If they are not set, you will have to set them manually or run the following to set them before building any user programs.

for /F "tokens=* USEBACKQ" %F in (`"%PROGRAMFILES(x86)%\Microsoft Visual Studio\Installer\vswhere.exe" -property installationPath`) do set VSPATH=%F call "%VSPATH%\Common7\Tools\VsDevCmd.bat"

When you run the demo program, it will generate an alarm, then reset it.

Build the Demo (Sample) Program

From the CIMPLICITY Workbench for your project, select Command Prompt from the Tools menu. This will ensure that your environment variables (in particular %BSM_ROOT% and %SITE_ROOT% ) are set correctly.
In the Command Prompt window, issue the following commands (where < drive > is the disk where your CIMPLICITY software is installed):
```
 < drive >: 
 cd %BSM_ROOT%\api 
```

(If the environment variables are not set automatically) issue the following command to set them:

for /F "tokens=* USEBACKQ" %F in (`"%PROGRAMFILES(x86)%\Microsoft Visual Studio\Installer\vswhere.exe" -property installationPath`) do set VSPATH=%F call "%VSPATH%\Common7\Tools\VsDevCmd.bat"

Launch Visual Studio:
```
devenv CimplicityAPI.sln
```
devenv CimplicityAPI.sln
Open the Solution Explorer.
Right click amaru_demo_exe.
Select Build on the Popup menu.

Run the Demo (Sample) Program

The API process name must be stored in the PRCNAM environment variable for the program to run. The name is an arbitrary character string of up to 10 characters. To create PRCNAM, enter the following command in the Command Prompt window:

 set PRCNAM=<name>

where < name > is the API process name.

To run the sample program, enter the following command in the Command Prompt window:

amaru_demo

Important: You must have a project running locally or the sample program will fail to run successfully.