std::experi...ectory_path(3)

💅 std::experi...ectory_path(3) 💅

okay bestie, welcome to the C++ Standard Libary manual page for std::experi...ectory_path(3) — yes the title is literally truncated like that, and we are respectfully not fixing it 💖. This whole page is about std::experimental::filesystem::temp_directory_path, and its entire job is handing you a directory that's suitable for temporary files. Let's go 🦋.

✨ NAME ✨

std::experimental::filesystem::temp_directory_path - std::experimental::filesystem::temp_directory_path

🌸 Synopsis 🌸

Defined in header <experimental/filesystem>:

path temp_directory_path();                 (1) (filesystem TS)
path temp_directory_path( error_code& ec );

Returns the directory location suitable for temporary files.

🎀 Parameters 🎀

(none) — literally none, bestie. Nothing to pass here.

💖 Return value 💖

A directory suitable for temporary files. The path is guaranteed to exist and to be a directory. The overload that takes error_code& argument returns an empty path on error.

😭 Exceptions 😭

The overload that does not take an error_code& parameter throws filesystem_error on underlying OS API errors, constructed with path to be returned as the first argument and the OS error code as the error code argument. std::bad_alloc may be thrown if memory allocation fails.

The overload taking an error_code& parameter sets it to the OS API error code if an OS API call fails, and executes ec.clear() if no errors occur. This overload has noexcept specification: noexcept.

📝 Notes 📝

On POSIX systems, the path may be the one specified in the environment variables TMPDIR, TMP, TEMP, TEMPDIR, and, if none of them are specified, the path "/tmp" is returned. 🌈

On Windows systems, the path is typically the one returned by GetTempPath. 🪟

🌈 Example 🌈

// Run this code

        #include <experimental/filesystem>
        #include <iostream>
        namespace fs = std::experimental::filesystem;

        int main()
        {
            std::cout << "Temp directory is " << fs::temp_directory_path() <<
       '\n';
        }

Possible output:

        Temp directory is "C:\Windows\TEMP\"

👑 See also 👑

• tmpfile creates and opens a temporary, auto-removing file (function)

🏷️ Categories 🏷️

• Noindexed pages
• unconditionally noexcept

🙈 Hidden categories 🙈

• Pages with unreviewed unconditional noexcept template
• Pages with unreviewed noexcept template

---

that's the whole vibe, bestie 💜 this page came from http://cppreference.com, version 2024.06.10, and it's the std::experi...ectory_path(3) page. slay responsibly ✨