SupportedOSPlatformGuardAttribute Class
Definition
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 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.
public ref class SupportedOSPlatformGuardAttribute sealed : System::Runtime::Versioning::OSPlatformAttribute[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Property, AllowMultiple=true, Inherited=false)]
public sealed class SupportedOSPlatformGuardAttribute : System.Runtime.Versioning.OSPlatformAttribute[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Property, AllowMultiple=true, Inherited=false)>]
type SupportedOSPlatformGuardAttribute = class
inherit OSPlatformAttributePublic NotInheritable Class SupportedOSPlatformGuardAttribute
Inherits OSPlatformAttribute- Inheritance
- Attributes
Remarks
Callers can apply a SupportedOSPlatformGuardAttribute to a field, property, or method and use that member in a conditional or assertion to safely call platform-specific APIs. The field or property type, or the method return type, must be Boolean.
Common platform names include android, browser, freebsd, ios, linux, macos, maccatalyst, tvos, wasi, watchos, and windows. For platforms that support version checks, a platform name can include a version, such as windows10.0. For more information, see the platform compatibility analyzer.
Constructors
| Name | Description |
|---|---|
| SupportedOSPlatformGuardAttribute(String) |
Initializes a new instance of the SupportedOSPlatformGuardAttribute attribute class for the specified supported OS platform. |
Properties
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| 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) |
