UnscopedRefAttribute Class

Definition

Namespace:

System.Diagnostics.CodeAnalysis

Assembly:

System.Runtime.dll

Source:

UnscopedRefAttribute.cs

Used to indicate a byref escapes and is not scoped.

public ref class UnscopedRefAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Method | System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)]
public sealed class UnscopedRefAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Method | System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)>]
type UnscopedRefAttribute = class
    inherit Attribute

Public NotInheritable Class UnscopedRefAttribute
Inherits Attribute

Inheritance

Object

Attribute

UnscopedRefAttribute

Attributes

AttributeUsageAttribute

Remarks

There are several cases where the C# compiler treats a ref as implicitly scoped - where the compiler does not allow the ref to escape the method.

For example:

1. this for struct instance methods.
2. ref parameters that refer to ref struct types.
3. out parameters.

This attribute is used in those instances where the ref should be allowed to escape.

Applying this attribute, in any form, has impact on consumers of the applicable API. It is necessary for API authors to understand the lifetime implications of applying this attribute and how it may impact their users.

Constructors

UnscopedRefAttribute()

Initializes a new instance of the UnscopedRefAttribute class.

Properties

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)