Visual StudioでCMakeを使う時に知っておきたいCMAKE_VS_SDK_LIBRARY_DIRECTORIES

CMAKE_VS_SDK_LIBRARY_DIRECTORIES は、Visual Studio で生成されるプロジェクトファイルで使用されるライブラリディレクトリを指定する CMake 変数です。この変数を設定することで、Visual Studio 標準のライブラリ検索パスを上書きし、プロジェクトに必要なライブラリを確実にリンクすることができます。

詳細

• バージョン: CMake 3.12 以降で利用可能
• データ型: パス名のリスト
• デフォルト値: Visual Studio のバージョンと構成によって異なる
• 使用例:

set(CMAKE_VS_SDK_LIBRARY_DIRECTORIES
  "C:/Program Files/Microsoft Visual Studio/2022/BuildTools/VC/redist/MSVC/14.30.30704/lib"
  "C:/Program Files/Microsoft Visual Studio/2022/Community/VC/redist/MSVC/14.30.30704/lib/x64"
)

target_link_libraries(my_target
  ${CMAKE_VS_SDK_LIBRARY_DIRECTORIES}/my_library.lib
)

設定方法

• CMakeLists.txt ファイル内で set() コマンドを使用して設定
• cmake-gui や ccmake などの CMake GUI ツールを使用して設定

注意点

• この変数は Visual Studio でのみ使用可能
• 設定するパス名は、Visual Studio のバージョンと構成に一致する必要がある
• 誤ったパスを設定すると、リンクエラーが発生する可能性

補足

• CMAKE_VS_SDK_LIBRARY_DIRECTORIES は、CMAKE_VS_SDK_INCLUDE_DIRECTORIES と同様に、Visual Studio 標準の検索パスを上書きするために使用できます。
• 複数の Visual Studio バージョンをインストールしている場合は、それぞれのバージョンに対応する CMAKE_VS_SDK_LIBRARY_DIRECTORIES 変数を設定する必要があります。
• 詳細については、上記の参考資料を参照してください。

CMAKE_VS_SDK_LIBRARY_DIRECTORIES 変数を使ったサンプルコード

set(CMAKE_VS_SDK_LIBRARY_DIRECTORIES
  "C:/My/Custom/Libraries"
)

target_link_libraries(my_target
  my_library
)

この例では、my_library ライブラリへのリンクに C:/My/Custom/Libraries ディレクトリが使用されます。

サンプル 2: 複数の Visual Studio バージョンに対応する

if(CMAKE_VS_VERSION_MAJOR EQUAL 16)
  set(CMAKE_VS_SDK_LIBRARY_DIRECTORIES
    "C:/Program Files/Microsoft Visual Studio/2022/BuildTools/VC/redist/MSVC/14.30.30704/lib"
    "C:/Program Files/Microsoft Visual Studio/2022/Community/VC/redist/MSVC/14.30.30704/lib/x64"
  )
else()
  set(CMAKE_VS_SDK_LIBRARY_DIRECTORIES
    "C:/Program Files/Microsoft Visual Studio/2019/BuildTools/VC/redist/MSVC/14.29.30037/lib"
    "C:/Program Files/Microsoft Visual Studio/2019/Community/VC/redist/MSVC/14.29.30037/lib/x64"
  )
endif()

target_link_libraries(my_target
  my_library
)

この例では、Visual Studio 2019 と 2022 の両方に対応するために、それぞれのバージョンに対応する CMAKE_VS_SDK_LIBRARY_DIRECTORIES 変数を設定しています。

サンプル 3: CMake GUI ツールを使用して設定する

• CMake GUI ツールを開き、プロジェクトファイルを選択します。
• "Cache" タブをクリックし、「CMAKE_VS_SDK_LIBRARY_DIRECTORIES」変数を検索します。
• 変数の値を編集し、「Apply」をクリックします。

• 上記のサンプルコードはあくまでも参考です。
• 実際の使用例は、プロジェクトの環境に合わせて調整する必要があります。

CMAKE_VS_SDK_LIBRARY_DIRECTORIES 変数を設定する他の方法

target_link_libraries() コマンドの LINK_DIRECTORIES オプションを使用して、ターゲットごとにライブラリディレクトリを指定することができます。

target_link_libraries(my_target
  my_library
  LINK_DIRECTORIES "C:/My/Custom/Libraries"
)

インクルードディレクトリ

CMAKE_VS_SDK_LIBRARY_DIRECTORIES は、インクルードディレクトリ (CMAKE_VS_SDK_INCLUDE_DIRECTORIES) と同様に設定できます。

set(CMAKE_VS_SDK_LIBRARY_DIRS
  "C:/My/Custom/Libraries"
)

list(APPEND CMAKE_VS_SDK_INCLUDE_DIRECTORIES ${CMAKE_VS_SDK_LIBRARY_DIRS})

target_link_libraries(my_target
  my_library
)

環境変数

VCVARSALL.BAT ファイルを実行して Visual Studio コマンドプロンプトを開き、LIB 環境変数を設定することで、プロジェクト全体にライブラリディレクトリを適用することができます。

set LIB=C:\My\Custom\Libraries

外部プロジェクトファイル

ExternalProject モジュールを使用して、外部プロジェクトファイルからライブラリディレクトリを取得することができます。

externalproject_add(my_library
  SOURCE_DIR "..."
  BUILD_COMMAND "..."
  INSTALL_COMMAND "..."
)

target_link_libraries(my_target
  ${my_library_LIBRARY}
)

手動設定

Visual Studio プロジェクトファイル (.vcxproj) を直接編集して、ライブラリディレクトリを設定することができます。

注意事項

• 上記の方法にはそれぞれメリットとデメリットがあります。
• 使用する方法は、プロジェクトの環境や要件に合わせて選択する必要があります。

CMAKE_VS_SDK_LIBRARY_DIRECTORIES 変数は、Visual Studio で生成されるプロジェクトファイルでライブラリディレクトリを指定するために便利な方法です。

上記の方法を参考に、プロジェクトに合った方法でライブラリディレクトリを設定してください。