Skip to content

Commit 591a891

Browse files
author
mtx48109
committed
windows formatting review pr20
1 parent 37503f8 commit 591a891

30 files changed

Lines changed: 608 additions & 653 deletions

‎docs/windows/synclockwithstatust-synclockwithstatust-constructor.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,20 +28,20 @@ explicit SyncLockWithStatusT(
2828
);
2929
```
3030

31-
#### Parameters
32-
`other`
33-
An rvalue-reference to another SyncLockWithStatusT object.
31+
### Parameters
32+
*other*
33+
An rvalue-reference to another **SyncLockWithStatusT** object.
3434

35-
`sync`
36-
A reference to another SyncLockWithStatusT object.
35+
*sync*
36+
A reference to another **SyncLockWithStatusT** object.
3737

38-
`status`
39-
The value of the [status_](../windows/synclockwithstatust-status-data-member.md) data member of the `other` parameter or the `sync` parameter.
38+
*status*
39+
The value of the [status_](../windows/synclockwithstatust-status-data-member.md) data member of the *other* parameter or the *sync* parameter.
4040

4141
## Remarks
42-
Initializes a new instance of the SyncLockWithStatusT class.
42+
Initializes a new instance of the **SyncLockWithStatusT** class.
4343

44-
The first constructor initializes the current SyncLockWithStatusT object from another SyncLockWithStatusT specified by parameter `other`, and then invalidates the other SyncLockWithStatusT object. The second constructor is `protected`, and initializes the current SyncLockWithStatusT object to an invalid state.
44+
The first constructor initializes the current **SyncLockWithStatusT** object from another **SyncLockWithStatusT** specified by parameter *other*, and then invalidates the other **SyncLockWithStatusT** object. The second constructor is **protected**, and initializes the current **SyncLockWithStatusT** object to an invalid state.
4545

4646
## Requirements
4747
**Header:** corewrappers.h

‎docs/windows/terminatemap-function.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,18 @@ inline bool TerminateMap(
2424
bool forceTerminate) throw()
2525
```
2626

27-
## Parameters
28-
`module`
27+
### Parameters
28+
*module*
2929
A [module](../windows/module-class.md).
3030

31-
`serverName`
32-
The name of a subset of class factories in the module specified by parameter `module`.
31+
*serverName*
32+
The name of a subset of class factories in the module specified by parameter *module*.
3333

34-
`forceTerminate`
35-
`true` to terminate the class factories regardless of they are active; `false` to not terminate the class factories if any factory is active.
34+
*forceTerminate*
35+
**true** to terminate the class factories regardless of they are active; **false** to not terminate the class factories if any factory is active.
3636

3737
## Return Value
38-
`true` if all class factories were terminated; otherwise, `false`.
38+
**true** if all class factories were terminated; otherwise, **false**.
3939

4040
## Remarks
4141
Shuts down the class factories in the specified module.

‎docs/windows/testing-a-dialog-box.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,20 @@ When you're designing a dialog box, you can simulate and test its run-time behav
2525
> [!NOTE]
2626
> Connections to dialog box code made by using wizards are not included in the simulation.
2727
28-
When you test a dialog box, it typically displays at a location that's relative to the main program window. If you've set the dialog box's Absolute Align property to True, the dialog box displays at a position that's relative to the upper-left corner of the screen.
28+
When you test a dialog box, it typically displays at a location that's relative to the main program window. If you've set the dialog box's **Absolute Align** property to **True**, the dialog box displays at a position that's relative to the upper-left corner of the screen.
2929

3030
### To test a dialog box
3131

3232
1. When the Dialog editor is the active window, on the menu bar, choose **Format**, **Test Dialog**.
3333

34-
2. To end the simulation, press Esc, or just choose the **Close** button in the dialog box you are testing.
34+
2. To end the simulation, press **Esc**, or just choose the **Close** button in the dialog box you are testing.
3535

3636
For information about how to add resources to managed projects, see [Resources in Desktop Apps](/dotnet/framework/resources/index).
3737

38-
Requirements
39-
38+
## Requirements
4039
Win32
4140

4241
## See Also
4342
[Controls in Dialog Boxes](../windows/controls-in-dialog-boxes.md)
4443
[Dialog Editor](../windows/dialog-editor.md)
45-
[Showing or Hiding the Dialog Editor Toolbar](../windows/showing-or-hiding-the-dialog-editor-toolbar.md)
46-
44+
[Showing or Hiding the Dialog Editor Toolbar](../windows/showing-or-hiding-the-dialog-editor-toolbar.md)

‎docs/windows/threading-cpp.md‎

Lines changed: 70 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,70 @@
1-
---
2-
title: "threading (C++) | Microsoft Docs"
3-
ms.custom: ""
4-
ms.date: "11/04/2016"
5-
ms.technology: ["cpp-windows"]
6-
ms.topic: "reference"
7-
f1_keywords: ["vc-attr.threading"]
8-
dev_langs: ["C++"]
9-
helpviewer_keywords: ["threading attribute"]
10-
ms.assetid: 9b558cd6-fbf0-4602-aed5-31c068550ce3
11-
author: "mikeblome"
12-
ms.author: "mblome"
13-
ms.workload: ["cplusplus", "uwp"]
14-
---
15-
# threading (C++)
16-
Specifies the threading model for a COM object.
17-
18-
## Syntax
19-
20-
```
21-
22-
[ threading(
23-
model=enumeration
24-
) ]
25-
```
26-
27-
#### Parameters
28-
***model*** (optional)
29-
One of the following threading models:
30-
31-
- **apartment** (apartment threading)
32-
33-
- **neutral** (.NET Framework components with no user interface)
34-
35-
- **single** (simple threading)
36-
37-
- **free** (free threading)
38-
39-
- **both** (apartment and free threading)
40-
41-
The default value is **apartment**.
42-
43-
## Remarks
44-
The **threading** C++ attribute does not appear in the generated .idl file but will be used in the implementation of your COM object.
45-
46-
In ATL projects, If the [coclass](../windows/coclass.md) attribute is also present, the threading model specified by *model* is passed as the template parameter to the [CComObjectRootEx](../atl/reference/ccomobjectrootex-class.md) class, inserted by the **coclass** attribute.
47-
48-
The **threading** attribute also guards access to an [event_source](../windows/event-source.md).
49-
50-
## Example
51-
See the [licensed](../windows/licensed.md) example for a sample use of **threading**.
52-
53-
## Requirements
54-
55-
### Attribute Context
56-
57-
|||
58-
|-|-|
59-
|**Applies to**|**class**, `struct`|
60-
|**Repeatable**|No|
61-
|**Required attributes**|**coclass**|
62-
|**Invalid attributes**|None|
63-
64-
For more information about the attribute contexts, see [Attribute Contexts](../windows/attribute-contexts.md).
65-
66-
## See Also
67-
[COM Attributes](../windows/com-attributes.md)
68-
[Typedef, Enum, Union, and Struct Attributes](../windows/typedef-enum-union-and-struct-attributes.md)
69-
[Class Attributes](../windows/class-attributes.md)
70-
[Multithreading Support for Older Code (Visual C++)](../parallel/multithreading-support-for-older-code-visual-cpp.md)
71-
[Neutral Apartments](http://msdn.microsoft.com/library/windows/desktop/ms681813)
1+
---
2+
title: "threading (C++) | Microsoft Docs"
3+
ms.custom: ""
4+
ms.date: "11/04/2016"
5+
ms.technology: ["cpp-windows"]
6+
ms.topic: "reference"
7+
f1_keywords: ["vc-attr.threading"]
8+
dev_langs: ["C++"]
9+
helpviewer_keywords: ["threading attribute"]
10+
ms.assetid: 9b558cd6-fbf0-4602-aed5-31c068550ce3
11+
author: "mikeblome"
12+
ms.author: "mblome"
13+
ms.workload: ["cplusplus", "uwp"]
14+
---
15+
# threading (C++)
16+
Specifies the threading model for a COM object.
17+
18+
## Syntax
19+
20+
```
21+
[ threading(
22+
model=enumeration
23+
) ]
24+
```
25+
26+
### Parameters
27+
*model* (optional)
28+
One of the following threading models:
29+
30+
- `apartment` (apartment threading)
31+
32+
- `neutral` (.NET Framework components with no user interface)
33+
34+
- `single` (simple threading)
35+
36+
- `free` (free threading)
37+
38+
- `both` (apartment and free threading)
39+
40+
The default value is `apartment`.
41+
42+
## Remarks
43+
The **threading** C++ attribute does not appear in the generated .idl file but will be used in the implementation of your COM object.
44+
45+
In ATL projects, If the [coclass](../windows/coclass.md) attribute is also present, the threading model specified by *model* is passed as the template parameter to the [CComObjectRootEx](../atl/reference/ccomobjectrootex-class.md) class, inserted by the `coclass` attribute.
46+
47+
The **threading** attribute also guards access to an [event_source](../windows/event-source.md).
48+
49+
## Example
50+
See the [licensed](../windows/licensed.md) example for a sample use of **threading**.
51+
52+
## Requirements
53+
54+
### Attribute Context
55+
56+
|||
57+
|-|-|
58+
|**Applies to**|**class**, **struct**|
59+
|**Repeatable**|No|
60+
|**Required attributes**|**coclass**|
61+
|**Invalid attributes**|None|
62+
63+
For more information about the attribute contexts, see [Attribute Contexts](../windows/attribute-contexts.md).
64+
65+
## See Also
66+
[COM Attributes](../windows/com-attributes.md)
67+
[Typedef, Enum, Union, and Struct Attributes](../windows/typedef-enum-union-and-struct-attributes.md)
68+
[Class Attributes](../windows/class-attributes.md)
69+
[Multithreading Support for Older Code (Visual C++)](../parallel/multithreading-support-for-older-code-visual-cpp.md)
70+
[Neutral Apartments](http://msdn.microsoft.com/library/windows/desktop/ms681813)

‎docs/windows/toolbar-button-properties.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,11 @@ The properties of a toolbar button are:
2323

2424
**Width** and **Height** apply to all buttons. A bitmap that is used to create a toolbar has a maximum width of 2048. So if you set the button width to 512, you can only have four buttons and if you set the width to 513, you can only have three buttons.
2525

26-
For information on adding resources to managed projects, please see [Resources in Desktop Apps](/dotnet/framework/resources/index) in the *.NET Framework Developer's Guide.* For information on manually adding resource files to managed projects, accessing resources, displaying static resources, and assigning resource strings to properties, see [Creating Resource Files for Desktop Apps](/dotnet/framework/resources/creating-resource-files-for-desktop-apps). For information on globalization and localization of resources in managed apps, see [Globalizing and Localizing .NET Framework Applications](/dotnet/standard/globalization-localization/index).
26+
For information on adding resources to managed projects, please see [Resources in Desktop Apps](/dotnet/framework/resources/index) in the *.NET Framework Developer's Guide*. For information on manually adding resource files to managed projects, accessing resources, displaying static resources, and assigning resource strings to properties, see [Creating Resource Files for Desktop Apps](/dotnet/framework/resources/creating-resource-files-for-desktop-apps). For information on globalization and localization of resources in managed apps, see [Globalizing and Localizing .NET Framework Applications](/dotnet/standard/globalization-localization/index).
2727

2828
## Requirements
2929
MFC or ATL
3030

3131
## See Also
3232
[Changing the Properties of a Toolbar Button](../windows/changing-the-properties-of-a-toolbar-button.md)
33-
[Toolbar Editor](../windows/toolbar-editor.md)
34-
33+
[Toolbar Editor](../windows/toolbar-editor.md)

‎docs/windows/toolbar-editor.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,11 @@ Toolbar Editor
3232

3333
The Toolbar editor is similar to the Image editor in functionality. The menu items, graphic tools, and bitmap grid are the same as those in the Image editor. There is a menu command on the Image menu to allow you to switch between the Toolbar editor and the Image editor. For more information on using the Graphics toolbar, Colors palette, or Image menu, see [Image Editor](../windows/image-editor-for-icons.md).
3434

35-
For information on adding resources to managed projects, please see [Resources in Desktop Apps](/dotnet/framework/resources/index) in the *.NET Framework Developer's Guide.* For information on manually adding resource files to managed projects, accessing resources, displaying static resources, and assigning resource strings to properties, see [Creating Resource Files for Desktop Apps](/dotnet/framework/resources/creating-resource-files-for-desktop-apps). For information on globalization and localization of resources in managed apps, see [Globalizing and Localizing .NET Framework Applications](/dotnet/standard/globalization-localization/index).
35+
For information on adding resources to managed projects, please see [Resources in Desktop Apps](/dotnet/framework/resources/index) in the *.NET Framework Developer's Guide*. For information on manually adding resource files to managed projects, accessing resources, displaying static resources, and assigning resource strings to properties, see [Creating Resource Files for Desktop Apps](/dotnet/framework/resources/creating-resource-files-for-desktop-apps). For information on globalization and localization of resources in managed apps, see [Globalizing and Localizing .NET Framework Applications](/dotnet/standard/globalization-localization/index).
3636

3737
## Requirements
3838
MFC or ATL
3939

4040
## See Also
4141
[Resource Editors](../windows/resource-editors.md)
42-
[Menus and Other Resources](http://msdn.microsoft.com/library/windows/desktop/ms632583.aspx)
43-
42+
[Menus and Other Resources](http://msdn.microsoft.com/library/windows/desktop/ms632583.aspx)

‎docs/windows/toolbar-image-editor-for-icons.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,12 @@ Image Editor Toolbar
3131
![Drawing-shape selector on the Image Editor toolbar](../mfc/media/vcimageeditortoolbaroptionselector.gif "vcImageEditorToolbarOptionSelector")
3232
Option Selector on the Image Editor Toolbar
3333

34-
For information on adding resources to managed projects, please see [Resources in Desktop Apps](/dotnet/framework/resources/index) in the *.NET Framework Developer's Guide.* For information on manually adding resource files to managed projects, accessing resources, displaying static resources, and assigning resource strings to properties, see [Creating Resource Files for Desktop Apps](/dotnet/framework/resources/creating-resource-files-for-desktop-apps). For information on globalization and localization of resources in managed apps, see [Globalizing and Localizing .NET Framework Applications](/dotnet/standard/globalization-localization/index).
34+
For information on adding resources to managed projects, please see [Resources in Desktop Apps](/dotnet/framework/resources/index) in the *.NET Framework Developer's Guide*. For information on manually adding resource files to managed projects, accessing resources, displaying static resources, and assigning resource strings to properties, see [Creating Resource Files for Desktop Apps](/dotnet/framework/resources/creating-resource-files-for-desktop-apps). For information on globalization and localization of resources in managed apps, see [Globalizing and Localizing .NET Framework Applications](/dotnet/standard/globalization-localization/index).
3535

3636
## Requirements
3737
None
3838

3939
## See Also
4040
[Displaying or Hiding the Toolbar](displaying-or-hiding-the-toolbar-image-editor-for-icons.md)
4141
[Accelerator Keys](../windows/accelerator-keys-image-editor-for-icons.md)
42-
[Image Editor for Icons](../windows/image-editor-for-icons.md)
43-
42+
[Image Editor for Icons](../windows/image-editor-for-icons.md)

‎docs/windows/tracking-reference-operator-cpp-component-extensions.md‎

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ A *tracking reference* (`%`) behaves like an ordinary C++ reference (`&`) except
2020

2121
- Assignment of an object to a tracking reference causes the object’s reference count to be incremented.
2222

23-
- A native reference (&) is the result when you dereference a *. A tracking reference (%) is the result when you dereference a ^. As long as you have a % to an object, the object will stay alive in memory.
23+
- A native reference (`&`) is the result when you dereference a `*`. A tracking reference (`%`) is the result when you dereference a `^`. As long as you have a `%` to an object, the object will stay alive in memory.
2424

2525
- The dot (`.`) member-access operator is used to access a member of the object.
2626

2727
- Tracking references are valid for value types and handles (for example `String^`).
2828

29-
- A tracking reference cannot be assigned a null or `nullptr` value. A tracking reference may be reassigned to another valid object as many times as required.
29+
- A tracking reference cannot be assigned a null or **nullptr** value. A tracking reference may be reassigned to another valid object as many times as required.
3030

3131
- A tracking reference cannot be used as a unary take-address operator.
3232

@@ -42,7 +42,6 @@ Foo^ spFoo2 = %srFoo;
4242
The following example shows how to pass a ^ to a function that takes a %.
4343

4444
```
45-
4645
ref class Foo sealed {};
4746
4847
// internal or private
@@ -72,11 +71,10 @@ ref class Foo sealed {};
7271
- [How to: Use Tracking References in C++/CLI](../dotnet/how-to-use-tracking-references-in-cpp-cli.md)
7372

7473
### Examples
75-
**Example**
7674

7775
The following sample for C++/CLI shows how to use a tracking reference with native and managed types.
7876

79-
```
77+
```cpp
8078
// tracking_reference_1.cpp
8179
// compile with: /clr
8280
ref class MyClass {
@@ -110,14 +108,11 @@ int main() {
110108

111109
delete[] pi;
112110
}
113-
114111
```
115112
116-
**Example**
117-
118113
The following sample for C++/CLI shows how to bind a tracking reference to an array.
119114
120-
```
115+
```cpp
121116
// tracking_reference_2.cpp
122117
// compile with: /clr
123118
using namespace System;

0 commit comments

Comments
 (0)