8000 Merge pull request #2280 from dotnet/master · shdvr/dotnet-api-docs@635a1db · GitHub
[go: up one dir, main page]
Skip to content

Commit 635a1db

Browse files
BillWagnerBillWagner
authored
Merge pull request dotnet#2280 from dotnet/master
Update live with current master
2 parents 2982b8c + f1c3d2a commit 635a1db

File tree

11 files changed

+81
-60
lines changed

11 files changed

+81
-60
lines changed

‎xml/Microsoft.VisualBasic/Interaction.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1331,7 +1331,7 @@ drawObj.SaveAs("C:\Drawings\sample.drw")
13311331
<param name="Wait">Optional. <see langword="Boolean" />. A value indicating whether the <see langword="Shell" /> function should wait for completion of the program. If <paramref name="Wait" /> is omitted, <see langword="Shell" /> uses <see langword="False" />.</param>
13321332
<param name="Timeout">Optional. <see langword="Integer" />. The number of milliseconds to wait for completion if <paramref name="Wait" /> is <see langword="True" />. If <paramref name="Timeout" /> is omitted, <see langword="Shell" /> uses -1, which means there is no timeout and <see langword="Shell" /> does not return until the program finishes. Therefore, if you omit <paramref name="Timeout" /> or set it to -1, it is possible that <see langword="Shell" /> might never return control to your program.</param>
13331333
<summary>Runs an executable program and returns an integer containing the program's process ID if it is still running.</summary>
1334-
<returns>Runs an executable program and returns an integer containing the program's process ID if it is still running.</returns>
1334+
<returns>An integer containing the program's process ID if it is still running. 0 if the program already finished executing.</returns>
13351335
<remarks>
13361336
<format type="text/markdown"><![CDATA[
13371337
@@ -1467,4 +1467,4 @@ ID = Shell("""C:\Program Files\display.exe"" -a -q", , True, 100000)
14671467
</Docs>
14681468
</Member>
14691469
</Members>
1470-
</Type>
1470+
</Type>

‎xml/System.IO/File.xml

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1332,15 +1332,18 @@
13321332
13331333
## Remarks
13341334
The <xref:System.IO.File.Decrypt%2A> method allows you to decrypt a file that was encrypted using the <xref:System.IO.File.Encrypt%2A> method. The <xref:System.IO.File.Decrypt%2A> method can decrypt only files that were encrypted using the current user account.
1335-
1335+
1336+
> [!IMPORTANT]
1337+
> This API is only supported on Windows platforms that are able to use the NTFS Encrypting File System (EFS). Any attempt to use this on non-Windows systems, Windows Home Edition systems, or non-NTFS drives results in a <xref:System.PlatformNotSupportedException> or <xref:System.NotSupportedException>, depending on the situation.
1338+
>
1339+
> Use of this API in .NET Core is not recommended; it is included to enable portability for applications that move to .NET Core but still explicitly target Windows.
1340+
13361341
The <xref:System.IO.File.Decrypt%2A> method requires exclusive access to the file being decrypted, and will raise an exception if another process is using the file. If the file is not encrypted, <xref:System.IO.File.Decrypt%2A> will return a nonzero value, which indicates success.
13371342
13381343
Both the <xref:System.IO.File.Encrypt%2A> method and the <xref:System.IO.File.Decrypt%2A> method use the cryptographic service provider (CSP) installed on the computer and the file encryption keys of the process calling the method.
13391344
13401345
The current file system must be formatted as NTFS and the current operating system must be Windows NT or later.
1341-
13421346
1343-
13441347
## Examples
13451348
The following code example uses the <xref:System.IO.File.Encrypt%2A> method and the <xref:System.IO.File.Decrypt%2A> method to encrypt and then decrypt a file. The file must exist for the example to work.
13461349
@@ -1511,10 +1514,14 @@
15111514
<summary>Encrypts a file so that only the account used to encrypt the file can decrypt it.</summary>
15121515
<remarks>
15131516
<format type="text/markdown"><![CDATA[
1514-
15151517
## Remarks
15161518
The <xref:System.IO.File.Encrypt%2A> method allows you to encrypt a file so that only the account used to call this method can decrypt it. Use the <xref:System.IO.File.Decrypt%2A> method to decrypt a file encrypted by the <xref:System.IO.File.Encrypt%2A> method.
1517-
1519+
1520+
> [!IMPORTANT]
1521+
> This API is only supported on Windows platforms that are able to use the NTFS Encrypting File System (EFS). Any attempt to use this on non-Windows systems, Windows Home Edition systems, or non-NTFS drives results in a <xref:System.PlatformNotSupportedException> or <xref:System.NotSupportedException>, depending on the situation.
1522+
>
1523+
> Use of this API in .NET Core is not recommended; it is included to enable portability for applications that move to .NET Core but still explicitly target Windows.
1524+
15181525
The <xref:System.IO.File.Encrypt%2A> method requires exclusive access to the file being encrypted, and will fail if another process is using the file.
15191526
15201527
Both the <xref:System.IO.File.Encrypt%2A> method and the <xref:System.IO.File.Decrypt%2A> method use the cryptographic service provider (CSP) installed on the computer and the file encryption keys of the process calling the method.
@@ -1523,8 +1530,6 @@
15231530
15241531
The current file system must be formatted as NTFS.
15251532
1526-
1527-
15281533
## Examples
15291534
The following code example uses the <xref:System.IO.File.Encrypt%2A> method and the <xref:System.IO.File.Decrypt%2A> method to encrypt and then decrypt a file. The file must exist for the example to work.
15301535

‎xml/System.IO/TextReader.xml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -163,9 +163,7 @@
163163
<format type="text/markdown"><![CDATA[
164164
165165
## Remarks
166-
This implementation of `Close` calls the <xref:System.IO.StringReader.Dispose%28System.Boolean%29?displayProperty=nameWithType> method and passes it a `true` value.
167-
168-
Flushing the text reader will not flush its underlying encoder unless you explicitly call `Close`. Setting the <xref:System.IO.StreamWriter.AutoFlush%2A?displayProperty=nameWithType> property to `true` means that data will be flushed from the buffer to the stream, but the encoder state will not be flushed. This allows the encoder to keep its state (partial characters) so that it can encode the next block of characters correctly. This scenario affects UTF8 and UTF7 where certain characters can be encoded only after the encoder receives the adjacent character or characters.
166+
This implementation of `Close` calls the <xref:System.IO.TextReader.Dispose%28System.Boolean%29?displayProperty=nameWithType> method and passes it a `true` value.
169167
170168
> [!NOTE]
171169
> In derived classes, do not override the <xref:System.IO.TextReader.Close%2A> method. Instead, override the <xref:System.IO.TextReader.Dispose%28System.Boolean%29?displayProperty=nameWithType> method to add code for releasing resources.

‎xml/System.Runtime.InteropServices/DllImportAttribute.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -238,14 +238,14 @@
238238
## Remarks
239239
You set this field to one of the <xref:System.Runtime.InteropServices.CallingConvention> enumeration members. The default value for the <xref:System.Runtime.InteropServices.DllImportAttribute.CallingConvention> field is <xref:System.Runtime.InteropServices.CallingConvention.Winapi>, which in turn defaults to <xref:System.Runtime.InteropServices.CallingConvention.StdCall> convention.
240240
241-
For more information, see Calling Convention in the MSDN library.
242-
243241
244242
245243
## Examples
246244
In some cases, Visual Basic developers use the <xref:System.Runtime.InteropServices.DllImportAttribute>, instead of the `Declare` statement, to define a DLL function in managed code. Setting the <xref:System.Runtime.InteropServices.DllImportAttribute.CallingConvention> field is one of those cases.
247245
248-
System.Runtime.InteropServices.DllImportAttribute#1
246+
[!code-cpp[System.Runtime.InteropServices.DllImportAttribute#1](~/samples/snippets/cpp/VS_Snippets_CLR_System/system.runtime.interopservices.dllimportattribute/cpp/source.cpp#1)]
247+
[!code-csharp[System.Runtime.InteropServices.DllImportAttribute#1](~/samples/snippets/csharp/VS_Snippets_CLR_System/system.runtime.interopservices.dllimportattribute/cs/source.cs#1)]
248+
[!code-vb[System.Runtime.InteropServices.DllImportAttribute#1](~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.runtime.interopservices.dllimportattribute/vb/source.vb#1)]
249249
250250
]]></format>
251251
</remarks>

‎xml/System.Security.Permissions/PrincipalPermission.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@
355355
</Parameters>
356356
<Docs>
357357
<param name="o">The <see cref="T:System.Security.Permissions.PrincipalPermission" /> object to compare with the current <see cref="T:System.Security.Permissions.PrincipalPermission" />.</param>
358-
<param name="obj">To be added.</param>
358+
<param name="obj">The <see cref="T:System.Security.Permissions.PrincipalPermission" /> object to compare with the current <see cref="T:System.Security.Permissions.PrincipalPermission" />.</param>
359359
<summary>Determines whether the specified <see cref="T:System.Security.Permissions.PrincipalPermission" /> object is equal to the current <see cref="T:System.Security.Permissions.PrincipalPermission" />.</summary>
360360
<returns>
361361
<see langword="true" /> if the specified <see cref="T:System.Security.Permissions.PrincipalPermission" /> is equal to the current <see cref="T:System.Security.Permissions.PrincipalPermission" /> object; otherwise, <see langword="false" />.</returns>

‎xml/System.Security.Permissions/RegistryPermission.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@
344344
<Docs>
345345
<param name="access">One of the <see cref="T:System.Security.Permissions.RegistryPermissionAccess" /> values.</param>
346346
<param name="actions">One of the <see cref="T:System.Security.AccessControl.AccessControlActions" /> values.</param>
347-
<param name="control">To be added.</param>
347+
<param name="control">One of the <see cref="T:System.Security.AccessControl.AccessControlActions" /> values.</param>
348348
<param name="pathList">A list of registry variables (separated by semicolons).</param>
349349
<summary>Adds access for the specified registry variables to the existing state of the permission, specifying registry permission access and access control actions.</summary>
350350
<remarks>
@@ -446,7 +446,7 @@
446446
</Parameters>
447447
<Docs>
448448
<param name="elem">The XML encoding to use to reconstruct the permission.</param>
449-
<param name="esd">To be added.</param>
449+
<param name="esd">The XML encoding to use to reconstruct the permission.</param>
450450
<summary>Reconstructs a permission with a specified state from an XML encoding.</summary>
451451
<remarks>To be added.</remarks>
452452
<exception cref="T:System.ArgumentNullException">The <paramref name="elem" /> parameter is <see langword="null" />.</exception>

‎xml/System.Security.Permissions/StrongNamePublicKeyBlob.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@
115115
</Parameters>
116116
<Docs>
117117
<param name="o">An object containing a public key blob.</param>
118-
<param name="obj">To be added.</param>
118+
<param name="obj">An object containing a public key blob.</param>
119119
<summary>Gets or sets a value indicating whether the current public key blob is equal to the specified public key blob.</summary>
120120
<returns>
121121
<see langword="true" /> if the public key blob of the current object is equal to the public key blob of the <paramref name="o" /> parameter; otherwise, <see langword="false" />.</returns>

0 commit comments

Comments
 (0)
0