shell_path.hpp

Go to the documentation of this file.

// Copyright (c) 2006, 2007 Julio M. Merino Vidal
// Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
// Copyright (c) 2009 Boris Schaeling
// Copyright (c) 2010 Felipe Tanus, Boris Schaeling
// Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 
/**
 * \file boost/process/shell_path.hpp
 *
 * Defines a function to return the absolute path to a shell executable.
 */
 
#pragma once
 
#include <boost/process/config.hpp>
 
#include BOOST_PROCESS_PLATFORM_PROMOTE_PATH(shell_path)
BOOST_PROCESS_PLATFORM_PROMOTE_NAMESPACE(shell_path)
 
#if defined(BOOST_PROCESS_DOXYGEN)
namespace boost::process
{
 
    /**
     * Returns the absolute path to a shell executable.
     *
     * \returns the path to cmd.exe on Windows and /bin/sh on POSIX.
     *
     * \throws boost::system::system_error in case of an error
     */
    std::filesystem::path shell_path();
 
    /**
     * Returns the absolute path to a shell executable.
     *
     * \returns the path to cmd.exe on Windows and /bin/sh on POSIX.
     */
    std::filesystem::path shell_path(boost::system::error_code& ec);
 
} // namespace boost::process
#endif