File: IHashCodeProvider.xml

package info (click to toggle)
monodoc 1.9-2
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 98,436 kB
  • ctags: 5,261
  • sloc: xml: 1,506,218; cs: 40,827; sh: 3,647; perl: 554; makefile: 476
file content (84 lines) | stat: -rwxr-xr-x 3,940 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
<Type Name="IHashCodeProvider" FullName="System.Collections.IHashCodeProvider" FullNameSP="System_Collections_IHashCodeProvider" Maintainer="ecma">
  <TypeSignature Language="ILASM" Value=".class interface public abstract IHashCodeProvider" />
  <TypeSignature Language="C#" Value="public interface IHashCodeProvider" />
  <MemberOfLibrary>BCL</MemberOfLibrary>
  <AssemblyInfo>
    <AssemblyName>mscorlib</AssemblyName>
    <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Docs>
    <summary>
      <para> Implemented by classes that support custom hash functions for instances of the class.</para>
    </summary>
    <remarks>
      <para>
        <block subset="none" type="note">
          <see cref="T:System.Collections.IHashCodeProvider" /> contains the <see cref="M:System.Collections.IHashCodeProvider.GetHashCode(System.Object)" /> method. The consumer of an
 object should call this method to obtain a hash code for the object using a
 custom hash function.</block>
      </para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName="GetHashCode">
      <MemberSignature Language="ILASM" Value=".method public hidebysig virtual abstract int32 GetHashCode(object obj)" />
      <MemberSignature Language="C#" Value="public int GetHashCode (object obj);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="obj" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="obj">The <see cref="T:System.Object" /> for which a hash code is to be generated.</param>
        <summary>
          <para>Generates a hash code for the specified <see cref="T:System.Object" />.</para>
        </summary>
        <returns>
          <para>A <see cref="T:System.Int32" /> containing the hash code for the specified <see cref="T:System.Object" />.</para>
        </returns>
        <remarks>
          <para>
            <block subset="none" type="behaviors">If <paramref name="obj" /> is <see langword="null" />, it is required that a call to
<see cref="M:System.Collections.IHashCodeProvider.GetHashCode(System.Object)" /> throw <see cref="T:System.ArgumentNullException" />.</block>
          </para>
          <para>
            <block subset="none" type="overrides">Implement
   this method to generate a better hash table
   distribution than the default method provided by the type of the <see cref="T:System.Object" /> for which the hash code is
   being generated.</block>
          </para>
          <para>
            <block subset="none" type="usage">The value returned by this method
   should not be persisted past the lifetime of the application that created the
   value. The first reason is that the hash function of a class might be
   altered to generate a better distribution, rendering any values from the old
   hash function useless. The second reason is that the default
   implementation of this class does not guarantee that the same value will be
   returned by different instances.</block>
          </para>
        </remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="obj " /> is <see langword="null" />.</exception>
      </Docs>
      <Excluded>0</Excluded>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
  <TypeExcluded>0</TypeExcluded>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName>System.Obsolete("Please use IEqualityComparer instead.")</AttributeName>
    </Attribute>
  </Attributes>
</Type>