-
Notifications
You must be signed in to change notification settings - Fork 14
/
RequiredRuntimeAttribute.xml
111 lines (107 loc) · 6.57 KB
/
RequiredRuntimeAttribute.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<Type Name="RequiredRuntimeAttribute" FullName="Microsoft.Build.Framework.RequiredRuntimeAttribute">
<TypeSignature Language="C#" Value="public sealed class RequiredRuntimeAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit RequiredRuntimeAttribute extends System.Attribute" />
<TypeSignature Language="DocId" Value="T:Microsoft.Build.Framework.RequiredRuntimeAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class RequiredRuntimeAttribute
Inherits Attribute" />
<TypeSignature Language="F#" Value="type RequiredRuntimeAttribute = class
 inherit Attribute" />
<TypeSignature Language="C++ CLI" Value="public ref class RequiredRuntimeAttribute sealed : Attribute" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=false)]</AttributeName>
<AttributeName Language="F#">[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=false)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
When marked with the RequiredRuntimeAttribute, a task indicates that it has stricter
runtime requirements than a regular task - this tells MSBuild that it will need to potentially
launch a separate process for that task if the current runtime does not match the version requirement.
This attribute is currently non-functional since there is only one version of the CLR that is
capable of running MSBuild v2.0 or v3.5 - the runtime v2.0
</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A task marked with the <xref:Microsoft.Build.Framework.RequiredRuntimeAttribute> indicates that it has a stricter runtime requirement than a regular task. It alerts MSBuild that it may need to start a separate process for the task if the current CLR runtime version does not match the required version.
> [!NOTE]
> This attribute is currently non-functional because only one version of the CLR (2.0) is capable of running either MSBuild version 2.0 or 3.5.
For more information about using attributes, see [Extending Metadata Using Attributes](/dotnet/standard/attributes/).
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RequiredRuntimeAttribute (string runtimeVersion);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string runtimeVersion) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Framework.RequiredRuntimeAttribute.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (runtimeVersion As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Build.Framework.RequiredRuntimeAttribute : string -> Microsoft.Build.Framework.RequiredRuntimeAttribute" Usage="new Microsoft.Build.Framework.RequiredRuntimeAttribute runtimeVersion" />
<MemberSignature Language="C++ CLI" Value="public:
 RequiredRuntimeAttribute(System::String ^ runtimeVersion);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="runtimeVersion" Type="System.String" />
</Parameters>
<Docs>
<param name="runtimeVersion">The version of the CLR runtime required prefaced with a "v," such as "v2.0."</param>
<summary>
Constructor taking a version, such as "v2.0".
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RuntimeVersion">
<MemberSignature Language="C#" Value="public string RuntimeVersion { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string RuntimeVersion" />
<MemberSignature Language="DocId" Value="P:Microsoft.Build.Framework.RequiredRuntimeAttribute.RuntimeVersion" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property RuntimeVersion As String" />
<MemberSignature Language="F#" Value="member this.RuntimeVersion : string" Usage="Microsoft.Build.Framework.RequiredRuntimeAttribute.RuntimeVersion" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ RuntimeVersion { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build.Framework</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Returns the runtime version the attribute was constructed with,
e.g., "v2.0"
</summary>
<value>A string containing the CLR runtime version required.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>