Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
std::filesy...try::refresh(3) C++ Standard Libarystd::filesy...try::refresh(3)

NAME
       std::filesystem::directory_entry::refresh   -   std::filesystem::direc-
       tory_entry::refresh

Synopsis
	  void refresh();				 (since	C++17)
	  void refresh(	std::error_code& ec ) noexcept;

	  Examines the filesystem object referred to by	this  directory	 entry
       and stores its
	  attributes  for  retrieval with status, exists, is_regular_file, and
       other status
	  accessors.

	  If an	error occurs, the value	of any cached attributes  is  unspeci-
       fied.

Parameters
	  ec - out-parameter for error reporting in the	non-throwing overload

Return value
	  (none)

Exceptions
	  The overload that does not take a std::error_code& parameter throws
	  filesystem::filesystem_error	on  underlying	OS  API	 errors,  con-
       structed	with p as the
	  first	path argument and the OS error code as the  error  code	 argu-
       ment. The overload
	  taking a std::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. Any overload
       not marked
	  noexcept may throw std::bad_alloc if memory allocation fails.

Notes
	  Many low-level OS APIs for directory traversal retrieve file attrib-
       utes along with
	  the  next directory entry. The constructors and the non-const	member
       functions of
	  std::filesystem::directory_iterator store these attributes, if  any,
       in the
	  pointed-to std::filesystem::directory_entry without calling
	  directory_entry::refresh, which makes	it possible to examine the at-
       tributes	of the
	  directory  entries  as  they are being iterated over,	without	making
       additional system
	  calls.

Example
	   This	section	is incomplete
	   Reason: no example

See also
	  status	    status of the file designated  by  this  directory
       entry
	  symlink_status     symlink_status of the file	designated by this di-
       rectory entry
			    (public member function)
			    checks whether directory entry refers to  existing
       file system
	  exists	    object
			    (public member function)
	  is_block_file	    checks whether the directory entry refers to block
       device
			    (public member function)
	  is_character_file  checks  whether  the  directory entry refers to a
       character device
			    (public member function)
	  is_directory	    checks whether the directory entry refers to a di-
       rectory
			    (public member function)
	  is_fifo	    checks whether the directory  entry	 refers	 to  a
       named pipe
			    (public member function)
	  is_other	     checks  whether  the directory entry refers to an
       other file
			    (public member function)
	  is_regular_file   checks whether the directory  entry	 refers	 to  a
       regular file
			    (public member function)
	  is_socket	     checks  whether  the  directory entry refers to a
       named IPC socket
			    (public member function)
	  is_symlink	    checks whether the directory  entry	 refers	 to  a
       symbolic	link
			    (public member function)
	  file_size	     returns  the size of the file to which the	direc-
       tory entry refers
			    (public member function)
			    returns the	number of hard links referring to  the
       file to which
	  hard_link_count   the	directory entry	refers
			    (public member function)
			    gets  or  sets the time of the last	data modifica-
       tion of the file	to
	  last_write_time   which the directory	entry refers
			    (public member function)

http://cppreference.com		  2022.07.31	 std::filesy...try::refresh(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=std::filesystem::directory_entry::refresh&sektion=3&manpath=FreeBSD+Ports+15.0>

home | help