diff options
Diffstat (limited to 'attic/doc/generated/struct_path_req_1_1relative.qbk')
-rw-r--r-- | attic/doc/generated/struct_path_req_1_1relative.qbk | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/attic/doc/generated/struct_path_req_1_1relative.qbk b/attic/doc/generated/struct_path_req_1_1relative.qbk new file mode 100644 index 00000000..79d962f4 --- /dev/null +++ b/attic/doc/generated/struct_path_req_1_1relative.qbk @@ -0,0 +1,73 @@ +[/============================================================================ + Boost.AFIO + + Use, modification and distribution is subject to 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) +=============================================================================/] + + +[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically] +[/ Generated from doxy/doxygen_output/xml\structboost_1_1afio_1_1path__req_1_1relative.xml] +[section:path_req_relative path_req::relative] +'''<?dbhtml-include href="disqus_identifiers/path_req_relative.html"?>''' + +'''<indexterm><primary>path_req</primary></indexterm><indexterm><primary>relative</primary></indexterm>''' +Convenience tag type constructing a relative path path_req. + +[heading Synopsis] +``struct path_req::relative + : public path_req +{ + bool is_relative; // Whether the precondition is also where this path begins. + boost::afio::path path; // The filing system path to be used for this operation. + file_flags flags; // The flags to be used for this operation (note they can be overriden by flags passed during dispatcher construction). + future precondition; // An optional precondition for this operation +}; +`` + +[heading Constructor(s)] +[table +[[Function] [Description] [Parameters] ] +[[``template<class T> +relative(future<> _precondition, T && _path, file_flags _flags = file_flags::none)`` + +] [Constructs an instance. ] [[* future<>]: ['_precondition]: The precondition for this operation. + +[* T &&]: ['_path]: The filing system path to be used. + +[* file_flags]: ['_flags]: The flags to be used. + + + +]] +[[``relative(future<> _precondition, file_flags _flags = file_flags::none)`` + +] [Constructs an instance. ] [[* future<>]: ['_precondition]: The precondition for this operation. + +[* file_flags]: ['_flags]: The flags to be used. + + + +]] +] + +[heading Member Function(s)] +[table +[[Function] [Description] [Parameters] [Returns]] +[[``bool validate()`` + +] [Validates contents. ] [ + +][ + +] +] +] + +[heading Header] +`#include <boost/afio/v2/afio.hpp>` + +'''<?dbhtml-include href="disqus_comments.html"?>''' +[endsect] + |