Skip to content

Commit 2951f02

Browse files
Dave Wilsondrewbatgit
Dave Wilson
authored andcommitted
Merged PR 15724: d2d1_1 header fixes for phantom arg due to templates
These fixes target https://ceapex.visualstudio.com/Engineering/_workitems/edit/86625/ engineering bug. UID's needed to be updated to support the fix.
1 parent 1262d51 commit 2951f02

15 files changed

+1826
-1962
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,5 @@
3030
*.exe
3131
*.out
3232
*.app
33+
34+
mwgendiff.config
Original file line numberDiff line numberDiff line change
@@ -1,162 +1,152 @@
1-
---
2-
UID: NF:d2d1_1.ID2D1Properties.GetPropertyName(U,PWSTR,UINT32,)
3-
title: ID2D1Properties::GetPropertyName(U,PWSTR,UINT32,) (d2d1_1.h)
4-
author: windows-sdk-content
5-
description: Gets the property name that corresponds to the given index. This is a template overload. See Remarks.
6-
old-location: direct2d\id2d1properties_getpropertyname2.htm
7-
tech.root: Direct2D
8-
ms.assetid: 777BF543-F2AF-4B17-BF2B-845D713EA5CA
9-
ms.author: windowssdkdev
10-
ms.date: 12/05/2018
11-
ms.keywords: GetPropertyName, GetPropertyName method [Direct2D], GetPropertyName method [Direct2D],ID2D1Properties interface, ID2D1Properties interface [Direct2D],GetPropertyName method, ID2D1Properties.GetPropertyName, ID2D1Properties.GetPropertyName(U,PWSTR,UINT32,), ID2D1Properties::GetPropertyName, ID2D1Properties::GetPropertyName(U,PWSTR,UINT32), ID2D1Properties::GetPropertyName(U,PWSTR,UINT32,), d2d1_1/ID2D1Properties::GetPropertyName, direct2d.id2d1properties_getpropertyname2
12-
ms.topic: method
13-
f1_keywords:
14-
- "d2d1_1/ID2D1Properties.GetPropertyName"
15-
dev_langs:
16-
- c++
17-
req.header: d2d1_1.h
18-
req.include-header:
19-
req.target-type: Windows
20-
req.target-min-winverclnt: Windows 8 and Platform Update for Windows 7 [desktop apps \| UWP apps]
21-
req.target-min-winversvr: Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps \| UWP apps]
22-
req.kmdf-ver:
23-
req.umdf-ver:
24-
req.ddi-compliance:
25-
req.unicode-ansi:
26-
req.idl:
27-
req.max-support:
28-
req.namespace:
29-
req.assembly:
30-
req.type-library:
31-
req.lib: D2d1.lib
32-
req.dll: D2d1.dll
33-
req.irql:
34-
topic_type:
35-
- APIRef
36-
- kbSyntax
37-
api_type:
38-
- COM
39-
api_location:
40-
- D2d1.dll
41-
api_name:
42-
- ID2D1Properties.GetPropertyName
43-
targetos: Windows
44-
req.typenames:
45-
req.redist:
46-
ms.custom: 19H1
47-
---
48-
49-
# ID2D1Properties::GetPropertyName(U,PWSTR,UINT32,)
50-
51-
52-
## -description
53-
54-
55-
Gets the property name that corresponds to the given index. This is a template overload. See Remarks.
56-
57-
58-
## -parameters
59-
60-
61-
62-
63-
### -param index
64-
65-
Type: <b>U</b>
66-
67-
The index of the property for which the name is being returned.
68-
69-
70-
### -param name [out]
71-
72-
Type: <b>PWSTR</b>
73-
74-
When this method returns, contains the name being retrieved.
75-
76-
77-
### -param nameCount
78-
79-
Type: <b>UINT32</b>
80-
81-
The number of characters in the <i>name</i> buffer.
82-
83-
84-
### -param arg4
85-
86-
TBD
87-
88-
89-
90-
91-
## -returns
92-
93-
94-
95-
Type: <b>HRESULT</b>
96-
97-
The method returns an <b>HRESULT</b>. Possible values include, but are not limited to, those in the following table.
98-
99-
<table>
100-
<tr>
101-
<th>HRESULT</th>
102-
<th>Description</th>
103-
</tr>
104-
<tr>
105-
<td>S_OK</td>
106-
<td>No error occurred.</td>
107-
</tr>
108-
<tr>
109-
<td>HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)</td>
110-
<td>The supplied buffer was too small to accomodate the data.</td>
111-
</tr>
112-
<tr>
113-
<td>D2DERR_INVALID_PROPERTY</td>
114-
<td>The specified property does not exist.</td>
115-
</tr>
116-
</table>
117-
 
118-
119-
120-
121-
122-
## -remarks
123-
124-
125-
126-
This method returns an empty string if <i>index</i> is invalid. If the method returns <b>RESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)</b>, <i>name</i> will still be filled and truncated.
127-
128-
129-
<pre class="syntax">template&lt;typename U&gt;
130-
HRESULT GetPropertyName(
131-
U index,
132-
_Out_writes_(nameCount) PWSTR name,
133-
UINT32 nameCount
134-
) CONST;
135-
</pre>
136-
137-
138-
139-
140-
141-
## -see-also
142-
143-
144-
145-
146-
<a href="https://docs.microsoft.com/windows/desktop/api/d2d1_1/ne-d2d1_1-d2d1_property">D2D1_PROPERTY</a>
147-
148-
149-
150-
<a href="https://docs.microsoft.com/windows/desktop/api/d2d1_1/ne-d2d1_1-d2d1_subproperty">D2D1_SUBPROPERTY</a>
151-
152-
153-
154-
<a href="https://docs.microsoft.com/windows/desktop/api/d2d1_1/nf-d2d1_1-id2d1devicecontext-createeffect">ID2D1DeviceContext::CreateEffect</a>
155-
156-
157-
158-
<a href="https://docs.microsoft.com/windows/desktop/api/d2d1_1/nn-d2d1_1-id2d1properties">ID2D1Properties</a>
159-
 
160-
161-
 
162-
1+
---
2+
UID: NF:d2d1_1.ID2D1Properties.GetPropertyName(U,PWSTR,UINT32)
3+
title: ID2D1Properties::GetPropertyName(U,PWSTR,UINT32,) (d2d1_1.h)
4+
author: windows-sdk-content
5+
description: Gets the property name that corresponds to the given index. This is a template overload. See Remarks.
6+
old-location: direct2d\id2d1properties_getpropertyname2.htm
7+
tech.root: Direct2D
8+
ms.assetid: 777BF543-F2AF-4B17-BF2B-845D713EA5CA
9+
ms.author: windowssdkdev
10+
ms.date: 12/05/2018
11+
ms.keywords: GetPropertyName, GetPropertyName method [Direct2D], GetPropertyName method [Direct2D],ID2D1Properties interface, ID2D1Properties interface [Direct2D],GetPropertyName method, ID2D1Properties.GetPropertyName, ID2D1Properties.GetPropertyName(U,PWSTR,UINT32,), ID2D1Properties::GetPropertyName, ID2D1Properties::GetPropertyName(U,PWSTR,UINT32), ID2D1Properties::GetPropertyName(U,PWSTR,UINT32,), d2d1_1/ID2D1Properties::GetPropertyName, direct2d.id2d1properties_getpropertyname2
12+
ms.topic: method
13+
f1_keywords:
14+
- "d2d1_1/ID2D1Properties.GetPropertyName"
15+
dev_langs:
16+
- c++
17+
req.header: d2d1_1.h
18+
req.include-header:
19+
req.target-type: Windows
20+
req.target-min-winverclnt: Windows 8 and Platform Update for Windows 7 [desktop apps \| UWP apps]
21+
req.target-min-winversvr: Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps \| UWP apps]
22+
req.kmdf-ver:
23+
req.umdf-ver:
24+
req.ddi-compliance:
25+
req.unicode-ansi:
26+
req.idl:
27+
req.max-support:
28+
req.namespace:
29+
req.assembly:
30+
req.type-library:
31+
req.lib: D2d1.lib
32+
req.dll: D2d1.dll
33+
req.irql:
34+
topic_type:
35+
- APIRef
36+
- kbSyntax
37+
api_type:
38+
- COM
39+
api_location:
40+
- D2d1.dll
41+
api_name:
42+
- ID2D1Properties.GetPropertyName
43+
targetos: Windows
44+
req.typenames:
45+
req.redist:
46+
ms.custom: 19H1
47+
---
48+
49+
# ID2D1Properties::GetPropertyName(U,PWSTR,UINT32)
50+
51+
52+
## -description
53+
54+
55+
Gets the property name that corresponds to the given index. This is a template overload. See Remarks.
56+
57+
58+
## -parameters
59+
60+
### -param index
61+
62+
Type: <b>U</b>
63+
64+
The index of the property for which the name is being returned.
65+
66+
67+
### -param name [out]
68+
69+
Type: <b>PWSTR</b>
70+
71+
When this method returns, contains the name being retrieved.
72+
73+
74+
### -param nameCount
75+
76+
Type: <b>UINT32</b>
77+
78+
The number of characters in the <i>name</i> buffer.
79+
80+
81+
## -returns
82+
83+
84+
85+
Type: <b>HRESULT</b>
86+
87+
The method returns an <b>HRESULT</b>. Possible values include, but are not limited to, those in the following table.
88+
89+
<table>
90+
<tr>
91+
<th>HRESULT</th>
92+
<th>Description</th>
93+
</tr>
94+
<tr>
95+
<td>S_OK</td>
96+
<td>No error occurred.</td>
97+
</tr>
98+
<tr>
99+
<td>HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)</td>
100+
<td>The supplied buffer was too small to accomodate the data.</td>
101+
</tr>
102+
<tr>
103+
<td>D2DERR_INVALID_PROPERTY</td>
104+
<td>The specified property does not exist.</td>
105+
</tr>
106+
</table>
107+
 
108+
109+
110+
111+
112+
## -remarks
113+
114+
115+
116+
This method returns an empty string if <i>index</i> is invalid. If the method returns <b>RESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)</b>, <i>name</i> will still be filled and truncated.
117+
118+
119+
<pre class="syntax">template&lt;typename U&gt;
120+
HRESULT GetPropertyName(
121+
U index,
122+
_Out_writes_(nameCount) PWSTR name,
123+
UINT32 nameCount
124+
) CONST;
125+
</pre>
126+
127+
128+
129+
130+
131+
## -see-also
132+
133+
134+
135+
136+
<a href="https://docs.microsoft.com/windows/desktop/api/d2d1_1/ne-d2d1_1-d2d1_property">D2D1_PROPERTY</a>
137+
138+
139+
140+
<a href="https://docs.microsoft.com/windows/desktop/api/d2d1_1/ne-d2d1_1-d2d1_subproperty">D2D1_SUBPROPERTY</a>
141+
142+
143+
144+
<a href="https://docs.microsoft.com/windows/desktop/api/d2d1_1/nf-d2d1_1-id2d1devicecontext-createeffect">ID2D1DeviceContext::CreateEffect</a>
145+
146+
147+
148+
<a href="https://docs.microsoft.com/windows/desktop/api/d2d1_1/nn-d2d1_1-id2d1properties">ID2D1Properties</a>
149+
 
150+
151+
 
152+

0 commit comments

Comments
 (0)