Merge pull request #5714 from alexischr/update_bockbuild
[mono.git] / mcs / class / corlib / Documentation / en / System.Reflection / FieldAttributes.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <Type Name="FieldAttributes" FullName="System.Reflection.FieldAttributes" FullNameSP="System_Reflection_FieldAttributes" Maintainer="ecma">
3   <TypeSignature Language="ILASM" Value=".class public sealed serializable FieldAttributes extends System.Enum" />
4   <TypeSignature Language="C#" Value="public enum FieldAttributes" />
5   <TypeSignature Language="ILAsm" Value=".class public auto ansi serializable sealed FieldAttributes extends System.Enum" />
6   <MemberOfLibrary>Reflection</MemberOfLibrary>
7   <AssemblyInfo>
8     <AssemblyName>mscorlib</AssemblyName>
9     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
10     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
11     <AssemblyVersion>2.0.0.0</AssemblyVersion>
12     <AssemblyVersion>4.0.0.0</AssemblyVersion>
13   </AssemblyInfo>
14   <Base>
15     <BaseTypeName>System.Enum</BaseTypeName>
16   </Base>
17   <Attributes>
18     <Attribute>
19       <AttributeName>System.Flags</AttributeName>
20     </Attribute>
21     <Attribute>
22       <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
23     </Attribute>
24   </Attributes>
25   <Docs>
26     <remarks>
27       <attribution license="cc4" from="Microsoft" modified="false" />
28       <para>FieldAttributes uses the value from FieldAccessMask to mask off only the parts of the attribute value that pertain to the accessibility. For example, the following code determines if Attributes has the public bit set. </para>
29       <para>code reference: System.Reflection.FieldAttributes#1</para>
30       <para>To get the FieldAttributes, first get the class Type. From the Type, get the FieldInfo. From the FieldInfo, get the Attributes.</para>
31       <para>The enumerated value is a number representing the bitwise OR of the attributes implemented on the field.</para>
32     </remarks>
33     <summary>
34       <attribution license="cc4" from="Microsoft" modified="false" />
35       <para>Specifies flags that describe the attributes of a field.</para>
36     </summary>
37   </Docs>
38   <Members>
39     <Member MemberName="Assembly">
40       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Reflection.FieldAttributes Assembly = 3" />
41       <MemberSignature Language="C#" Value="Assembly" />
42       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes Assembly = int32(3)" />
43       <MemberType>Field</MemberType>
44       <AssemblyInfo>
45         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
46         <AssemblyVersion>2.0.0.0</AssemblyVersion>
47         <AssemblyVersion>4.0.0.0</AssemblyVersion>
48       </AssemblyInfo>
49       <ReturnValue>
50         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
51       </ReturnValue>
52       <Parameters />
53       <MemberValue>Assembly</MemberValue>
54       <Docs>
55         <remarks>To be added.</remarks>
56         <summary>
57           <attribution license="cc4" from="Microsoft" modified="false" />
58           <para>Specifies that the field is accessible throughout the assembly.</para>
59         </summary>
60       </Docs>
61       <Excluded>0</Excluded>
62     </Member>
63     <Member MemberName="FamANDAssem">
64       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Reflection.FieldAttributes FamANDAssem = 2" />
65       <MemberSignature Language="C#" Value="FamANDAssem" />
66       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes FamANDAssem = int32(2)" />
67       <MemberType>Field</MemberType>
68       <AssemblyInfo>
69         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
70         <AssemblyVersion>2.0.0.0</AssemblyVersion>
71         <AssemblyVersion>4.0.0.0</AssemblyVersion>
72       </AssemblyInfo>
73       <ReturnValue>
74         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
75       </ReturnValue>
76       <Parameters />
77       <MemberValue>FamANDAssem</MemberValue>
78       <Docs>
79         <remarks>To be added.</remarks>
80         <summary>
81           <attribution license="cc4" from="Microsoft" modified="false" />
82           <para>Specifies that the field is accessible only by subtypes in this assembly.</para>
83         </summary>
84       </Docs>
85       <Excluded>0</Excluded>
86     </Member>
87     <Member MemberName="Family">
88       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Reflection.FieldAttributes Family = 4" />
89       <MemberSignature Language="C#" Value="Family" />
90       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes Family = int32(4)" />
91       <MemberType>Field</MemberType>
92       <AssemblyInfo>
93         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
94         <AssemblyVersion>2.0.0.0</AssemblyVersion>
95         <AssemblyVersion>4.0.0.0</AssemblyVersion>
96       </AssemblyInfo>
97       <ReturnValue>
98         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
99       </ReturnValue>
100       <Parameters />
101       <MemberValue>Family</MemberValue>
102       <Docs>
103         <remarks>To be added.</remarks>
104         <summary>
105           <attribution license="cc4" from="Microsoft" modified="false" />
106           <para>Specifies that the field is accessible only by type and subtypes.</para>
107         </summary>
108       </Docs>
109       <Excluded>0</Excluded>
110     </Member>
111     <Member MemberName="FamORAssem">
112       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Reflection.FieldAttributes FamORAssem = 5" />
113       <MemberSignature Language="C#" Value="FamORAssem" />
114       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes FamORAssem = int32(5)" />
115       <MemberType>Field</MemberType>
116       <AssemblyInfo>
117         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
118         <AssemblyVersion>2.0.0.0</AssemblyVersion>
119         <AssemblyVersion>4.0.0.0</AssemblyVersion>
120       </AssemblyInfo>
121       <ReturnValue>
122         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
123       </ReturnValue>
124       <Parameters />
125       <MemberValue>FamORAssem</MemberValue>
126       <Docs>
127         <remarks>To be added.</remarks>
128         <summary>
129           <attribution license="cc4" from="Microsoft" modified="false" />
130           <para>Specifies that the field is accessible by subtypes anywhere, as well as throughout this assembly.</para>
131         </summary>
132       </Docs>
133       <Excluded>0</Excluded>
134     </Member>
135     <Member MemberName="FieldAccessMask">
136       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Reflection.FieldAttributes FieldAccessMask = 7" />
137       <MemberSignature Language="C#" Value="FieldAccessMask" />
138       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes FieldAccessMask = int32(7)" />
139       <MemberType>Field</MemberType>
140       <AssemblyInfo>
141         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
142         <AssemblyVersion>2.0.0.0</AssemblyVersion>
143         <AssemblyVersion>4.0.0.0</AssemblyVersion>
144       </AssemblyInfo>
145       <ReturnValue>
146         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
147       </ReturnValue>
148       <Parameters />
149       <MemberValue>FieldAccessMask</MemberValue>
150       <Docs>
151         <remarks>To be added.</remarks>
152         <summary>
153           <attribution license="cc4" from="Microsoft" modified="false" />
154           <para>Specifies the access level of a given field.</para>
155         </summary>
156       </Docs>
157       <Excluded>0</Excluded>
158     </Member>
159     <Member MemberName="HasDefault">
160       <MemberSignature Language="C#" Value="HasDefault" />
161       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes HasDefault = int32(32768)" />
162       <MemberType>Field</MemberType>
163       <AssemblyInfo>
164         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
165         <AssemblyVersion>2.0.0.0</AssemblyVersion>
166         <AssemblyVersion>4.0.0.0</AssemblyVersion>
167       </AssemblyInfo>
168       <ReturnValue>
169         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
170       </ReturnValue>
171       <MemberValue>HasDefault</MemberValue>
172       <Docs>
173         <remarks>To be added.</remarks>
174         <summary>
175           <attribution license="cc4" from="Microsoft" modified="false" />
176           <para>Specifies that the field has a default value.</para>
177         </summary>
178       </Docs>
179     </Member>
180     <Member MemberName="HasFieldMarshal">
181       <MemberSignature Language="C#" Value="HasFieldMarshal" />
182       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes HasFieldMarshal = int32(4096)" />
183       <MemberType>Field</MemberType>
184       <AssemblyInfo>
185         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
186         <AssemblyVersion>2.0.0.0</AssemblyVersion>
187         <AssemblyVersion>4.0.0.0</AssemblyVersion>
188       </AssemblyInfo>
189       <ReturnValue>
190         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
191       </ReturnValue>
192       <MemberValue>HasFieldMarshal</MemberValue>
193       <Docs>
194         <remarks>To be added.</remarks>
195         <summary>
196           <attribution license="cc4" from="Microsoft" modified="false" />
197           <para>Specifies that the field has marshaling information.</para>
198         </summary>
199       </Docs>
200     </Member>
201     <Member MemberName="HasFieldRVA">
202       <MemberSignature Language="C#" Value="HasFieldRVA" />
203       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes HasFieldRVA = int32(256)" />
204       <MemberType>Field</MemberType>
205       <AssemblyInfo>
206         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
207         <AssemblyVersion>2.0.0.0</AssemblyVersion>
208         <AssemblyVersion>4.0.0.0</AssemblyVersion>
209       </AssemblyInfo>
210       <ReturnValue>
211         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
212       </ReturnValue>
213       <MemberValue>HasFieldRVA</MemberValue>
214       <Docs>
215         <remarks>To be added.</remarks>
216         <summary>
217           <attribution license="cc4" from="Microsoft" modified="false" />
218           <para>Specifies that the field has a relative virtual address (RVA). The RVA is the location of the method body in the current image, as an address relative to the start of the image file in which it is located.</para>
219         </summary>
220       </Docs>
221     </Member>
222     <Member MemberName="InitOnly">
223       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Reflection.FieldAttributes InitOnly = 32" />
224       <MemberSignature Language="C#" Value="InitOnly" />
225       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes InitOnly = int32(32)" />
226       <MemberType>Field</MemberType>
227       <AssemblyInfo>
228         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
229         <AssemblyVersion>2.0.0.0</AssemblyVersion>
230         <AssemblyVersion>4.0.0.0</AssemblyVersion>
231       </AssemblyInfo>
232       <ReturnValue>
233         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
234       </ReturnValue>
235       <Parameters />
236       <MemberValue>InitOnly</MemberValue>
237       <Docs>
238         <remarks>To be added.</remarks>
239         <summary>
240           <attribution license="cc4" from="Microsoft" modified="false" />
241           <para>Specifies that the field is initialized only, and can be set only in the body of a constructor. </para>
242         </summary>
243       </Docs>
244       <Excluded>0</Excluded>
245     </Member>
246     <Member MemberName="Literal">
247       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Reflection.FieldAttributes Literal = 64" />
248       <MemberSignature Language="C#" Value="Literal" />
249       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes Literal = int32(64)" />
250       <MemberType>Field</MemberType>
251       <AssemblyInfo>
252         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
253         <AssemblyVersion>2.0.0.0</AssemblyVersion>
254         <AssemblyVersion>4.0.0.0</AssemblyVersion>
255       </AssemblyInfo>
256       <ReturnValue>
257         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
258       </ReturnValue>
259       <Parameters />
260       <MemberValue>Literal</MemberValue>
261       <Docs>
262         <remarks>To be added.</remarks>
263         <summary>
264           <attribution license="cc4" from="Microsoft" modified="false" />
265           <para>Specifies that the field's value is a compile-time (static or early bound) constant. Any attempt to set it throws a <see cref="T:System.FieldAccessException" />.</para>
266         </summary>
267       </Docs>
268       <Excluded>0</Excluded>
269     </Member>
270     <Member MemberName="NotSerialized">
271       <MemberSignature Language="C#" Value="NotSerialized" />
272       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes NotSerialized = int32(128)" />
273       <MemberType>Field</MemberType>
274       <AssemblyInfo>
275         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
276         <AssemblyVersion>2.0.0.0</AssemblyVersion>
277         <AssemblyVersion>4.0.0.0</AssemblyVersion>
278       </AssemblyInfo>
279       <ReturnValue>
280         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
281       </ReturnValue>
282       <MemberValue>NotSerialized</MemberValue>
283       <Docs>
284         <remarks>To be added.</remarks>
285         <summary>
286           <attribution license="cc4" from="Microsoft" modified="false" />
287           <para>Specifies that the field does not have to be serialized when the type is remoted.</para>
288         </summary>
289       </Docs>
290     </Member>
291     <Member MemberName="PinvokeImpl">
292       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Reflection.FieldAttributes PinvokeImpl = 8192" />
293       <MemberSignature Language="C#" Value="PinvokeImpl" />
294       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes PinvokeImpl = int32(8192)" />
295       <MemberType>Field</MemberType>
296       <AssemblyInfo>
297         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
298         <AssemblyVersion>2.0.0.0</AssemblyVersion>
299         <AssemblyVersion>4.0.0.0</AssemblyVersion>
300       </AssemblyInfo>
301       <ReturnValue>
302         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
303       </ReturnValue>
304       <Parameters />
305       <MemberValue>PinvokeImpl</MemberValue>
306       <Docs>
307         <remarks>To be added.</remarks>
308         <summary>
309           <attribution license="cc4" from="Microsoft" modified="false" />
310           <para>Reserved for future use.</para>
311         </summary>
312       </Docs>
313       <Excluded>0</Excluded>
314     </Member>
315     <Member MemberName="Private">
316       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Reflection.FieldAttributes Private = 1" />
317       <MemberSignature Language="C#" Value="Private" />
318       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes Private = int32(1)" />
319       <MemberType>Field</MemberType>
320       <AssemblyInfo>
321         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
322         <AssemblyVersion>2.0.0.0</AssemblyVersion>
323         <AssemblyVersion>4.0.0.0</AssemblyVersion>
324       </AssemblyInfo>
325       <ReturnValue>
326         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
327       </ReturnValue>
328       <Parameters />
329       <MemberValue>Private</MemberValue>
330       <Docs>
331         <remarks>To be added.</remarks>
332         <summary>
333           <attribution license="cc4" from="Microsoft" modified="false" />
334           <para>Specifies that the field is accessible only by the parent type.</para>
335         </summary>
336       </Docs>
337       <Excluded>0</Excluded>
338     </Member>
339     <Member MemberName="PrivateScope">
340       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Reflection.FieldAttributes PrivateScope = 0" />
341       <MemberSignature Language="C#" Value="PrivateScope" />
342       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes PrivateScope = int32(0)" />
343       <MemberType>Field</MemberType>
344       <AssemblyInfo>
345         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
346         <AssemblyVersion>2.0.0.0</AssemblyVersion>
347         <AssemblyVersion>4.0.0.0</AssemblyVersion>
348       </AssemblyInfo>
349       <ReturnValue>
350         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
351       </ReturnValue>
352       <Parameters />
353       <MemberValue>PrivateScope</MemberValue>
354       <Docs>
355         <remarks>To be added.</remarks>
356         <summary>
357           <attribution license="cc4" from="Microsoft" modified="false" />
358           <para>Specifies that the field cannot be referenced.</para>
359         </summary>
360       </Docs>
361       <Excluded>0</Excluded>
362     </Member>
363     <Member MemberName="Public">
364       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Reflection.FieldAttributes Public = 6" />
365       <MemberSignature Language="C#" Value="Public" />
366       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes Public = int32(6)" />
367       <MemberType>Field</MemberType>
368       <AssemblyInfo>
369         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
370         <AssemblyVersion>2.0.0.0</AssemblyVersion>
371         <AssemblyVersion>4.0.0.0</AssemblyVersion>
372       </AssemblyInfo>
373       <ReturnValue>
374         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
375       </ReturnValue>
376       <Parameters />
377       <MemberValue>Public</MemberValue>
378       <Docs>
379         <remarks>To be added.</remarks>
380         <summary>
381           <attribution license="cc4" from="Microsoft" modified="false" />
382           <para>Specifies that the field is accessible by any member for whom this scope is visible.</para>
383         </summary>
384       </Docs>
385       <Excluded>0</Excluded>
386     </Member>
387     <Member MemberName="ReservedMask">
388       <MemberSignature Language="C#" Value="ReservedMask" />
389       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes ReservedMask = int32(38144)" />
390       <MemberType>Field</MemberType>
391       <AssemblyInfo>
392         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
393         <AssemblyVersion>2.0.0.0</AssemblyVersion>
394         <AssemblyVersion>4.0.0.0</AssemblyVersion>
395       </AssemblyInfo>
396       <ReturnValue>
397         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
398       </ReturnValue>
399       <MemberValue>ReservedMask</MemberValue>
400       <Docs>
401         <remarks>To be added.</remarks>
402         <summary>
403           <attribution license="cc4" from="Microsoft" modified="false" />
404           <para>Reserved.</para>
405         </summary>
406       </Docs>
407     </Member>
408     <Member MemberName="RTSpecialName">
409       <MemberSignature Language="C#" Value="RTSpecialName" />
410       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes RTSpecialName = int32(1024)" />
411       <MemberType>Field</MemberType>
412       <AssemblyInfo>
413         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
414         <AssemblyVersion>2.0.0.0</AssemblyVersion>
415         <AssemblyVersion>4.0.0.0</AssemblyVersion>
416       </AssemblyInfo>
417       <ReturnValue>
418         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
419       </ReturnValue>
420       <MemberValue>RTSpecialName</MemberValue>
421       <Docs>
422         <remarks>To be added.</remarks>
423         <summary>
424           <attribution license="cc4" from="Microsoft" modified="false" />
425           <para>Specifies that the common language runtime (metadata internal APIs) should check the name encoding.</para>
426         </summary>
427       </Docs>
428     </Member>
429     <Member MemberName="SpecialName">
430       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Reflection.FieldAttributes SpecialName = 512" />
431       <MemberSignature Language="C#" Value="SpecialName" />
432       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes SpecialName = int32(512)" />
433       <MemberType>Field</MemberType>
434       <AssemblyInfo>
435         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
436         <AssemblyVersion>2.0.0.0</AssemblyVersion>
437         <AssemblyVersion>4.0.0.0</AssemblyVersion>
438       </AssemblyInfo>
439       <ReturnValue>
440         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
441       </ReturnValue>
442       <Parameters />
443       <MemberValue>SpecialName</MemberValue>
444       <Docs>
445         <remarks>To be added.</remarks>
446         <summary>
447           <attribution license="cc4" from="Microsoft" modified="false" />
448           <para>Specifies a special method, with the name describing how the method is special.</para>
449         </summary>
450       </Docs>
451       <Excluded>0</Excluded>
452     </Member>
453     <Member MemberName="Static">
454       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Reflection.FieldAttributes Static = 16" />
455       <MemberSignature Language="C#" Value="Static" />
456       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Reflection.FieldAttributes Static = int32(16)" />
457       <MemberType>Field</MemberType>
458       <AssemblyInfo>
459         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
460         <AssemblyVersion>2.0.0.0</AssemblyVersion>
461         <AssemblyVersion>4.0.0.0</AssemblyVersion>
462       </AssemblyInfo>
463       <ReturnValue>
464         <ReturnType>System.Reflection.FieldAttributes</ReturnType>
465       </ReturnValue>
466       <Parameters />
467       <MemberValue>Static</MemberValue>
468       <Docs>
469         <remarks>To be added.</remarks>
470         <summary>
471           <attribution license="cc4" from="Microsoft" modified="false" />
472           <para>Specifies that the field represents the defined type, or else it is per-instance.</para>
473         </summary>
474       </Docs>
475       <Excluded>0</Excluded>
476     </Member>
477   </Members>
478   <TypeExcluded>0</TypeExcluded>
479 </Type>