Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

SatelliteContractVersionAttribute Class

.NET Framework 4

Instructs the ResourceManager to ask for a particular version of a satellite assembly to simplify updates of the main assembly of an application.

System.Object
  System.Attribute
    System.Resources.SatelliteContractVersionAttribute

Namespace:  System.Resources
Assembly:  mscorlib (in mscorlib.dll)
C#
C++
F#
VB
Copy 
[ComVisibleAttribute(true)]
[AttributeUsageAttribute(AttributeTargets.Assembly, AllowMultiple = false)]
public sealed class SatelliteContractVersionAttribute : Attribute

The SatelliteContractVersionAttribute type exposes the following members.

  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library SatelliteContractVersionAttribute Initializes a new instance of the SatelliteContractVersionAttribute class.
Top
  Name Description
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public property Supported by the XNA Framework Supported by Portable Class Library Version Gets the version of the satellite assemblies with the required resources.
Top
  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method Supported by the XNA Framework Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Public method 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.)
Public method Supported by the XNA Framework Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method Supported by the XNA Framework Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfo Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

The SatelliteContractVersionAttribute establishes a contract between a main assembly and all its satellites. When the ResourceManager looks up resources, it explicitly loads the satellite version specified by this attribute on the main assembly, allowing a layer of indirection to facilitate versioning scenarios.

When the main assembly is updated, its assembly version number is incremented. However, you might not want to ship new copies of your satellite assemblies if the existing ones are sufficient and compatible with the newer version of your product. In this case, increment the main assembly's version number but leave the satellite contract version number the same. The ResourceManager will use your existing satellite assemblies.

If you need to revise a satellite assembly but not the main assembly, you must increment the version number on your satellite. In this case, ship a policy assembly along with your satellite assembly stating that your new satellite assembly has backward compatibility with your old satellite assembly. The ResourceManager will still use the old contract number written into your main assembly; however, the loader will bind to the satellite assembly version as specified by the policy assembly.

A publisher policy assembly is the way in which a vendor of a shared component makes a compatibility statement about a particular version of a released assembly. A publisher policy assembly is a strongly named assembly with a name in the format policy.<major>.<minor>.<ComponentAssemblyName>, and is registered in the Global Assembly Cache (GAC). The publisher policy is generated from an XML configuration file (see <bindingRedirect> Element) by using the Al.exe (Assembly Linker) tool. The assembly linker is used with the /link option to link the XML configuration file to a manifest assembly, that is then stored in the GAC. The publisher policy assemblies can be used when a vendor ships a maintenance release (Service Pack) that contains bug fixes.

Note Note

Apply this attribute to your main assembly, passing it the version number of the satellite assembly that will work with this version of the main assembly.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ