Skip to content

Commit 4cbb6ff

Browse files
JJSmairaw
authored andcommitted
Add casting remarks to EventLogInformation.Attributes (#1126) (#3358)
* Add casting remarks to EventLogInformation.Attributes (#1126) * Fix missing remarks tag (#1126) * Adjust remark text (#1126)
1 parent 3f703c4 commit 4cbb6ff

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

xml/System.Diagnostics.Eventing.Reader/EventLogInformation.xml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,18 @@
6060
<Docs>
6161
<summary>Gets the file attributes of the log file associated with the log.</summary>
6262
<value>Returns an integer value. This value can be null.</value>
63-
<remarks>To be added.</remarks>
63+
<remarks>
64+
<format type="text/markdown"><![CDATA[
65+
66+
## Remarks
67+
68+
The values of this property are the same as those of the <xref:System.IO.FileAttributes> type. To make working with this property easier, you can convert the value to that type using the following code:
69+
70+
[!code-csharp[System.Diagnostics.Eventing.Reader.EventLogInformation#1](~/samples/snippets/csharp/VS_Snippets_CLR_System/System.Diagnostics.Eventing.Reader.EventLogInformation/cs/attributes.cs#1)]
71+
[!code-vb[System.Diagnostics.Eventing.Reader.EventLogInformation#1](~/samples/snippets/visualbasic/VS_Snippets_CLR_System/System.Diagnostics.Eventing.Reader.EventLogInformation/vb/attributes.vb#1)]
72+
73+
]]></format>
74+
</remarks>
6475
<related type="Article" href="https://msdn.microsoft.com/library/d26107ee-7a80-44d7-b43b-cf774559e4ac">Technology Summary for Reading and Managing Event Logs</related>
6576
<related type="Article" href="https://msdn.microsoft.com/library/79377aba-b6e5-4e4d-a9be-ea25ce6f1dc5">Event Log Scenarios</related>
6677
</Docs>

0 commit comments

Comments
 (0)