ResourceConsumptionAttribute Class

Definition

Namespace:

System.Runtime.Versioning

Assembly:

System.Runtime.dll

Source:

ResourceConsumptionAttribute.cs

Specifies the resource consumed by the member of a class. This class cannot be inherited.

This API supports the product infrastructure and is not intended to be used directly from your code.

public ref class ResourceConsumptionAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Constructor | System.AttributeTargets.Method | System.AttributeTargets.Property, Inherited=false)]
[System.Diagnostics.Conditional("RESOURCE_ANNOTATION_WORK")]
public sealed class ResourceConsumptionAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Constructor | System.AttributeTargets.Method | System.AttributeTargets.Property, Inherited=false)>]
[<System.Diagnostics.Conditional("RESOURCE_ANNOTATION_WORK")>]
type ResourceConsumptionAttribute = class
    inherit Attribute

Public NotInheritable Class ResourceConsumptionAttribute
Inherits Attribute

Inheritance

Object

Attribute

ResourceConsumptionAttribute

Attributes

AttributeUsageAttribute ConditionalAttribute

Remarks

If the ResourceConsumptionAttribute attribute is applied to a member, the ResourceExposureAttribute attribute must also be applied.

If the resource scope of the consumed resource is different than the resource scope of how it is consumed, the constructor that takes a consumptionScope parameter should be used to specify how the resource is consumed. For example, a resource may be exposed as a Machine resource, but only used at the Process and Assembly scope. For this example the consumptionScope parameter is set to Process | Assembly.

The resourceScope parameter in the constructor must specify a ResourceScope greater than or equal to the resource exposure of all called members. For example, a method consuming two Process resources and one Machine resource would be identified as consuming a Machine and a Process resource by setting resourceScope to Machine | Process.

Public members cannot expose Assembly or Private resources. Assembly members cannot expose Private resources.

The graph of methods terminates when a ResourceExposureAttribute attribute with a resource scope of None is applied to a method.

Constructors

ResourceConsumptionAttribute(ResourceScope)	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the ResourceConsumptionAttribute class specifying the scope of the consumed resource.
ResourceConsumptionAttribute(ResourceScope, ResourceScope)	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the ResourceConsumptionAttribute class specifying the scope of the consumed resource and the scope of how it is consumed.

Properties

ConsumptionScope	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the consumption scope for this member.
ResourceScope	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the resource scope for the consumed resource.
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)