mcs/class/corlib/Documentation/en/System.Resources/SatelliteContractVersionAttribute.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="SatelliteContractVersionAttribute" FullName="System.Resources.SatelliteContractVersionAttribute">
   3   <TypeSignature Maintainer="auto" Language="C#" Value="public sealed class SatelliteContractVersionAttribute : Attribute" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SatelliteContractVersionAttribute extends System.Attribute" />
   5   <AssemblyInfo>
   6     <AssemblyName>mscorlib</AssemblyName>
   7     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
   8     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   9     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  10     <AssemblyVersion>4.0.0.0</AssemblyVersion>
  11   </AssemblyInfo>
  12   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  13   <Base>
  14     <BaseTypeName>System.Attribute</BaseTypeName>
  15   </Base>
  16   <Interfaces />
  17   <Attributes>
  18     <Attribute>
  19       <AttributeName>System.AttributeUsage(System.AttributeTargets.Assembly)</AttributeName>
  20     </Attribute>
  21     <Attribute>
  22       <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
  23     </Attribute>
  24   </Attributes>
  25   <Docs>
  26     <remarks>
  27       <attribution license="cc4" from="Microsoft" modified="false" />
  28       <format type="text/html">
  29         <h2>Desktop Apps</h2>
  30       </format>
  31       <para>In desktop apps, the <see cref="T:System.Resources.SatelliteContractVersionAttribute" /> attribute establishes a contract between a main assembly and all its satellites. You apply this  attribute to your main assembly, and pass it the version number of the satellite assemblies that will work with this version of the main assembly. When the resource manager (<see cref="T:System.Resources.ResourceManager" /> object) looks up resources, it explicitly loads the satellite version specified by this attribute on the main assembly.</para>
  32       <para>When you update the main assembly, you increment its assembly version number. However, you might not want to ship new copies of your satellite assemblies if the existing ones are compatible with your app. In this case, increment the main assembly's version number but leave the satellite contract version number the same. The resource manager will use your existing satellite assemblies.</para>
  33       <para>If you want to revise a satellite assembly but not the main assembly, increment the version number on your satellite. In this case, ship a publisher policy assembly along with your satellite assembly stating that your new satellite assembly has backward compatibility with your old satellite assembly. The resource manager will still use the old contract number written into your main assembly based on the <see cref="T:System.Resources.SatelliteContractVersionAttribute" /> attribute; however, the loader will bind to the satellite assembly version that is specified by the policy assembly.</para>
  34       <para>A vendor of a shared component uses a publisher policy assembly to make a compatibility statement about a particular version of a released assembly. A publisher policy assembly is a strongly named assembly that has a name in the format policy.&lt;major&gt;.&lt;minor&gt;.&lt;ComponentAssemblyName&gt;, and is registered in the <format type="text/html"><a href="cf5eacd0-d3ec-4879-b6da-5fd5e4372202">global assembly cache</a></format>. The publisher policy is generated from an XML configuration file (see the <format type="text/html"><a href="67784ecd-9663-434e-bd6a-26975e447ac0">&lt;bindingRedirect&gt; element</a></format>) by using the <format type="text/html"><a href="b5382965-0053-47cf-b92f-862860275a01">Al.exe (Assembly Linker)</a></format> tool. The Assembly Linker is used with the /link option to link the XML configuration file to a manifest assembly, which is then stored in the global assembly cache. The publisher policy assemblies can be used when a vendor ships a maintenance release (service pack) that contains bug fixes.</para>
  35       <format type="text/html">
  36         <h2>win8_appname_long Apps</h2>
  37       </format>
  38       <para>This attribute is ignored in win8_appname_long apps, because package resource index (PRI) files do not have versioning semantics. In addition, the win8_appname_long packaging model requires all resources to ship in the same package, with no possibility of redeploying satellite assemblies or PRI files. </para>
  39     </remarks>
  40     <summary>
  41       <attribution license="cc4" from="Microsoft" modified="false" />
  42       <para>Instructs a <see cref="T:System.Resources.ResourceManager" /> object to ask for a particular version of a satellite assembly.</para>
  43     </summary>
  44   </Docs>
  45   <Members>
  46     <Member MemberName=".ctor">
  47       <MemberSignature Language="C#" Value="public SatelliteContractVersionAttribute (string version);" />
  48       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string version) cil managed" />
  49       <MemberType>Constructor</MemberType>
  50       <AssemblyInfo>
  51         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  52         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  53         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  54       </AssemblyInfo>
  55       <ReturnValue />
  56       <Parameters>
  57         <Parameter Name="version" Type="System.String" />
  58       </Parameters>
  59       <Docs>
  60         <remarks>
  61           <attribution license="cc4" from="Microsoft" modified="false" />
  62           <para>This constructor initializes the <see cref="P:System.Resources.SatelliteContractVersionAttribute.Version" /> property with the <paramref name="version" /> parameter.</para>
  63         </remarks>
  64         <summary>
  65           <attribution license="cc4" from="Microsoft" modified="false" />
  66           <para>Initializes a new instance of the <see cref="T:System.Resources.SatelliteContractVersionAttribute" /> class.</para>
  67         </summary>
  68         <param name="version">
  69           <attribution license="cc4" from="Microsoft" modified="false" />A string that specifies the version of the satellite assemblies to load. </param>
  70       </Docs>
  71     </Member>
  72     <Member MemberName="Version">
  73       <MemberSignature Language="C#" Value="public string Version { get; }" />
  74       <MemberSignature Language="ILAsm" Value=".property instance string Version" />
  75       <MemberType>Property</MemberType>
  76       <AssemblyInfo>
  77         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  78         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  79         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  80       </AssemblyInfo>
  81       <ReturnValue>
  82         <ReturnType>System.String</ReturnType>
  83       </ReturnValue>
  84       <Docs>
  85         <value>To be added: an object of type 'string'</value>
  86         <remarks>
  87           <attribution license="cc4" from="Microsoft" modified="false" />
  88           <para>The current property indicates the version of the satellite assemblies that will be used with the main assembly marked with this attribute.</para>
  89         </remarks>
  90         <summary>
  91           <attribution license="cc4" from="Microsoft" modified="false" />
  92           <para>Gets the version of the satellite assemblies with the required resources.</para>
  93         </summary>
  94       </Docs>
  95     </Member>
  96   </Members>
  97 </Type>