Skip to content

Commit 9d12dfe

Browse files
carlossanlopRon Petrusha
authored andcommitted
Automatically port Reflection.PortableExecutable.PE* APIs (#3193)
* Automatically port Reflection.PortableExecutable.PE* APIs * remove top line * Update PEMemoryBlock.xml * In-place edits. * Edited PEStreamOptions directly * Revised property descriptions. * Add summary and value. * suggestions by rpetrusha Co-Authored-By: Ron Petrusha <[email protected]> * suggestions by rpetrusha Co-Authored-By: Ron Petrusha <[email protected]> * PEReader add missing elements * entry point address * PEHeaderBuilder changes * Fixed para tag * Update PEReader.xml * Fixed bad crefs
1 parent e7e6019 commit 9d12dfe

File tree

7 files changed

+737
-310
lines changed

7 files changed

+737
-310
lines changed

xml/System.Reflection.PortableExecutable/PEDirectoriesBuilder.xml

Lines changed: 158 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</Base>
1818
<Interfaces />
1919
<Docs>
20-
<summary>To be added.</summary>
20+
<summary>Builds PE directories.</summary>
2121
<remarks>To be added.</remarks>
2222
</Docs>
2323
<Members>
@@ -37,7 +37,7 @@
3737
</AssemblyInfo>
3838
<Parameters />
3939
<Docs>
40-
<summary>To be added.</summary>
40+
<summary>Initializes an instance of the <see cref="T:System.Reflection.PortableExecutable.PEDirectoriesBuilder" /> class.</summary>
4141
<remarks>To be added.</remarks>
4242
</Docs>
4343
</Member>
@@ -60,8 +60,8 @@
6060
<ReturnType>System.Int32</ReturnType>
6161
</ReturnValue>
6262
<Docs>
63-
<summary>To be added.</summary>
64-
<value>To be added.</value>
63+
<summary>The address of the entry point relative to the image base when the PE file is loaded into memory.</summary>
64+
<value>For program images, this is the starting address. For device drivers, this is the address of the initialization function. An entry point is optional for DLLs. When no entry point is present, this field must be zero.</value>
6565
<remarks>To be added.</remarks>
6666
</Docs>
6767
</Member>
@@ -84,9 +84,17 @@
8484
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
8585
</ReturnValue>
8686
<Docs>
87-
<summary>To be added.</summary>
88-
<value>To be added.</value>
89-
<remarks>To be added.</remarks>
87+
<summary>The base relocation table image directory entry.</summary>
88+
<value>A directory entry instance.</value>
89+
<remarks>
90+
<format type="text/markdown"><![CDATA[
91+
92+
## Remarks
93+
94+
Represents `IMAGE_DIRECTORY_ENTRY_BASERELOC`.
95+
96+
]]></format>
97+
</remarks>
9098
</Docs>
9199
</Member>
92100
<Member MemberName="BoundImportTable">
@@ -108,9 +116,17 @@
108116
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
109117
</ReturnValue>
110118
<Docs>
111-
<summary>To be added.</summary>
112-
<value>To be added.</value>
113-
<remarks>To be added.</remarks>
119+
<summary>The bound import image directory entry.</summary>
120+
<value>A directory entry instance.</value>
121+
<remarks>
122+
<format type="text/markdown"><![CDATA[
123+
124+
## Remarks
125+
126+
Represents `IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT`.
127+
128+
]]></format>
129+
</remarks>
114130
</Docs>
115131
</Member>
116132
<Member MemberName="CopyrightTable">
@@ -132,9 +148,17 @@
132148
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
133149
</ReturnValue>
134150
<Docs>
135-
<summary>To be added.</summary>
136-
<value>To be added.</value>
137-
<remarks>To be added.</remarks>
151+
<summary>The copyright/architecture image directory entry.</summary>
152+
<value>A directory entry instance.</value>
153+
<remarks>
154+
<format type="text/markdown"><![CDATA[
155+
156+
## Remarks
157+
158+
Represents `IMAGE_DIRECTORY_ENTRY_COPYRIGHT` or `IMAGE_DIRECTORY_ENTRY_ARCHITECTURE`.
159+
160+
]]></format>
161+
</remarks>
138162
</Docs>
139163
</Member>
140164
<Member MemberName="CorHeaderTable">
@@ -156,9 +180,17 @@
156180
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
157181
</ReturnValue>
158182
<Docs>
159-
<summary>To be added.</summary>
160-
<value>To be added.</value>
161-
<remarks>To be added.</remarks>
183+
<summary>The COM descriptortable image directory entry.</summary>
184+
<value>A directory entry instance.</value>
185+
<remarks>
186+
<format type="text/markdown"><![CDATA[
187+
188+
## Remarks
189+
190+
Represents `IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR`.
191+
192+
]]></format>
193+
</remarks>
162194
</Docs>
163195
</Member>
164196
<Member MemberName="DebugTable">
@@ -180,9 +212,17 @@
180212
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
181213
</ReturnValue>
182214
<Docs>
183-
<summary>To be added.</summary>
184-
<value>To be added.</value>
185-
<remarks>To be added.</remarks>
215+
<summary>The debug table image directory entry.</summary>
216+
<value>A directory entry instance.</value>
217+
<remarks>
218+
<format type="text/markdown"><![CDATA[
219+
220+
## Remarks
221+
222+
Represents `IMAGE_DIRECTORY_ENTRY_DEBUG`.
223+
224+
]]></format>
225+
</remarks>
186226
</Docs>
187227
</Member>
188228
<Member MemberName="DelayImportTable">
@@ -204,9 +244,17 @@
204244
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
205245
</ReturnValue>
206246
<Docs>
207-
<summary>To be added.</summary>
208-
<value>To be added.</value>
209-
<remarks>To be added.</remarks>
247+
<summary>The delay import table image directory entry.</summary>
248+
<value>A directory entry instance.</value>
249+
<remarks>
250+
<format type="text/markdown"><![CDATA[
251+
252+
## Remarks
253+
254+
Represents `IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT`.
255+
256+
]]></format>
257+
</remarks>
210258
</Docs>
211259
</Member>
212260
<Member MemberName="ExceptionTable">
@@ -228,9 +276,17 @@
228276
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
229277
</ReturnValue>
230278
<Docs>
231-
<summary>To be added.</summary>
232-
<value>To be added.</value>
233-
<remarks>To be added.</remarks>
279+
<summary>The exception table image directory entry.</summary>
280+
<value>A directory entry instance.</value>
281+
<remarks>
282+
<format type="text/markdown"><![CDATA[
283+
284+
## Remarks
285+
286+
Represents `IMAGE_DIRECTORY_ENTRY_EXCEPTION`.
287+
288+
]]></format>
289+
</remarks>
234290
</Docs>
235291
</Member>
236292
<Member MemberName="ExportTable">
@@ -252,9 +308,17 @@
252308
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
253309
</ReturnValue>
254310
<Docs>
255-
<summary>To be added.</summary>
256-
<value>To be added.</value>
257-
<remarks>To be added.</remarks>
311+
<summary>The export table image directory entry.</summary>
312+
<value>A directory entry instance.</value>
313+
<remarks>
314+
<format type="text/markdown"><![CDATA[
315+
316+
## Remarks
317+
318+
Represents `IMAGE_DIRECTORY_ENTRY_EXPORT`.
319+
320+
]]></format>
321+
</remarks>
258322
</Docs>
259323
</Member>
260324
<Member MemberName="GlobalPointerTable">
@@ -276,9 +340,17 @@
276340
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
277341
</ReturnValue>
278342
<Docs>
279-
<summary>To be added.</summary>
280-
<value>To be added.</value>
281-
<remarks>To be added.</remarks>
343+
<summary>The global pointer table image directory entry.</summary>
344+
<value>A directory entry instance.</value>
345+
<remarks>
346+
<format type="text/markdown"><![CDATA[
347+
348+
## Remarks
349+
350+
Represents `IMAGE_DIRECTORY_ENTRY_GLOBALPTR`.
351+
352+
]]></format>
353+
</remarks>
282354
</Docs>
283355
</Member>
284356
<Member MemberName="ImportAddressTable">
@@ -300,9 +372,17 @@
300372
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
301373
</ReturnValue>
302374
<Docs>
303-
<summary>To be added.</summary>
304-
<value>To be added.</value>
305-
<remarks>To be added.</remarks>
375+
<summary>The import address table (IAT) image directory entry.</summary>
376+
<value>A directory entry instance.</value>
377+
<remarks>
378+
<format type="text/markdown"><![CDATA[
379+
380+
## Remarks
381+
382+
Represents `IMAGE_DIRECTORY_ENTRY_IAT`.
383+
384+
]]></format>
385+
</remarks>
306386
</Docs>
307387
</Member>
308388
<Member MemberName="ImportTable">
@@ -324,9 +404,17 @@
324404
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
325405
</ReturnValue>
326406
<Docs>
327-
<summary>To be added.</summary>
328-
<value>To be added.</value>
329-
<remarks>To be added.</remarks>
407+
<summary>The import table image directory entry.</summary>
408+
<value>A directory entry instance.</value>
409+
<remarks>
410+
<format type="text/markdown"><![CDATA[
411+
412+
## Remarks
413+
414+
Represents `IMAGE_DIRECTORY_ENTRY_IMPORT`.
415+
416+
]]></format>
417+
</remarks>
330418
</Docs>
331419
</Member>
332420
<Member MemberName="LoadConfigTable">
@@ -348,9 +436,17 @@
348436
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
349437
</ReturnValue>
350438
<Docs>
351-
<summary>To be added.</summary>
352-
<value>To be added.</value>
353-
<remarks>To be added.</remarks>
439+
<summary>The load configuration table image directory entry.</summary>
440+
<value>A directory entry instance.</value>
441+
<remarks>
442+
<format type="text/markdown"><![CDATA[
443+
444+
## Remarks
445+
446+
Represents `IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG`.
447+
448+
]]></format>
449+
</remarks>
354450
</Docs>
355451
</Member>
356452
<Member MemberName="ResourceTable">
@@ -372,9 +468,17 @@
372468
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
373469
</ReturnValue>
374470
<Docs>
375-
<summary>To be added.</summary>
376-
<value>To be added.</value>
377-
<remarks>To be added.</remarks>
471+
<summary>The resource table image directory entry.</summary>
472+
<value>A directory entry instance.</value>
473+
<remarks>
474+
<format type="text/markdown"><![CDATA[
475+
476+
## Remarks
477+
478+
Represents `IMAGE_DIRECTORY_ENTRY_RESOURCE`.
479+
480+
]]></format>
481+
</remarks>
378482
</Docs>
379483
</Member>
380484
<Member MemberName="ThreadLocalStorageTable">
@@ -396,9 +500,17 @@
396500
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
397501
</ReturnValue>
398502
<Docs>
399-
<summary>To be added.</summary>
400-
<value>To be added.</value>
401-
<remarks>To be added.</remarks>
503+
<summary>The thread local storage (TLS) table image directory entry.</summary>
504+
<value>A directory entry instance.</value>
505+
<remarks>
506+
<format type="text/markdown"><![CDATA[
507+
508+
## Remarks
509+
510+
Represents `IMAGE_DIRECTORY_ENTRY_TLS`.
511+
512+
]]></format>
513+
</remarks>
402514
</Docs>
403515
</Member>
404516
</Members>

0 commit comments

Comments
 (0)