-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
SupportedOSPlatformGuardAttribute.xml
73 lines (69 loc) · 4.67 KB
/
SupportedOSPlatformGuardAttribute.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
<Type Name="SupportedOSPlatformGuardAttribute" FullName="System.Runtime.Versioning.SupportedOSPlatformGuardAttribute">
<TypeSignature Language="C#" Value="public sealed class SupportedOSPlatformGuardAttribute : System.Runtime.Versioning.OSPlatformAttribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SupportedOSPlatformGuardAttribute extends System.Runtime.Versioning.OSPlatformAttribute" />
<TypeSignature Language="DocId" Value="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class SupportedOSPlatformGuardAttribute
Inherits OSPlatformAttribute" />
<TypeSignature Language="F#" Value="type SupportedOSPlatformGuardAttribute = class
 inherit OSPlatformAttribute" />
<TypeSignature Language="C++ CLI" Value="public ref class SupportedOSPlatformGuardAttribute sealed : System::Runtime::Versioning::OSPlatformAttribute" />
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Runtime.Versioning.OSPlatformAttribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Property, AllowMultiple=true, Inherited=false)]</AttributeName>
<AttributeName Language="F#">[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Property, AllowMultiple=true, Inherited=false)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Annotates a custom guard field, property or method with a supported platform name and optional version.
Multiple attributes can be applied to indicate guard for multiple supported platforms.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Callers can apply a <xref:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute> to a field, property or method
and use that field, property or method in a conditional or assert statements in order to safely call platform specific APIs.
The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SupportedOSPlatformGuardAttribute (string platformName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string platformName) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (platformName As String)" />
<MemberSignature Language="F#" Value="new System.Runtime.Versioning.SupportedOSPlatformGuardAttribute : string -> System.Runtime.Versioning.SupportedOSPlatformGuardAttribute" Usage="new System.Runtime.Versioning.SupportedOSPlatformGuardAttribute platformName" />
<MemberSignature Language="C++ CLI" Value="public:
 SupportedOSPlatformGuardAttribute(System::String ^ platformName);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="platformName" Type="System.String" />
</Parameters>
<Docs>
<param name="platformName">The supported OS platform name the attributed member would guard, optionally including a version.</param>
<summary>Initializes a new instance of the <see cref="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute" /> attribute class for the specified supported OS platform.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>