Skip to content

Commit a610406

Browse files
author
Colin Robertson
authored
Merge pull request MicrosoftDocs#1454 from msebolt/docset-changes-pr8
docset changes true false pr2
2 parents 1a14cab + b4e205c commit a610406

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+105
-105
lines changed

docs/parallel/concrt/parallel-algorithms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ This example uses a lambda expression as the hash function. You can also use one
274274

275275
[!code-cpp[concrt-parallel-sort-points#3](../../parallel/concrt/codesnippet/cpp/parallel-algorithms_14.cpp)]
276276

277-
The hash function must return an integral type ([std::is_integral::value](../../standard-library/is-integral-class.md) must be `true`). This integral type must be convertible to type `size_t`.
277+
The hash function must return an integral type ([std::is_integral::value](../../standard-library/is-integral-class.md) must be **true**). This integral type must be convertible to type `size_t`.
278278

279279
### <a name="choose_sort"></a> Choosing a Sorting Algorithm
280280

docs/parallel/concrt/reference/agent-class.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ bool cancel();
110110

111111
### Return Value
112112

113-
`true` if the agent was canceled, `false` otherwise. An agent cannot be canceled if it has already started running or has already completed.
113+
**true** if the agent was canceled, **false** otherwise. An agent cannot be canceled if it has already started running or has already completed.
114114

115115
## <a name="done"></a> done
116116

@@ -122,7 +122,7 @@ bool done();
122122

123123
### Return Value
124124

125-
`true` if the agent is moved to the `agent_done` state, `false` otherwise. An agent that has been canceled cannot be moved to the `agent_done` state.
125+
**true** if the agent is moved to the `agent_done` state, **false** otherwise. An agent that has been canceled cannot be moved to the `agent_done` state.
126126

127127
### Remarks
128128

@@ -150,7 +150,7 @@ bool start();
150150

151151
### Return Value
152152

153-
`true` if the agent started correctly, `false` otherwise. An agent that has been canceled cannot be started.
153+
**true** if the agent started correctly, **false** otherwise. An agent that has been canceled cannot be started.
154154

155155
## <a name="status"></a> status
156156

docs/parallel/concrt/reference/call-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ virtual bool supports_anonymous_source();
209209

210210
### Return Value
211211

212-
`true` because the block does not postpone offered messages.
212+
**true** because the block does not postpone offered messages.
213213

214214
## See Also
215215

docs/parallel/concrt/reference/cancellation-token-class.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class cancellation_token;
3737
|----------|-----------------|
3838
|[deregister_callback](#deregister_callback)|Removes a callback previously registered via the `register` method based on the `cancellation_token_registration` object returned at the time of registration.|
3939
|[is_cancelable](#is_cancelable)|Returns an indication of whether this token can be canceled or not.|
40-
|[is_canceled](#is_canceled)|Returns `true` if the token has been canceled.|
40+
|[is_canceled](#is_canceled)|Returns **true** if the token has been canceled.|
4141
|[none](#none)|Returns a cancellation token which can never be subject to cancellation.|
4242
|[register_callback](#register_callback)|Registers a callback function with the token. If and when the token is canceled, the callback will be made. Note that if the token is already canceled at the point where this method is called, the callback will be made immediately and synchronously.|
4343

@@ -105,15 +105,15 @@ An indication of whether this token can be canceled or not.
105105

106106
## <a name="is_canceled"></a> is_canceled
107107

108-
Returns `true` if the token has been canceled.
108+
Returns **true** if the token has been canceled.
109109

110110
```
111111
bool is_canceled() const;
112112
```
113113

114114
### Return Value
115115

116-
The value `true` if the token has been canceled; otherwise, the value `false`.
116+
The value **true** if the token has been canceled; otherwise, the value **false**.
117117

118118
## <a name="none"></a> none
119119

docs/parallel/concrt/reference/choice-class.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ A pointer to the `message` object that the caller now has ownership of.
191191

192192
### Remarks
193193

194-
The `consume` method is similar to `accept`, but must always be preceded by a call to `reserve` that returned `true`.
194+
The `consume` method is similar to `accept`, but must always be preceded by a call to `reserve` that returned **true**.
195195

196196
## <a name="has_value"></a> has_value
197197

@@ -204,7 +204,7 @@ bool has_value() const;
204204

205205
### Return Value
206206

207-
`true` if the block has received a value, `false` otherwise.
207+
**true** if the block has received a value, **false** otherwise.
208208

209209
## <a name="index"></a> index
210210

@@ -290,7 +290,7 @@ A pointer to the target block that is calling the `reserve` method.
290290

291291
### Return Value
292292

293-
`true` if the message was successfully reserved, `false` otherwise. Reservations can fail for many reasons, including: the message was already reserved or accepted by another target, the source could deny reservations, and so forth.
293+
**true** if the message was successfully reserved, **false** otherwise. Reservations can fail for many reasons, including: the message was already reserved or accepted by another target, the source could deny reservations, and so forth.
294294

295295
### Remarks
296296

docs/parallel/concrt/reference/combinable-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ T& local(bool& _Exists);
165165
### Parameters
166166

167167
*_Exists*<br/>
168-
A reference to a boolean. The boolean value referenced by this argument will be set to `true` if the sub-computation already existed on this thread, and set to `false` if this was the first sub-computation on this thread.
168+
A reference to a boolean. The boolean value referenced by this argument will be set to **true** if the sub-computation already existed on this thread, and set to **false** if this was the first sub-computation on this thread.
169169

170170
### Return Value
171171

docs/parallel/concrt/reference/concurrency-namespace-functions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ A reference to the data to be sent.
8080

8181
### Return Value
8282

83-
`true` if the message was accepted before the method returned, `false` otherwise.
83+
**true** if the message was accepted before the method returned, **false** otherwise.
8484

8585
### Remarks
8686

@@ -386,7 +386,7 @@ bool __cdecl is_current_task_group_canceling();
386386

387387
### Return Value
388388

389-
`true` if the task group which is currently executing is canceling, `false` otherwise.
389+
**true** if the task group which is currently executing is canceling, **false** otherwise.
390390

391391
### Remarks
392392

@@ -649,7 +649,7 @@ A random-access iterator addressing the position one past the final element in t
649649
An instance of a C++ Standard Library compatible memory allocator.
650650

651651
*_Func*<br/>
652-
A user-defined predicate function object that defines the comparison criterion to be satisfied by successive elements in the ordering. A binary predicate takes two arguments and returns `true` when satisfied and `false` when not satisfied. This comparator function must impose a strict weak ordering on pairs of elements from the sequence.
652+
A user-defined predicate function object that defines the comparison criterion to be satisfied by successive elements in the ordering. A binary predicate takes two arguments and returns **true** when satisfied and **false** when not satisfied. This comparator function must impose a strict weak ordering on pairs of elements from the sequence.
653653

654654
*_Chunk_size*<br/>
655655
The mimimum size of a chunk that will be split into two for parallel execution.
@@ -1179,7 +1179,7 @@ A random-access iterator addressing the position of the first element in the ran
11791179
A random-access iterator addressing the position one past the final element in the range to be sorted.
11801180

11811181
*_Func*<br/>
1182-
A user-defined predicate function object that defines the comparison criterion to be satisfied by successive elements in the ordering. A binary predicate takes two arguments and returns `true` when satisfied and `false` when not satisfied. This comparator function must impose a strict weak ordering on pairs of elements from the sequence.
1182+
A user-defined predicate function object that defines the comparison criterion to be satisfied by successive elements in the ordering. A binary predicate takes two arguments and returns **true** when satisfied and **false** when not satisfied. This comparator function must impose a strict weak ordering on pairs of elements from the sequence.
11831183

11841184
*_Chunk_size*<br/>
11851185
The mimimum size of a chunk that will be split into two for parallel execution.
@@ -1422,7 +1422,7 @@ A reference to the data to be sent.
14221422

14231423
### Return Value
14241424

1425-
`true` if the message was accepted, `false` otherwise.
1425+
**true** if the message was accepted, **false** otherwise.
14261426

14271427
### Remarks
14281428

@@ -1575,7 +1575,7 @@ The name for the given object.
15751575

15761576
## <a name="try_receive"></a> try_receive
15771577

1578-
A general try-receive implementation, allowing a context to look for data from exactly one source and filter the values that are accepted. If the data is not ready, the method will return false.
1578+
A general try-receive implementation, allowing a context to look for data from exactly one source and filter the values that are accepted. If the data is not ready, the method will return **false**.
15791579

15801580
```
15811581
template <class T>

docs/parallel/concrt/reference/concurrency-namespace-operators.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ An object of type `concurrent_vector`.
141141

142142
### Return Value
143143

144-
`true` if the concurrent vector on the left side of the operator is equal to the concurrent vector on the right side of the operator; otherwise `false`.
144+
**true** if the concurrent vector on the left side of the operator is equal to the concurrent vector on the right side of the operator; otherwise **false**.
145145

146146
### Remarks
147147

@@ -179,7 +179,7 @@ An object of type `concurrent_vector`.
179179

180180
### Return Value
181181

182-
`true` if the concurrent vectors are not equal; `false` if the concurrent vectors are equal.
182+
**true** if the concurrent vectors are not equal; **false** if the concurrent vectors are equal.
183183

184184
### Remarks
185185

@@ -217,7 +217,7 @@ An object of type `concurrent_vector`.
217217

218218
### Return Value
219219

220-
`true` if the concurrent vector on the left side of the operator is less than the concurrent vector on the right side of the operator; otherwise `false`.
220+
**true** if the concurrent vector on the left side of the operator is less than the concurrent vector on the right side of the operator; otherwise **false**.
221221

222222
### Remarks
223223

@@ -255,7 +255,7 @@ An object of type `concurrent_vector`.
255255

256256
### Return Value
257257

258-
`true` if the concurrent vector on the left side of the operator is less than or equal to the concurrent vector on the right side of the operator; otherwise `false`.
258+
**true** if the concurrent vector on the left side of the operator is less than or equal to the concurrent vector on the right side of the operator; otherwise **false**.
259259

260260
### Remarks
261261

@@ -293,7 +293,7 @@ An object of type `concurrent_vector`.
293293

294294
### Return Value
295295

296-
`true` if the concurrent vector on the left side of the operator is greater than the concurrent vector on the right side of the operator; otherwise `false`.
296+
**true** if the concurrent vector on the left side of the operator is greater than the concurrent vector on the right side of the operator; otherwise **false**.
297297

298298
### Remarks
299299

@@ -331,7 +331,7 @@ An object of type `concurrent_vector`.
331331

332332
### Return Value
333333

334-
`true` if the concurrent vector on the left side of the operator is greater than or equal to the concurrent vector on the right side of the operator; otherwise `false`.
334+
**true** if the concurrent vector on the left side of the operator is greater than or equal to the concurrent vector on the right side of the operator; otherwise **false**.
335335

336336
### Remarks
337337

docs/parallel/concrt/reference/concurrent-priority-queue-class.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ bool empty() const;
175175

176176
### Return Value
177177

178-
`true` if the priority queue was empty at the moment the function was called, `false` otherwise.
178+
**true** if the priority queue was empty at the moment the function was called, **false** otherwise.
179179

180180
## <a name="get_allocator"></a> get_allocator
181181

@@ -267,7 +267,7 @@ A reference to a variable that will be populated with the highest priority eleme
267267

268268
### Return Value
269269

270-
`true` if a value was popped, `false` otherwise.
270+
**true** if a value was popped, **false** otherwise.
271271

272272
## See Also
273273

docs/parallel/concrt/reference/concurrent-queue-class.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ bool empty() const;
156156

157157
### Return Value
158158

159-
`true` if the concurrent queue was empty at the moment we looked, `false` otherwise.
159+
**true** if the concurrent queue was empty at the moment we looked, **false** otherwise.
160160

161161
### Remarks
162162

@@ -208,11 +208,11 @@ A reference to a location to store the dequeued item.
208208

209209
### Return Value
210210

211-
`true` if an item was successfully dequeued, `false` otherwise.
211+
**true** if an item was successfully dequeued, **false** otherwise.
212212

213213
### Remarks
214214

215-
If an item was successfully dequeued, the parameter `_Dest` receives the dequeued value, the original value held in the queue is destroyed, and this function returns `true`. If there was no item to dequeue, this function returns `false` without blocking, and the contents of the `_Dest` parameter are undefined.
215+
If an item was successfully dequeued, the parameter `_Dest` receives the dequeued value, the original value held in the queue is destroyed, and this function returns **true**. If there was no item to dequeue, this function returns `false` without blocking, and the contents of the `_Dest` parameter are undefined.
216216

217217
`try_pop` is concurrency-safe with respect to calls to the methods `push`, `try_pop`, and `empty`.
218218

docs/parallel/concrt/reference/concurrent-unordered-map-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ bool empty() const;
288288

289289
### Return Value
290290

291-
`true` if the concurrent container is empty, `false` otherwise.
291+
**true** if the concurrent container is empty, **false** otherwise.
292292

293293
### Remarks
294294

docs/parallel/concrt/reference/concurrent-unordered-multimap-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ bool empty() const;
263263

264264
### Return Value
265265

266-
`true` if the concurrent container is empty, `false` otherwise.
266+
**true** if the concurrent container is empty, **false** otherwise.
267267

268268
### Remarks
269269

docs/parallel/concrt/reference/concurrent-unordered-multiset-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ bool empty() const;
251251

252252
### Return Value
253253

254-
`true` if the concurrent container is empty, `false` otherwise.
254+
**true** if the concurrent container is empty, **false** otherwise.
255255

256256
### Remarks
257257

docs/parallel/concrt/reference/concurrent-unordered-set-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ bool empty() const;
251251

252252
### Return Value
253253

254-
`true` if the concurrent container is empty, `false` otherwise.
254+
**true** if the concurrent container is empty, **false** otherwise.
255255

256256
### Remarks
257257

docs/parallel/concrt/reference/concurrent-vector-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ bool empty() const;
372372

373373
### Return Value
374374

375-
`true` if the vector was empty at the moment the function was called, `false` otherwise.
375+
**true** if the vector was empty at the moment the function was called, **false** otherwise.
376376

377377
## <a name="end"></a> end
378378

docs/parallel/concrt/reference/context-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ static void __cdecl Oversubscribe(bool _BeginOversubscription);
216216
### Parameters
217217

218218
*_BeginOversubscription*<br/>
219-
If `true`, an indication that an extra virtual processor should be added for the duration of the oversubscription. If `false`, an indication that the oversubscription should end and the previously added virtual processor should be removed.
219+
If **true**, an indication that an extra virtual processor should be added for the duration of the oversubscription. If **false**, an indication that the oversubscription should end and the previously added virtual processor should be removed.
220220

221221
## <a name="schedulegroupid"></a> ScheduleGroupId
222222

docs/parallel/concrt/reference/critical-section-class.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ bool try_lock();
156156

157157
### Return Value
158158

159-
If the lock was acquired, the value `true`; otherwise, the value `false`.
159+
If the lock was acquired, the value **true**; otherwise, the value **false**.
160160

161161
## <a name="try_lock_for"></a> try_lock_for
162162

@@ -173,7 +173,7 @@ The number of milliseconds to wait before timing out.
173173

174174
### Return Value
175175

176-
If the lock was acquired, the value `true`; otherwise, the value `false`.
176+
If the lock was acquired, the value **true**; otherwise, the value **false**.
177177

178178
## <a name="unlock"></a> unlock
179179

docs/parallel/concrt/reference/event-class.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ An array of events to wait on. The number of events within the array is indicate
150150
The count of events within the array supplied in the `_PPEvents` parameter.
151151

152152
*_FWaitAll*<br/>
153-
If set to the value `true`, the parameter specifies that all events within the array supplied in the `_PPEvents` parameter must become signaled in order to satisfy the wait. If set to the value `false`, it specifies that any event within the array supplied in the `_PPEvents` parameter becoming signaled will satisfy the wait.
153+
If set to the value **true**, the parameter specifies that all events within the array supplied in the `_PPEvents` parameter must become signaled in order to satisfy the wait. If set to the value **false**, it specifies that any event within the array supplied in the `_PPEvents` parameter becoming signaled will satisfy the wait.
154154

155155
*_Timeout*<br/>
156156
Indicates the number of milliseconds before the wait times out. The value `COOPERATIVE_TIMEOUT_INFINITE` signifies that there is no timeout.
@@ -164,7 +164,7 @@ If the wait was satisfied, the index within the array supplied in the `_PPEvents
164164
If the parameter `_FWaitAll` is set to the value `true` to indicate that all events must become signaled to satisfy the wait, the index returned by the function carries no special significance other than the fact that it is not the value `COOPERATIVE_WAIT_TIMEOUT`.
165165

166166
> [!IMPORTANT]
167-
> In a Universal Windows Platform (UWP) app, do not call `wait_for_multiple` on the ASTA thread because this call can block the current thread and can cause the app to become unresponsive.
167+
> In a Universal Windows Platform (UWP) app, do not call `wait_for_multiple` on the ASTA thread because this call can block the current thread and can cause the app to become unresponsive.
168168
169169
## See Also
170170

docs/parallel/concrt/reference/iexecutionresource-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ The current subscription level.
6363

6464
The subscription level tells you how many running threads are associated with the hardware thread. This only includes threads the Resource Manager is aware of in the form of subscribed threads, and virtual processor roots that are actively executing thread proxies.
6565

66-
Calling the method [ISchedulerProxy::SubscribeCurrentThread](ischedulerproxy-structure.md#subscribecurrentthread), or the method [ISchedulerProxy::RequestInitialVirtualProcessors](ischedulerproxy-structure.md#requestinitialvirtualprocessors) with the parameter `doSubscribeCurrentThread` set to the value `true` increments the subscription level of a hardware thread by one. They also return an `IExecutionResource` interface representing the subscription. A corresponding call to the [IExecutionResource::Remove](#remove) decrements the hardware thread's subscription level by one.
66+
Calling the method [ISchedulerProxy::SubscribeCurrentThread](ischedulerproxy-structure.md#subscribecurrentthread), or the method [ISchedulerProxy::RequestInitialVirtualProcessors](ischedulerproxy-structure.md#requestinitialvirtualprocessors) with the parameter `doSubscribeCurrentThread` set to the value **true** increments the subscription level of a hardware thread by one. They also return an `IExecutionResource` interface representing the subscription. A corresponding call to the [IExecutionResource::Remove](#remove) decrements the hardware thread's subscription level by one.
6767

6868
The act of activating a virtual processor root using the method [IVirtualProcessorRoot::Activate](ivirtualprocessorroot-structure.md#activate) increments the subscription level of a hardware thread by one. The methods [IVirtualProcessorRoot::Deactivate](ivirtualprocessorroot-structure.md#deactivate), or [IExecutionResource::Remove](#remove) decrement the subscription level by one when invoked on an activated virtual processor root.
6969

docs/parallel/concrt/reference/invalid-oversubscribe-operation-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.workload: ["cplusplus"]
1414
---
1515
# invalid_oversubscribe_operation Class
1616

17-
This class describes an exception thrown when the `Context::Oversubscribe` method is called with the `_BeginOversubscription` parameter set to `false` without a prior call to the `Context::Oversubscribe` method with the `_BeginOversubscription` parameter set to `true`.
17+
This class describes an exception thrown when the `Context::Oversubscribe` method is called with the `_BeginOversubscription` parameter set to **false** without a prior call to the `Context::Oversubscribe` method with the `_BeginOversubscription` parameter set to **true**.
1818

1919
## Syntax
2020

0 commit comments

Comments
 (0)