Skip to content

Commit a4698e8

Browse files
TylerMSFTTylerMSFT
andauthored
remove experimental (#4902)
* remove experimental * acrolinx --------- Co-authored-by: TylerMSFT <[email protected]>
1 parent 31395ee commit a4698e8

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed
Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
---
22
description: "Learn more about: directory_iterator Class"
33
title: "directory_iterator Class"
4-
ms.date: 06/10/2022
5-
f1_keywords: ["filesystem/std::experimental::filesystem::directory_iterator", "filesystem/std::experimental::filesystem::_Directory_iterator::_Directory_iterator", "filesystem/std::experimental::filesystem::directory_iterator::directory_iterator", "filesystem/std::experimental::filesystem::directory_iterator::increment", "filesystem/std::experimental::filesystem::directory_iterator::operator=", "filesystem/std::experimental::filesystem::directory_iterator::operator==", "filesystem/std::experimental::filesystem::directory_iterator::operator!=", "filesystem/std::experimental::filesystem::directory_iterator::operator*", "filesystem/std::experimental::filesystem::directory_iterator::operator->", "filesystem/std::experimental::filesystem::directory_iterator::operator++"]
4+
ms.date: 04/28/2023
5+
f1_keywords: ["filesystem/std::filesystem::directory_iterator", "filesystem/std::filesystem::_Directory_iterator::_Directory_iterator", "filesystem/std::filesystem::directory_iterator::directory_iterator", "filesystem/std::filesystem::directory_iterator::increment", "filesystem/std::filesystem::directory_iterator::operator=", "filesystem/std::filesystem::directory_iterator::operator==", "filesystem/std::filesystem::directory_iterator::operator!=", "filesystem/std::filesystem::directory_iterator::operator*", "filesystem/std::filesystem::directory_iterator::operator->", "filesystem/std::filesystem::directory_iterator::operator++"]
66
ms.assetid: dca2ecf8-3e69-4644-a83d-705061e10cc8
7-
helpviewer_keywords: ["std::experimental::filesystem::directory_iterator", "std::experimental::filesystem::_Directory_iterator::_Directory_iterator", "std::experimental::filesystem::directory_iterator", "std::experimental::filesystem::directory_iterator::directory_iterator", "std::experimental::filesystem::directory_iterator::increment", "std::experimental::filesystem::directory_iterator::operator=", "std::experimental::filesystem::directory_iterator::operator==", "std::experimental::filesystem::directory_iterator::operator!=", "std::experimental::filesystem::directory_iterator::operator*", "std::experimental::filesystem::directory_iterator::operator->", "std::experimental::filesystem::directory_iterator::operator++"]
7+
helpviewer_keywords: ["std::filesystem::directory_iterator", "std::filesystem::_Directory_iterator::_Directory_iterator", "std::filesystem::directory_iterator", "std::filesystem::directory_iterator::directory_iterator", "std::filesystem::directory_iterator::increment", "std::filesystem::directory_iterator::operator=", "std::filesystem::directory_iterator::operator==", "std::filesystem::directory_iterator::operator!=", "std::filesystem::directory_iterator::operator*", "std::filesystem::directory_iterator::operator->", "std::filesystem::directory_iterator::operator++"]
88
ms.custom: devdivchpfy22
9-
109
---
11-
# directory_iterator Class
10+
11+
# `directory_iterator` class
1212

1313
Describes an input iterator that sequences through the filenames in a directory. For an iterator `X`, the expression `*X` evaluates to an object of class `directory_entry` that wraps the filename and anything known about its status.
1414

1515
The class stores an object of type `path`, called `mydir` here for the purposes of exposition, which represents the name of the directory to be sequenced, and an object of type `directory_entry` called `myentry` here, which represents the current filename in the directory sequence. A default constructed object of type `directory_entry` has an empty `mydir` pathname and represents the end-of-sequence iterator.
1616

1717
For example, given the directory `abc` with entries `def` and `ghi`, the code:
1818

19-
`for (directory_iterator next(path("abc")), end; next != end; ++next) visit(next->path());`
19+
`for (directory_iterator next(path("abc")), end; next != end; ++next) visit(next->path());`
2020

21-
will call `visit` with the arguments `path("abc/def")` and `path("abc/ghi")`.
21+
calls `visit` with the arguments `path("abc/def")` and `path("abc/ghi")`.
2222

2323
For more information and code examples, see [File System Navigation (C++)](../standard-library/file-system-navigation.md).
2424

@@ -32,34 +32,34 @@ class directory_iterator;
3232

3333
|Constructor|Description|
3434
|-|-|
35-
|[directory_iterator](#directory_iterator)|Constructs an input iterator that sequences through the filenames in a directory.|
35+
|[`directory_iterator`](#directory_iterator)|Constructs an input iterator that sequences through the filenames in a directory.|
3636

3737
### Member functions
3838

3939
|Member function|Description|
4040
|-|-|
41-
|[increment](#increment)|Attempts to advance to the next filename in the directory.|
41+
|[`increment`](#increment)|Attempts to advance to the next filename in the directory.|
4242

4343
### Operators
4444

4545
|Operator|Description|
4646
|-|-|
47-
|[operator!=](#op_neq)|Returns `!(*this == right)`.|
48-
|[operator=](#op_as)|The defaulted member assignment operators behave as expected.|
49-
|[operator==](#op_eq)|Returns **`true`** only if both **`*this`** and *right* are end-of-sequence iterators or both aren't end-of-sequence-iterators.|
50-
|[operator*](#op_star)|Returns `myentry`.|
51-
|[operator->](#op_cast)|Returns `&**this`.|
52-
|[operator++](#op_increment)|Calls `increment()`, then returns **`*this`**, or makes a copy of the object, calls `increment()`, then returns the copy.|
47+
|[`operator!=`](#op_neq)|Returns `!(*this == right)`.|
48+
|[`operator=`](#op_as)|The defaulted member assignment operators behave as expected.|
49+
|[`operator==`](#op_eq)|Returns **`true`** only if both **`*this`** and *`right`* are end-of-sequence iterators or both aren't end-of-sequence-iterators.|
50+
|[`operator*`](#op_star)|Returns `myentry`.|
51+
|[`operator->`](#op_cast)|Returns `&**this`.|
52+
|[`operator++`](#op_increment)|Calls `increment()`, then returns **`*this`**, or makes a copy of the object, calls `increment()`, then returns the copy.|
5353

5454
## Requirements
5555

56-
**Header:** \<experimental/filesystem>
56+
**Header:** `<filesystem>`
5757

58-
**Namespace:** std::experimental::filesystem
58+
**Namespace:** `std::filesystem`
5959

60-
## <a name="directory_iterator"></a> directory_iterator::directory_iterator
60+
## <a name="directory_iterator"></a> `directory_iterator::directory_iterator`
6161

62-
The first constructor produces an end-of-sequence iterator. The second and third constructors store *pval* in `mydir`, then attempt to open and read `mydir` as a directory. If successful, they store the first filename in the directory in `myentry`; otherwise they produce an end-of-sequence iterator.
62+
The first constructor produces an end-of-sequence iterator. The second and third constructors store *`pval`* in `mydir`, then attempt to open and read `mydir` as a directory. If successful, they store the first filename in the directory in `myentry`; otherwise they produce an end-of-sequence iterator.
6363

6464
The default constructor behaves as expected.
6565

@@ -74,24 +74,24 @@ directory_iterator(directory_iterator&&) noexcept = default;
7474
7575
### Parameters
7676
77-
*pval*\
77+
*`pval`*\
7878
The stored file name path.
7979
80-
*ec*\
80+
*`ec`*\
8181
The status error code.
8282
83-
*directory_iterator*\
83+
*`directory_iterator`*\
8484
The stored object.
8585
86-
## <a name="increment"></a> directory_iterator::increment
86+
## <a name="increment"></a> `directory_iterator::increment`
8787
8888
The function attempts to advance to the next filename in the directory. If successful, it stores that filename in `myentry`; otherwise it produces an end-of-sequence iterator.
8989
9090
```cpp
9191
directory_iterator& increment(error_code& ec) noexcept;
9292
```
9393

94-
## <a name="op_neq"></a> directory_iterator::operator!=
94+
## <a name="op_neq"></a> `directory_iterator::operator!=`
9595

9696
The member operator returns `!(*this == right)`.
9797

@@ -101,10 +101,10 @@ bool operator!=(const directory_iterator& right) const;
101101

102102
### Parameters
103103

104-
*right*\
105-
The [directory_iterator](../standard-library/directory-iterator-class.md) being compared to the `directory_iterator`.
104+
*`right`*\
105+
The [`directory_iterator`](../standard-library/directory-iterator-class.md) being compared to the `directory_iterator`.
106106

107-
## <a name="op_as"></a> directory_iterator::operator=
107+
## <a name="op_as"></a> `directory_iterator::operator=`
108108

109109
The defaulted member assignment operators behave as expected.
110110

@@ -115,39 +115,39 @@ directory_iterator& operator=(directory_iterator&&) noexcept = default;
115115

116116
### Parameters
117117

118-
*right*\
119-
The [directory_iterator](../standard-library/directory-iterator-class.md) being copied into the `directory_iterator`.
118+
*`right`*\
119+
The [`directory_iterator`](../standard-library/directory-iterator-class.md) being copied into the `directory_iterator`.
120120

121-
## <a name="op_eq"></a> directory_iterator::operator==
121+
## <a name="op_eq"></a> `directory_iterator::operator==`
122122

123-
The member operator returns **`true`** only if both **`*this`** and *right* are end-of-sequence iterators or both aren't end-of-sequence-iterators.
123+
The member operator returns **`true`** only if both **`*this`** and *`right`* are end-of-sequence iterators or both aren't end-of-sequence-iterators.
124124

125125
```cpp
126126
bool operator==(const directory_iterator& right) const;
127127
```
128128

129129
### Parameters
130130

131-
*right*\
131+
*`right`*\
132132
The [directory_iterator](../standard-library/directory-iterator-class.md) being compared to the `directory_iterator`.
133133

134-
## <a name="op_star"></a> directory_iterator::operator*
134+
## <a name="op_star"></a> `directory_iterator::operator*`
135135

136136
The member operator returns `myentry`.
137137

138138
```cpp
139139
const directory_entry& operator*() const;
140140
```
141141

142-
## <a name="op_cast"></a> directory_iterator::operator->
142+
## <a name="op_cast"></a> `directory_iterator::operator->`
143143

144144
The member function returns `&**this`.
145145

146146
```cpp
147147
const directory_entry * operator->() const;
148148
```
149149

150-
## <a name="op_increment"></a> directory_iterator::operator++
150+
## <a name="op_increment"></a> `directory_iterator::operator++`
151151

152152
The first member function calls `increment()`, then returns **`*this`**. The second member function makes a copy of the object, calls `increment()`, then returns the copy.
153153

@@ -158,11 +158,11 @@ directory_iterator& operator++(int);
158158

159159
### Parameters
160160

161-
*int*\
161+
*`int`*\
162162
The number of increments.
163163

164164
## See also
165165

166+
[`<filesystem>`](../standard-library/filesystem.md)\
166167
[Header Files Reference](../standard-library/cpp-standard-library-header-files.md)\
167-
[\<filesystem>](../standard-library/filesystem.md)\
168168
[File System Navigation (C++)](../standard-library/file-system-navigation.md)

0 commit comments

Comments
 (0)