Skip to content

Commit bc6bf0a

Browse files
author
mikeblome
committed
topic consolidation first pass
1 parent 9885200 commit bc6bf0a

44 files changed

Lines changed: 4718 additions & 990 deletions

File tree

Some content is hidden

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

‎docs/cppcx/TOC.md‎

Lines changed: 115 additions & 301 deletions
Large diffs are not rendered by default.

‎docs/cppcx/ibox-value-property.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ property T Value {T get();}
4747
**Namespace:** Platform
4848
4949
**Header** platform.winmd
50+
5051
5152
## See Also
5253
[Platform::IBox Interface](../cppcx/platform-ibox-interface.md)

‎docs/cppcx/iboxarray-value-property.md‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Returns the value that was originally stored in this object.
2323

2424
## Syntax
2525

26-
```scr
26+
```cpp
2727
property T Value {T get();}
2828
```
2929
@@ -45,6 +45,27 @@ property T Value {T get();}
4545
**Namespace:** Platform
4646
4747
**Header** platform.winmd
48+
49+
## IBoxArray::Value Property
50+
Returns the value that was originally stored in this object.
51+
52+
### Syntax
53+
54+
```cpp
55+
property T Value {T get();}
56+
```
57+
58+
### Parameters
59+
`T`
60+
The type of the boxed value.
61+
62+
## Property Value/Return Value
63+
Returns the value that was originally stored in this object.
64+
65+
### Remarks
66+
For an example, see [Boxing](../cppcx/boxing-c-cx.md).
67+
68+
4869

4970
## See Also
5071
[IBoxArray::Value Property](../cppcx/iboxarray-value-property.md)

‎docs/cppcx/obtaining-pointers-to-data-buffers-c-cx.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ byte* Class1::GetPointerToPixelData(IBuffer^ pixelBuffer, unsigned int *length)
6464

6565
- Use this XAML to replace the `Grid` element:
6666

67-
```vb
67+
```cpp
6868
<Grid Background="{StaticResource ApplicationPageBackgroundThemeBrush}">
6969
<StackPanel HorizontalAlignment="Left" Margin="176,110,0,0" VerticalAlignment="Top" Width="932">
7070
<Image x:Name="Pic"/>

‎docs/cppcx/platform-agile-class.md‎

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Represents an object that has a MashalingBehavior=Standard as an agile object, w
2525

2626
## Syntax
2727

28-
```scr
28+
```cpp
2929

3030
template <typename T>
3131
class Agile;
@@ -46,24 +46,24 @@ class Agile;
4646

4747
|Name|Description|
4848
|----------|-----------------|
49-
|[Agile::Agile Constructor](../cppcx/agile-agile-constructor.md)|Initializes a new instance of the Agile class.|
50-
|[Agile::~Agile Destructor](../cppcx/agile-tilde-agile-destructor.md)|Destroys the current instance of the Agile class.|
49+
|[Agile::Agile Constructor](#ctor)|Initializes a new instance of the Agile class.|
50+
|[Agile::~Agile Destructor](#dtor)|Destroys the current instance of the Agile class.|
5151

5252
### Public Methods
5353

5454
|Name|Description|
5555
|----------|-----------------|
56-
|[Agile::Get](../cppcx/agile-get-method.md)|Returns a handle to the object that is represented by the current Agile object.|
57-
|[Agile::GetAddressOf](../cppcx/agile-getaddressof-method.md)|Reinitializes the current Agile object, and then returns the address of a handle to an object of type `T`.|
58-
|[Agile::GetAddressOfForInOut](../cppcx/agile-getaddressofforinout-method.md)|Returns the address of a handle to the object represented by the current Agile object.|
59-
|[Agile::Release](../cppcx/agile-release-method.md)|Discards the current Agile object's underlying object and context.|
56+
|[Agile::Get](#get)|Returns a handle to the object that is represented by the current Agile object.|
57+
|[Agile::GetAddressOf](#getaddressof)|Reinitializes the current Agile object, and then returns the address of a handle to an object of type `T`.|
58+
|[Agile::GetAddressOfForInOut](#getaddressofforinout)|Returns the address of a handle to the object represented by the current Agile object.|
59+
|[Agile::Release](#release)|Discards the current Agile object's underlying object and context.|
6060

6161
### Public Operators
6262

6363
|Name|Description|
6464
|----------|-----------------|
65-
|[Agile::operator->](../cppcx/agile-operator-arrow-operator.md)|Retrieves a handle to the object represented by the current Agile object.|
66-
|[Agile::operator=](../cppcx/agile-operator-assign-operator.md)|Assigns the specified value to the current Agile object.|
65+
|[Agile::operator->](#operator-arrow)|Retrieves a handle to the object represented by the current Agile object.|
66+
|[Agile::operator=](#operator-assign)|Assigns the specified value to the current Agile object.|
6767

6868
## Inheritance Hierarchy
6969
`Object`
@@ -79,7 +79,7 @@ class Agile;
7979

8080
**Header:** agile.h
8181

82-
# Agile::Agile Constructor
82+
## <a name="ctor"></a> Agile::Agile Constructor
8383
Initializes a new instance of the Agile class.
8484

8585
## Syntax
@@ -106,7 +106,7 @@ Agile(Agile<T>&& object);
106106
## Remarks
107107
The first version of this constructor is the default constructor. The second version initializes new Agile instance class from the object specified by the `object` parameter. The third version is the copy constructor. The fourth version is the move constructor. This constructor cannot throw exceptions.
108108
109-
# Agile::~Agile Destructor
109+
## <a name="dtor"></a> Agile::~Agile Destructor
110110
Destroys the current instance of the Agile class.
111111
112112
## Syntax
@@ -119,7 +119,7 @@ Destroys the current instance of the Agile class.
119119
## Remarks
120120
This destructor also releases the object represented by the current Agile object.
121121

122-
# Agile::Get Method
122+
## <a name="get"></a> Agile::Get Method
123123
Returns a handle to the object that is represented by the current Agile object.
124124

125125
## Syntax
@@ -135,7 +135,7 @@ Returns a handle to the object that is represented by the current Agile object.
135135

136136
The type of the return value is actually an undisclosed internal type. A convenient way to hold the return value is to assign it to a variable that is declared with the **auto** type deduction keyword. For example, `auto x = myAgileTvariable->Get();`.
137137

138-
# Agile::GetAddressOf Method
138+
## <a name="getaddressof"></a> Agile::GetAddressOf Method
139139
Reinitializes the current Agile object, and then returns the address of a handle to an object of type `T`.
140140

141141
## Syntax
@@ -156,7 +156,7 @@ throw();
156156
## Remarks
157157
This operation releases the current representation of a object of type `T`, if any; reinitializes the Agile object's data members; acquires the current threading context; and then returns the address of a handle-to-object variable that can represent a non-agile object. To cause an Agile class instance to represent an object, use the assignment operator ([Agile::operator=](../cppcx/agile-operator-assign-operator.md)) to assign the object to the Agile class instance.
158158

159-
# Agile::GetAddressOfForInOut Method
159+
## <a name="getaddressofforinput"></a> Agile::GetAddressOfForInOut Method
160160
Returns the address of a handle to the object represented by the current Agile object.
161161

162162
## Syntax
@@ -177,7 +177,7 @@ T^* GetAddressOfForInOut() throw();
177177
## Remarks
178178
This operation acquires the current threading context and then returns the address of a handle to the underlying the object.
179179

180-
# Agile::Release Method
180+
## <a name="release"></a> Agile::Release Method
181181
Discards the current Agile object's underlying object and context.
182182

183183
## Syntax
@@ -191,7 +191,7 @@ void Release() throw();
191191
## Remarks
192192
The current Agile object's underlying object and context are discarded, if they exist, and then the value of the Agile object is set to null.
193193

194-
# Agile::operator-&gt; Operator
194+
## <a name="operator-arrow"></a> Agile::operator-&gt; Operator
195195
Retrieves a handle to the object represented by the current Agile object.
196196

197197
## Syntax
@@ -207,16 +207,14 @@ const throw();
207207

208208
This operator actually returns an undisclosed internal type. A convenient way to hold the return value is to assign it to a variable that is declared with the **auto** type deduction keyword.
209209

210-
# Agile::operator= Operator
210+
## <a name="operator-assign"></a> Agile::operator= Operator
211211
Assigns the specified object to the current Agile object.
212212

213213
## Syntax
214214

215215
```cpp
216216

217-
Agile<T> operator=(
218-
T^ object
219-
) throw();
217+
Agile<T> operator=(T^ object) throw();
220218

221219
Agile<T> operator=(
222220
const Agile<T>& object

‎docs/cppcx/platform-array-class.md‎

Lines changed: 80 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,35 @@
1-
---
2-
title: "Platform::Array Class | Microsoft Docs"
3-
ms.custom: ""
4-
ms.date: "12/30/2016"
1+
---
2+
title: "Platform::Array Class | Microsoft Docs"
3+
ms.custom: ""
4+
ms.date: "12/30/2016"
55
ms.prod: "windows-client-threshold"
6-
ms.technology: ""
7-
ms.reviewer: ""
8-
ms.suite: ""
9-
ms.tgt_pltfrm: ""
10-
ms.topic: "language-reference"
11-
f1_keywords:
12-
- "vccorlib/Platform::Array"
13-
dev_langs:
14-
- "C++"
15-
helpviewer_keywords:
16-
- "Platform::Array Class"
17-
ms.assetid: 7815ab40-88c5-42b0-83b8-081cef0cda31
18-
caps.latest.revision: 9
19-
author: "ghogen"
20-
ms.author: "ghogen"
21-
manager: "ghogen"
22-
---
23-
# Platform::Array Class
6+
ms.technology: ""
7+
ms.reviewer: ""
8+
ms.suite: ""
9+
ms.tgt_pltfrm: ""
10+
ms.topic: "language-reference"
11+
f1_keywords:
12+
- "vccorlib/Platform::Array"
13+
dev_langs:
14+
- "C++"
15+
helpviewer_keywords:
16+
- "Platform::Array Class"
17+
ms.assetid: 7815ab40-88c5-42b0-83b8-081cef0cda31
18+
caps.latest.revision: 9
19+
author: "ghogen"
20+
ms.author: "ghogen"
21+
manager: "ghogen"
22+
---
23+
# Platform::Array Class
2424
Represents a one-dimensional, modifiable array that can be received and passed across the application binary interface (ABI).
2525

2626
## Syntax
2727

28-
```cpp
29-
28+
```cpp
3029
template <typename T>
31-
private ref class Array<TArg,1> :
32-
public WriteOnlyArray<TArg, 1>,
33-
public IBoxArray<TArg>
34-
30+
private ref class Array<TArg, 1> :
31+
public WriteOnlyArray<TArg, 1>,
32+
public IBoxArray<TArg>
3533
```
3634
3735
## Members
@@ -41,7 +39,7 @@ template <typename T>
4139
4240
|Name|Description|
4341
|----------|-----------------|
44-
|[Array Constructors](../cppcx/array-constructors.md)|Initializes a one-dimensional, modifiable array of types specified by the class template parameter, *T*.|
42+
|[Array Constructors](#ctor)|Initializes a one-dimensional, modifiable array of types specified by the class template parameter, *T*.|
4543
4644
### Methods
4745
See [Platform::WriteOnlyArray Class](../cppcx/platform-writeonlyarray-class.md).
@@ -50,7 +48,7 @@ template <typename T>
5048
5149
|||
5250
|-|-|
53-
|[Array::Value Property](../cppcx/array-value-property.md)|Retrieves a handle to the current array.|
51+
|[Array::Value Property](#value)|Retrieves a handle to the current array.|
5452
5553
## Remarks
5654
The Array class is sealed and cannot be inherited.
@@ -65,7 +63,59 @@ template <typename T>
6563
6664
## Requirements
6765
Compiler option: **/ZW**
66+
67+
68+
## <a name="ctor"></a> Array Constructors
69+
Initializes a one-dimensional, modifiable array of types specified by the class template parameter, *T*.
70+
71+
## Syntax
72+
73+
```cpp
74+
Array(unsigned int size);
75+
Array(T* data, unsigned int size);
76+
```
77+
78+
#### Parameters
79+
`T`
80+
Class template parameter.
81+
82+
`size`
83+
The number of elements in the array.
84+
85+
`data`
86+
A pointer to an array of data of type `T` that is used to initialize this Array object.
87+
88+
## Remarks
89+
For more information about how to create instances of Platform::Array, see [Array and WriteOnlyArray](../cppcx/array-and-writeonlyarray-c-cx.md).
90+
91+
## <a name="get"></a> Array::get Method
92+
Retrieves a reference to the array element at the specified index location.
93+
94+
## Syntax
95+
96+
```cpp
97+
T& get(unsigned int index) const;
98+
```
99+
100+
#### Parameters
101+
`index`
102+
A zero-based index that identifies an element in the array. The minimum index is 0 and the maximum index is the value specified by the `size` parameter in the [Array constructor](#ctor).
103+
104+
## Return Value
105+
The array element specified by the `index` parameter.
106+
107+
## <a name="value"></a> Array::Value Property
108+
Retrieves a handle to the current array.
109+
110+
## Syntax
111+
112+
```cpp
113+
property Array^ Value;
114+
```
68115

116+
## Return Value
117+
A handle to the current array.
118+
69119
## See Also
70120
[Platform namespace](../cppcx/platform-namespace-c-cx.md)
71121
[Array and WriteOnlyArray](../cppcx/array-and-writeonlyarray-c-cx.md)

0 commit comments

Comments
 (0)