ObfuscationAttribute Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Instructs obfuscation tools to take the specified actions for an assembly, type, or member.

Namespace:   System.Reflection
Assembly:  mscorlib (in mscorlib.dll)


[<AttributeUsageAttribute(AttributeTargets.Assembly | AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Enum | AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Event | AttributeTargets.Interface | AttributeTargets.Parameter | AttributeTargets.Delegate,
    AllowMultiple = true, Inherited = false)>]
type ObfuscationAttribute = 
        inherit Attribute


Initializes a new instance of the ObfuscationAttribute class.


Gets or sets a Boolean value indicating whether the attribute of a type is to apply to the members of the type.


Gets or sets a Boolean value indicating whether the obfuscation tool should exclude the type or member from obfuscation.


Gets or sets a string value that is recognized by the obfuscation tool, and which specifies processing options.


Gets or sets a Boolean value indicating whether the obfuscation tool should remove this attribute after processing.


When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)


This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)


Returns the hash code for this instance.(Inherited from Attribute.)


Gets the Type of the current instance.(Inherited from Object.)


When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)


When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)


Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)


Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

The ObfuscationAttribute and ObfuscateAssemblyAttribute attributes allow assembly authors to annotate their binaries so that obfuscation tools can process them correctly with minimal external configuration.


Applying this attribute does not automatically obfuscate the code entity to which you apply it. Applying the attribute is an alternative to creating a configuration file for the obfuscation tool. That is, it merely provides instructions for an obfuscation tool. Microsoft recommends that vendors of obfuscation tools follow the semantics described here. However, there is no guarantee that a particular tool follows Microsoft recommendations.

The ObfuscationAttribute attribute has a string Feature property. Obfuscation tools can map the string values of this property to features they implement, preferably by using an XML configuration file that users can access. The ObfuscationAttribute defines two feature strings, "default" and "all". The string "default" should map to the default obfuscation features of a tool, and "all" should map to the complete set of obfuscation features supported by a tool. The default value of the Feature property is "all", enabling the complete set of obfuscation features.

When applied to an assembly, ObfuscationAttribute also applies to all types within the assembly. If the ApplyToMembers property is not specified, or is set to true, the attribute applies to all members as well. ObfuscationAttribute does not specify whether an assembly is public or private. To specify whether an assembly is public or private, use the ObfuscateAssemblyAttribute attribute.

When applied to classes and structures, ObfuscationAttribute also applies to all members of the type if the ApplyToMembers property is not specified, or is set to true.

When applied to methods, parameters, fields, and properties, the attribute affects only the entity to which it is applied.

The following code example shows a public assembly with two types: Type1 and Type2. The assembly is marked for obfuscation with the ObfuscateAssemblyAttribute, which marks the assembly to be treated as public (that is, the AssemblyIsPrivate property is false).

Type1 is marked for obfuscation because the assembly is marked for obfuscation. One member of Type1 is excluded from obfuscation, using the Exclude property.

Type2 is excluded from obfuscation, but its members are marked for obfuscation because the ApplyToMembers property is false.

The MethodA method of Type2 is marked with the value "default" for the Feature property. It is necessary to specify false for the Exclude property to avoid excluding MethodA from obfuscation, because the default for the Exclude property is true. The obfuscation tool should not strip the attribute after obfuscation because the StripAfterObfuscation property is false. All the other attributes in this code example are stripped after obfuscation, because the StripAfterObfuscation property is not specified, and therefore defaults to true.

The code example includes code to display the attributes and their properties. You can also examine the attributes by opening the DLL with the Ildasm.exe (IL Disassembler).

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top