Skip to content

Commit 554d46d

Browse files
carlossanlopRon Petrusha
andcommitted
Automatically port IO.Enumeration.FileSystemName remark (#3185)
* Automatically port IO.Enumeration.FileSystemName remark * Remove top line * suggestions by rpetrusha Co-Authored-By: Ron Petrusha <[email protected]>
1 parent deff009 commit 554d46d

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

xml/System.IO.Enumeration/FileSystemName.xml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,17 @@
8787
<summary> Verifies if the given Win32 expression matches the given name. Supports the following wildcards: '*', '?', '&lt;', '&gt;', '"'. The backslash character '\' escapes.</summary>
8888
<returns>
8989
<see langword="true" /> if the given expression matches the given name; otherwise, <see langword="false" />.</returns>
90-
<remarks>To be added.</remarks>
90+
<remarks>
91+
<format type="text/markdown"><![CDATA[
92+
93+
## Remarks
94+
95+
The syntax of the `expression` parameter is based on the syntax used by <xref:System.IO.FileSystemWatcher>, which is based on [RtlIsNameInExpression](/windows/win32/devnotes/rtlisnameinexpression), which defines the rules for matching DOS wildcards (`'*'`, `'?'`, `'<'`, `'>'`, `'"'`).
96+
97+
Matching will not correspond to Win32 behavior unless you transform the expression using <xref:System.IO.Enumeration.FileSystemName.TranslateWin32Expression(System.String)>.
98+
99+
]]></format>
100+
</remarks>
91101
</Docs>
92102
</Member>
93103
<Member MemberName="TranslateWin32Expression">

0 commit comments

Comments
 (0)