platformfolders/4.2.0

A C++ library to look for special directories like My Documents and APPDATA so that you do not need to write Linux, Windows or Mac OS X specific code
Recipe info
2024-05-20

Available packages
Linux
Windows
macOS
macOS Apple Silicon

Install
Add the following line to your conanfile.txt:
[requires]
platformfolders/4.2.0

Using platformfolders

Note

If you are a new Conan user, we recommend reading the how to consume packages tutorial.

If you need additional assistance, please ask a question in the Conan Center Index repository.

Simplest use case consuming this recipe and assuming CMake as your local build tool:

[requires]
platformfolders/4.2.0
[generators]
CMakeDeps
CMakeToolchain
[layout]
cmake_layout
from conan import ConanFile
from conan.tools.cmake import cmake_layout


class ExampleRecipe(ConanFile):
    settings = "os", "compiler", "build_type", "arch"
    generators = "CMakeDeps", "CMakeToolchain"

    def requirements(self):
        self.requires("platformfolders/4.2.0")

    def layout(self):
        cmake_layout(self)

Now, you can run this Conan command to locally install (and build if necessary) this recipe and its dependencies (if any):

$ conan install conanfile.txt --build=missing

Useful information to take into account to consume this library:


These are the main declared targets:

  • CMake package name(s): platform_folders
  • CMake target name(s): sago::platform_folders
  • pkg-config file name(s): platformfolders.pc

A simple use case using the CMake file name and the global target:

# ...
find_package(platform_folders REQUIRED)
# ...
target_link_libraries(YOUR_TARGET sago::platform_folders)

These are all the available headers. Some of these ones might be non-public; make sure of it by visiting the platformfolders homepage listed above:

#include "sago/platform_folders.h"