summaryrefslogtreecommitdiffstats
path: root/release_docs/USING_HDF5_VS.txt
blob: 6d69a143bd432e9bb5d2eb9dd0653c1fec5027ce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

***********************************************************************
*  HDF5 Build and Install Suggestions for Windows and Visual Studio   *
*                         (Full Version)                              *
***********************************************************************

These suggestions are for Visual Studio users.

Instructions for building and testing HDF5 applications using CMake can
be found in the USING_HDF5_CMake.txt file found in this folder.

NOTE: Building applications with the dynamic/shared hdf5 libraries requires
      that the "H5_BUILT_AS_DYNAMIC_LIB" compile definition be used.
      Go to "Project" and select "Properties", find "Configuration Properties",
      and then "C/C++"and then "Preprocessor".
      Add H5_BUILT_AS_DYNAMIC_LIB to Preprocessor definitions.

The following two sections are helpful if you do not use CMake to build
your applications.

==============================================================================================
Using Visual Studio 2010 and above with HDF5 Libraries built with Visual Studio 2010 and above
==============================================================================================

   1. Set up path for external libraries and headers

      The path settings will need to be in the project property sheets per project.
      Go to "Project" and select "Properties", find "Configuration Properties",
      and then "VC++ Directories".

      1.1 If you are building on 64-bit Windows, find the "Platform" dropdown
          and select "x64".

      1.2 Add the header path to the "Include Directories" setting.

      1.3 Add the library path to the "Library Directories" setting.

      1.4 Select Linker->Input and beginning with the
          "Additional Dependencies" line, enter the library names. The
          external libraries should be listed first, followed by the HDF5
          library, and then optionally the HDF5 High Level, Fortran or C++
          libraries. For example, to compile a C++ application, enter:

          hdf5.lib hdf5_cpp.lib

          For static linking:
            HDF5 libraries:        libhdf5.lib libhdf5_cpp.lib
            Compression libraries: libszaec.lib libaec.lib libzlib.lib
            System libraries:      shlwapi.lib


==========================================================================
Using Visual Studio 2008 with HDF5 Libraries built with Visual Studio 2008
==========================================================================

   2. Set up the path for external libraries and headers

      Invoke Microsoft Visual Studio and go to "Tools" and select "Options",
      find "Projects", and then "VC++ Directories".

      2.1 If you are building on 64-bit Windows, find the "Platform" dropdown
          and select "x64".

      2.2 Find the box "Show directories for", choose "Include files", add the
          header path (i.e. c:\Program Files\HDF_Group\HDF5\1.15.x\include)
          to the included directories.

      2.3 Find the box "Show directories for", choose "Library files", add the
          library path (i.e. c:\Program Files\HDF_Group\HDF5\1.15.x\lib)
          to the library directories.

      2.4 If using Fortran libraries, you will also need to setup the path
          for the Intel Fortran compiler.

      2.5 Select Project->Properties->Linker->Input and beginning with the
          "Additional Dependencies" line, enter the library names. The
          external libraries should be listed first, followed by the HDF5
          library, and then optionally the HDF5 High Level, Fortran or C++
          libraries. For example, to compile a C++ application, enter:

          hdf5.lib hdf5_cpp.lib

          For static linking:
            HDF5 libraries:        libhdf5.lib libhdf5_cpp.lib
            Compression libraries: libszaec.lib libaec.lib libzlib.lib
            System libraries:      shlwapi.lib

========================================================================
3. Helpful Pointers
========================================================================

    3.1 FAQ

    Community support forum available, please see:

       https://forum.hdfgroup.org/c/hdf5/8

************************************************************************
 Please send email to help@hdfgroup.org for further assistance.