Namespaces
Variants
Views
Actions

std::experimental::filesystem::is_regular_file

From cppreference.com
< cpp‎ | experimental‎ | fs
 
 
Experimental
Technical Specification
Filesystem library (filesystem TS)
Library fundamentals (library fundamentals TS)
Library fundamentals 2 (library fundamentals TS v2)
Library fundamentals 3 (library fundamentals TS v3)
Extensions for parallelism (parallelism TS)
Extensions for parallelism 2 (parallelism TS v2)
Extensions for concurrency (concurrency TS)
Extensions for concurrency 2 (concurrency TS v2)
Concepts (concepts TS)
Ranges (ranges TS)
Reflection (reflection TS)
Mathematical special functions (special functions TR)
Experimental Non-TS
Pattern Matching
Linear Algebra
std::execution
Contracts
2D Graphics
 
 
Defined in header <experimental/filesystem>
bool is_regular_file( file_status s );
(1) (filesystem TS)
bool is_regular_file( const path& p );
(2) (filesystem TS)
bool is_regular_file( const path& p, error_code& ec );
(3) (filesystem TS)

Checks if the given file status or path corresponds to a regular file.

1) Equivalent to s.type() == file_type::regular.
2) Equivalent to is_regular_file(status(p)).
3) Equivalent to is_regular_file(status(p, ec)). Returns false and sets ec to an appropriate error code if an error occurs. Otherwise, ec is cleared with a call to ec.clear().

Contents

[edit] Parameters

s - file status to check
p - path to examine
ec - error code to store the error status to

[edit] Return value

true if the given path or file status corresponds to a regular link, false otherwise.

[edit] Exceptions

1,3)
noexcept specification:  
noexcept
  
2) Throws filesystem_error if an error occurs. The error is constructed with p as an argument. The error code is set to an appropriate error code for the error that caused the failure.

[edit] See also