ArcGIS Engine Developer Guide

C++ APPLICATION PROGRAMMING INTERFACE
If desired, you can utilize the template
Makefile.Windows provided with ArcGIS Engine
in ArcGIS Developer Help. Refer to the next
section for details on this sample file.
These steps assume that you have installed to
the default location. If you didn’t install to the
default location, find and use your install location
to add the \include\CPPAPI and \Com folders as
include directories.
The template makefile, Makefile.Windows, can
be found in ArcGIS Developer Help under
Development Environments > C++ > Makefiles.
The comment text used here to describe the
code of the makefile has been modified from the
actual comments within the file to reflect the
steps being taken.
Although the compiler options have already been
set in the template, the line is included here to
illustrate the use of the built-in CPPFLAGS
macro.
This line was also shown in Step 1 to illustrate
the update of the program name.
1. Use the /I compiler option to add
\Program Files\ArcGIS\include\CPPAPI and \Program Files\ArcGIS\Com
as additional include directories.
2. Use the /D compiler option to define the ESRI_WINDOWS symbol to direct
the compiler to read the Windows support headers from within
ArcSDK.h.
3. Use the /GX compiler flag to enable synchronous exception handling.
4. Use the /NOLOGO compiler flag to prevent display of a compiler
startup banner and informational compiler messages.
Customizing the template makefile
As a convenience, a template makefile—Makefile.Windows—is included with
ArcGIS Engine for your use. The following steps highlight the specific areas of
the file that must be customized for it to be used in your development process.
The modifications shown are based on an application that is written in single
code and header files, my_application.cpp and my_application.h, and produces an
executable that takes in a single file at runtime.
1. Throughout the makefile, update the program name, currently ‘basic_sample’,
to reflect your application name. In this example, my_application is the program
name.
# Set up the program name
PROGRAM = my_application.exe
…
# Program name updates — source and object file lists
CPPSOURCES = my_application.cpp
CPPOBJECTS = my_application.obj
…
# Program name updates – dependencies list
my_application.obj: my_application.cpp my_application.h
2. The compiler options outlined in Steps 2 through 4 above have been set for
you; however, you need to complete Step 1 yourself to prepare the template
for use in your applications.
…
# Setting up the include directories
INCLUDEDIRS = \
/I "C:\Program Files\ArcGIS\include\CPPAPI" \
/I "C:\Program Files\ArcGIS\Com"
…
# Setting up the compiler options
CPPFLAGS = /DESRI_WINDOWS $(INCLUDEDIRS) /nologo /GX
3. Provide dependencies lists for your application.
…
# Program name updates –- dependencies list
my_application.obj: my_application.cpp my_application.h
With your makefile prepared, you are ready to write your code. Don’t forget to
start by including ArcSDK.h!
216 • ArcGIS Engine Developer Guide