Skip to content

Commit cd2c333

Browse files
nxtnRon Petrusha
authored andcommitted
Update Windows API terms (#2301)
1 parent ab0d99a commit cd2c333

File tree

27 files changed

+52
-52
lines changed

27 files changed

+52
-52
lines changed

xml/Microsoft.Win32/RegistryValueKind.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
</ReturnValue>
8080
<MemberValue>3</MemberValue>
8181
<Docs>
82-
<summary>Binary data in any form. This value is equivalent to the Win32 API registry data type REG_BINARY.</summary>
82+
<summary>Binary data in any form. This value is equivalent to the Windows API registry data type REG_BINARY.</summary>
8383
</Docs>
8484
</Member>
8585
<Member MemberName="DWord">
@@ -109,7 +109,7 @@
109109
</ReturnValue>
110110
<MemberValue>4</MemberValue>
111111
<Docs>
112-
<summary>A 32-bit binary number. This value is equivalent to the Win32 API registry data type REG_DWORD.</summary>
112+
<summary>A 32-bit binary number. This value is equivalent to the Windows API registry data type REG_DWORD.</summary>
113113
</Docs>
114114
</Member>
115115
<Member MemberName="ExpandString">
@@ -139,7 +139,7 @@
139139
</ReturnValue>
140140
<MemberValue>2</MemberValue>
141141
<Docs>
142-
<summary>A null-terminated string that contains unexpanded references to environment variables, such as %PATH%, that are expanded when the value is retrieved. This value is equivalent to the Win32 API registry data type REG_EXPAND_SZ.</summary>
142+
<summary>A null-terminated string that contains unexpanded references to environment variables, such as %PATH%, that are expanded when the value is retrieved. This value is equivalent to the Windows API registry data type REG_EXPAND_SZ.</summary>
143143
</Docs>
144144
</Member>
145145
<Member MemberName="MultiString">
@@ -169,7 +169,7 @@
169169
</ReturnValue>
170170
<MemberValue>7</MemberValue>
171171
<Docs>
172-
<summary>An array of null-terminated strings, terminated by two null characters. This value is equivalent to the Win32 API registry data type REG_MULTI_SZ.</summary>
172+
<summary>An array of null-terminated strings, terminated by two null characters. This value is equivalent to the Windows API registry data type REG_MULTI_SZ.</summary>
173173
</Docs>
174174
</Member>
175175
<Member MemberName="None">
@@ -233,7 +233,7 @@
233233
</ReturnValue>
234234
<MemberValue>11</MemberValue>
235235
<Docs>
236-
<summary>A 64-bit binary number. This value is equivalent to the Win32 API registry data type REG_QWORD.</summary>
236+
<summary>A 64-bit binary number. This value is equivalent to the Windows API registry data type REG_QWORD.</summary>
237237
</Docs>
238238
</Member>
239239
<Member MemberName="String">
@@ -263,7 +263,7 @@
263263
</ReturnValue>
264264
<MemberValue>1</MemberValue>
265265
<Docs>
266-
<summary>A null-terminated string. This value is equivalent to the Win32 API registry data type REG_SZ.</summary>
266+
<summary>A null-terminated string. This value is equivalent to the Windows API registry data type REG_SZ.</summary>
267267
</Docs>
268268
</Member>
269269
<Member MemberName="Unknown">
@@ -293,7 +293,7 @@
293293
</ReturnValue>
294294
<MemberValue>0</MemberValue>
295295
<Docs>
296-
<summary>An unsupported registry data type. For example, the Microsoft Win32 API registry data type REG_RESOURCE_LIST is unsupported. Use this value to specify that the <see cref="M:Microsoft.Win32.RegistryKey.SetValue(System.String,System.Object)" /> method should determine the appropriate registry data type when storing a name/value pair.</summary>
296+
<summary>An unsupported registry data type. For example, the Microsoft Windows API registry data type REG_RESOURCE_LIST is unsupported. Use this value to specify that the <see cref="M:Microsoft.Win32.RegistryKey.SetValue(System.String,System.Object)" /> method should determine the appropriate registry data type when storing a name/value pair.</summary>
297297
</Docs>
298298
</Member>
299299
</Members>

xml/System.Diagnostics/EventLogEntry.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@
339339
## Remarks
340340
This value represents the event identifier for the entry in the event log, with the top two bits masked off. The <xref:System.Diagnostics.EventLogEntry.InstanceId%2A> property for an event log entry represents the full 32-bit resource identifier for the event in the message resource file for the event source. Two event log entries from the same source can have matching <xref:System.Diagnostics.EventLogEntry.EventID%2A> values, but have different <xref:System.Diagnostics.EventLogEntry.InstanceId%2A> values due to differences in the top two bits of the event identifier.
341341
342-
If the application wrote the event entry using one of the <xref:System.Diagnostics.EventLog.WriteEntry%2A> methods, the <xref:System.Diagnostics.EventLogEntry.EventID%2A> property matches the optional `eventId` parameter. If the application wrote the event using <xref:System.Diagnostics.EventLog.WriteEvent%2A> or the Win32 API `ReportEvent`, the <xref:System.Diagnostics.EventLogEntry.EventID%2A> property matches the resource identifier for the event, with the top two bits masked off.
342+
If the application wrote the event entry using one of the <xref:System.Diagnostics.EventLog.WriteEntry%2A> methods, the <xref:System.Diagnostics.EventLogEntry.EventID%2A> property matches the optional `eventId` parameter. If the application wrote the event using <xref:System.Diagnostics.EventLog.WriteEvent%2A> or the Windows API `ReportEvent`, the <xref:System.Diagnostics.EventLogEntry.EventID%2A> property matches the resource identifier for the event, with the top two bits masked off.
343343
344344
]]></format>
345345
</remarks>
@@ -430,7 +430,7 @@
430430
## Remarks
431431
The <xref:System.Diagnostics.EventLogEntry.InstanceId%2A> property uniquely identifies an event entry for a configured event source. The <xref:System.Diagnostics.EventLogEntry.InstanceId%2A> for an event log entry represents the full 32-bit resource identifier for the event in the message resource file for the event source. The <xref:System.Diagnostics.EventLogEntry.EventID%2A> property equals the <xref:System.Diagnostics.EventLogEntry.InstanceId%2A> with the top two bits masked off. Two event log entries from the same source can have matching <xref:System.Diagnostics.EventLogEntry.EventID%2A> values, but have different <xref:System.Diagnostics.EventLogEntry.InstanceId%2A> values due to differences in the top two bits of the resource identifier.
432432
433-
If the application wrote the event entry using one of the <xref:System.Diagnostics.EventLog.WriteEntry%2A> methods, the <xref:System.Diagnostics.EventLogEntry.InstanceId%2A> property matches the optional `eventId` parameter. If the application wrote the event using <xref:System.Diagnostics.EventLog.WriteEvent%2A>, the <xref:System.Diagnostics.EventLogEntry.InstanceId%2A> property matches the resource identifier specified in the <xref:System.Diagnostics.EventInstance.InstanceId%2A> of the `instance` parameter. If the application wrote the event using the Win32 API `ReportEvent`, the <xref:System.Diagnostics.EventLogEntry.InstanceId%2A> property matches the resource identifier specified in the `dwEventID` parameter.
433+
If the application wrote the event entry using one of the <xref:System.Diagnostics.EventLog.WriteEntry%2A> methods, the <xref:System.Diagnostics.EventLogEntry.InstanceId%2A> property matches the optional `eventId` parameter. If the application wrote the event using <xref:System.Diagnostics.EventLog.WriteEvent%2A>, the <xref:System.Diagnostics.EventLogEntry.InstanceId%2A> property matches the resource identifier specified in the <xref:System.Diagnostics.EventInstance.InstanceId%2A> of the `instance` parameter. If the application wrote the event using the Windows API `ReportEvent`, the <xref:System.Diagnostics.EventLogEntry.InstanceId%2A> property matches the resource identifier specified in the `dwEventID` parameter.
434434
435435
For details about defining event messages and building event log resource files, see the "Message Compiler" topic in the Platform SDK documentation at [http://msdn.microsoft.com](https://msdn.microsoft.com/). For details about event log identifiers, see the "Event Identifiers" topic in the Platform SDK.
436436

xml/System.Diagnostics/Stopwatch.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
4343
The <xref:System.Diagnostics.Stopwatch> measures elapsed time by counting timer ticks in the underlying timer mechanism. If the installed hardware and operating system support a high-resolution performance counter, then the <xref:System.Diagnostics.Stopwatch> class uses that counter to measure elapsed time. Otherwise, the <xref:System.Diagnostics.Stopwatch> class uses the system timer to measure elapsed time. Use the <xref:System.Diagnostics.Stopwatch.Frequency> and <xref:System.Diagnostics.Stopwatch.IsHighResolution> fields to determine the precision and resolution of the <xref:System.Diagnostics.Stopwatch> timing implementation.
4444
45-
The <xref:System.Diagnostics.Stopwatch> class assists the manipulation of timing-related performance counters within managed code. Specifically, the <xref:System.Diagnostics.Stopwatch.Frequency> field and <xref:System.Diagnostics.Stopwatch.GetTimestamp%2A> method can be used in place of the unmanaged Win32 APIs `QueryPerformanceFrequency` and `QueryPerformanceCounter`.
45+
The <xref:System.Diagnostics.Stopwatch> class assists the manipulation of timing-related performance counters within managed code. Specifically, the <xref:System.Diagnostics.Stopwatch.Frequency> field and <xref:System.Diagnostics.Stopwatch.GetTimestamp%2A> method can be used in place of the unmanaged Windows APIs `QueryPerformanceFrequency` and `QueryPerformanceCounter`.
4646
4747
> [!NOTE]
4848
> On a multiprocessor computer, it does not matter which processor the thread runs on. However, because of bugs in the BIOS or the Hardware Abstraction Layer (HAL), you can get different timing results on different processors. To specify processor affinity for a thread, use the <xref:System.Diagnostics.ProcessThread.ProcessorAffinity%2A?displayProperty=nameWithType> method.

xml/System.Drawing.Printing/StandardPrintController.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@
164164

165165
-or-
166166

167-
The native Win32 API could not delete the specified device context (DC).</exception>
167+
The native Windows API could not delete the specified device context (DC).</exception>
168168
<permission cref="T:System.Drawing.Printing.PrintingPermission">for controlling access to printers. Related enumeration: <see cref="T:System.Drawing.Printing.PrintingPermissionLevel" />.</permission>
169169
<altmember cref="M:System.Drawing.Printing.StandardPrintController.OnEndPage(System.Drawing.Printing.PrintDocument,System.Drawing.Printing.PrintPageEventArgs)" />
170170
<altmember cref="M:System.Drawing.Printing.StandardPrintController.OnStartPage(System.Drawing.Printing.PrintDocument,System.Drawing.Printing.PrintPageEventArgs)" />
@@ -219,7 +219,7 @@
219219

220220
-or-
221221

222-
The native Win32 API could not update the specified printer or plotter device context (DC) using the specified information.</exception>
222+
The native Windows API could not update the specified printer or plotter device context (DC) using the specified information.</exception>
223223
<permission cref="T:System.Drawing.Printing.PrintingPermission">for controlling access to printers. Related enumeration: <see cref="T:System.Drawing.Printing.PrintingPermissionLevel" />.</permission>
224224
<altmember cref="M:System.Drawing.Printing.StandardPrintController.OnEndPage(System.Drawing.Printing.PrintDocument,System.Drawing.Printing.PrintPageEventArgs)" />
225225
<altmember cref="M:System.Drawing.Printing.StandardPrintController.OnEndPrint(System.Drawing.Printing.PrintDocument,System.Drawing.Printing.PrintEventArgs)" />

xml/System.Drawing/Icon.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -665,7 +665,7 @@
665665
<format type="text/markdown"><![CDATA[
666666
667667
## Remarks
668-
When using this method, you must dispose of the original icon by using the `DestroyIcon` method in the Win32 API to ensure that the resources are released.
668+
When using this method, you must dispose of the original icon by using the `DestroyIcon` method in the Windows API to ensure that the resources are released.
669669
670670
671671
@@ -680,7 +680,7 @@
680680
681681
- Sets the <xref:System.Windows.Forms.Form.Icon%2A?displayProperty=nameWithType> attribute of the form to an icon created from the handle.
682682
683-
- Calls the Win32 API function `DestroyIcon` to release resources.
683+
- Calls the Windows API function `DestroyIcon` to release resources.
684684
685685
[!code-cpp[System.Drawing.ClassicBitmapExamples#6](~/samples/snippets/cpp/VS_Snippets_Winforms/System.Drawing.ClassicBitmapExamples/CPP/form1.cpp#6)]
686686
[!code-csharp[System.Drawing.ClassicBitmapExamples#6](~/samples/snippets/csharp/VS_Snippets_Winforms/System.Drawing.ClassicBitmapExamples/CS/form1.cs#6)]

xml/System.Globalization/CultureAndRegionInfoBuilder.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1453,7 +1453,7 @@
14531453
<format type="text/markdown"><![CDATA[
14541454
14551455
## Remarks
1456-
The <xref:System.Globalization.CultureAndRegionInfoBuilder.Unregister%2A> method does the reverse of the <xref:System.Globalization.CultureAndRegionInfoBuilder.Register%2A> method. The <xref:System.Globalization.CultureAndRegionInfoBuilder.Register%2A> method stores a custom culture as a file on the local computer, in the Globalization subdirectory of the directory returned by the Win32 API [GetWindowsDirectory](https://go.microsoft.com/fwlink/?LinkId=191561) function. The <xref:System.Globalization.CultureAndRegionInfoBuilder.Unregister%2A> method deletes the persisted custom culture file from the computer. After the file is deleted, existing instances of the custom culture in computer memory continue to work, but new instances of the custom culture cannot be created.
1456+
The <xref:System.Globalization.CultureAndRegionInfoBuilder.Unregister%2A> method does the reverse of the <xref:System.Globalization.CultureAndRegionInfoBuilder.Register%2A> method. The <xref:System.Globalization.CultureAndRegionInfoBuilder.Register%2A> method stores a custom culture as a file on the local computer, in the Globalization subdirectory of the directory returned by the Windows API [GetWindowsDirectory](https://go.microsoft.com/fwlink/?LinkId=191561) function. The <xref:System.Globalization.CultureAndRegionInfoBuilder.Unregister%2A> method deletes the persisted custom culture file from the computer. After the file is deleted, existing instances of the custom culture in computer memory continue to work, but new instances of the custom culture cannot be created.
14571457
14581458
14591459

xml/System.Reflection.Emit/ModuleBuilder.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -794,7 +794,7 @@
794794
795795
796796
## Examples
797-
The following example illustrates the use of the `DefinePInvokeMethod` method to create a <xref:System.Reflection.Emit.MethodBuilder> for an external unmanaged method, `MessageBoxA`, in the Win32 API. The example displays a message box with **Retry** and **Cancel** buttons, and displays the return value from the message box.
797+
The following example illustrates the use of the `DefinePInvokeMethod` method to create a <xref:System.Reflection.Emit.MethodBuilder> for an external unmanaged method, `MessageBoxA`, in the Windows API. The example displays a message box with **Retry** and **Cancel** buttons, and displays the return value from the message box.
798798
799799
> [!IMPORTANT]
800800
> To get a non-zero return value, you must add <xref:System.Reflection.MethodImplAttributes.PreserveSig?displayProperty=nameWithType> to the method implementation flags after you create the <xref:System.Reflection.Emit.MethodBuilder>, by using the <xref:System.Reflection.Emit.MethodBuilder.GetMethodImplementationFlags%2A?displayProperty=nameWithType> and <xref:System.Reflection.Emit.MethodBuilder.SetImplementationFlags%2A?displayProperty=nameWithType> methods.
@@ -884,7 +884,7 @@
884884
885885
886886
## Examples
887-
The following example illustrates the use of the `DefinePInvokeMethod` method to create a <xref:System.Reflection.Emit.MethodBuilder> for an external unmanaged method, `MessageBoxA`, in the Win32 API. The example displays a message box with **Retry** and **Cancel** buttons, and displays the return value from the message box.
887+
The following example illustrates the use of the `DefinePInvokeMethod` method to create a <xref:System.Reflection.Emit.MethodBuilder> for an external unmanaged method, `MessageBoxA`, in the Windows API. The example displays a message box with **Retry** and **Cancel** buttons, and displays the return value from the message box.
888888
889889
> [!IMPORTANT]
890890
> To get a non-zero return value, you must add <xref:System.Reflection.MethodImplAttributes.PreserveSig?displayProperty=nameWithType> to the method implementation flags after you create the <xref:System.Reflection.Emit.MethodBuilder>, by using the <xref:System.Reflection.Emit.MethodBuilder.GetMethodImplementationFlags%2A?displayProperty=nameWithType> and <xref:System.Reflection.Emit.MethodBuilder.SetImplementationFlags%2A?displayProperty=nameWithType> methods.

xml/System.Reflection/ImageFileMachine.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
To obtain this value for a module, use the <xref:System.Reflection.Module.GetPEKind%2A?displayProperty=nameWithType> method.
4242
4343
> [!NOTE]
44-
> The values in this enumeration correspond to the constants IMAGE_FILE_MACHINE_I386, IMAGE_FILE_MACHINE_IA64, and IMAGE_FILE_MACHINE_AMD64 in the unmanaged Win32 API, which are accessed by the unmanaged `GetPEKind` function.
44+
> The values in this enumeration correspond to the constants IMAGE_FILE_MACHINE_I386, IMAGE_FILE_MACHINE_IA64, and IMAGE_FILE_MACHINE_AMD64 in the unmanaged Windows API, which are accessed by the unmanaged `GetPEKind` function.
4545
4646
]]></format>
4747
</remarks>

xml/System.Runtime.CompilerServices/CompilerMarshalOverride.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
## Remarks
3434
The <xref:System.Runtime.CompilerServices.CompilerMarshalOverride> class allows the common language runtime to marshal using the correct sizes.
3535
36-
Some behaviors of the common language runtime are incompatible with some languages. For example, C++ treats Boolean variables as single-byte values, while the common language runtime marshals them as four-byte values to match the `BOOLEAN` type defined by the Microsoft Win32 API. To work around such issues, the C++ compiler emits this modifier on any `wchar_t` or `bool` parameter or function return.
36+
Some behaviors of the common language runtime are incompatible with some languages. For example, C++ treats Boolean variables as single-byte values, while the common language runtime marshals them as four-byte values to match the `BOOLEAN` type defined by the Microsoft Windows API. To work around such issues, the C++ compiler emits this modifier on any `wchar_t` or `bool` parameter or function return.
3737
3838
]]></format>
3939
</remarks>

xml/System.Runtime.InteropServices/CriticalHandle.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -583,7 +583,7 @@
583583
584584
`ReliabilityContract(Consistency.WillNotCorruptState, Cer.Success)`
585585
586-
Additionally, for simple cleanup (for example, calling the Win32 API `CloseHandle` on a file handle) you can check the return value for the single platform invoke call. For complex cleanup, you may have a lot of program logic and many method calls, some of which might fail. You must ensure that your program logic has fallback code for each of those cases.
586+
Additionally, for simple cleanup (for example, calling the Windows API `CloseHandle` on a file handle) you can check the return value for the single platform invoke call. For complex cleanup, you may have a lot of program logic and many method calls, some of which might fail. You must ensure that your program logic has fallback code for each of those cases.
587587
588588
If the <xref:System.Runtime.InteropServices.CriticalHandle.ReleaseHandle%2A> method returns `false` for any reason, it generates a [releaseHandleFailed](~/docs/framework/debug-trace-profile/releasehandlefailed-mda.md) Managed Debugging Assistant.
589589

0 commit comments

Comments
 (0)