UnsupportedOSPlatformGuardAttribute Class

Reference

Definition

Namespace:: System.Runtime.Versioning

Assembly:: System.Runtime.dll

Source:: PlatformAttributes.cs

Source:: PlatformAttributes.cs

Source:: PlatformAttributes.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Annotates the custom guard field, property or method with an unsupported platform name and optional version. Multiple attributes can be applied to indicate guard for multiple unsupported platforms.

public ref class UnsupportedOSPlatformGuardAttribute sealed : System::Runtime::Versioning::OSPlatformAttribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Property, AllowMultiple=true, Inherited=false)]
public sealed class UnsupportedOSPlatformGuardAttribute : System.Runtime.Versioning.OSPlatformAttribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Property, AllowMultiple=true, Inherited=false)>]
type UnsupportedOSPlatformGuardAttribute = class
    inherit OSPlatformAttribute

Public NotInheritable Class UnsupportedOSPlatformGuardAttribute
Inherits OSPlatformAttribute

Inheritance: Object

Attribute

OSPlatformAttribute
UnsupportedOSPlatformGuardAttribute

Attributes: AttributeUsageAttribute

Remarks

Callers can apply a UnsupportedOSPlatformGuardAttribute to a field, property or method and use that field, property or method in a conditional or assert statements as a guard to safely call APIs unsupported on those platforms.

         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.

Constructors

UnsupportedOSPlatformGuardAttribute(String)

Initializes a new instance of the UnsupportedOSPlatformGuardAttribute attribute class for the specified unsupported OS platform.

Properties

PlatformName	Gets the name and optional version of the platform that the attribute applies to. (Inherited from OSPlatformAttribute)
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Share via