mcs/class/System.Data/Documentation/en/System.Data.Sql/SqlDataSourceEnumerator.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="SqlDataSourceEnumerator" FullName="System.Data.Sql.SqlDataSourceEnumerator">
   3   <TypeSignature Language="C#" Value="public sealed class SqlDataSourceEnumerator : System.Data.Common.DbDataSourceEnumerator" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Data</AssemblyName>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Data.Common.DbDataSourceEnumerator</BaseTypeName>
  10   </Base>
  11   <Interfaces />
  12   <Docs>
  13     <since version=".NET 2.0" />
  14     <remarks>
  15       <attribution license="cc4" from="Microsoft" modified="false" />
  16       <para>Both SQL Server 2000 and SQL Server 2005 make it possible for applications to determine the existence of SQL Server instances within the current network. The <see cref="T:System.Data.Sql.SqlDataSourceEnumerator" /> class exposes this information to the application developer, providing a <see cref="T:System.Data.DataTable" /> containing information about all the available servers. This returned table contains a list of server instances that matches the list provided when a user attempts to create a new connection, and on the <paramref name="Connection Properties" /> dialog box, expands the drop-down list containing all the available servers.</para>
  17     </remarks>
  18     <summary>
  19       <attribution license="cc4" from="Microsoft" modified="false" />
  20       <para>Provides a mechanism for enumerating all available instances of SQL Server within the local network.</para>
  21     </summary>
  22   </Docs>
  23   <Members>
  24     <Member MemberName="GetDataSources">
  25       <MemberSignature Language="C#" Value="public override System.Data.DataTable GetDataSources ();" />
  26       <MemberType>Method</MemberType>
  27       <ReturnValue>
  28         <ReturnType>System.Data.DataTable</ReturnType>
  29       </ReturnValue>
  30       <Parameters />
  31       <Docs>
  32         <returns>To be added.</returns>
  33         <since version=".NET 2.0" />
  34         <remarks>
  35           <attribution license="cc4" from="Microsoft" modified="false" />
  36           <para>The table returned by this method contains the following columns, all of which contain strings:</para>
  37           <list type="table">
  38             <listheader>
  39               <item>
  40                 <term>
  41                   <para>Column</para>
  42                 </term>
  43                 <description>
  44                   <para>Description</para>
  45                 </description>
  46               </item>
  47             </listheader>
  48             <item>
  49               <term>
  50                 <para>ServerName</para>
  51               </term>
  52               <description>
  53                 <para>Name of the server.</para>
  54               </description>
  55             </item>
  56             <item>
  57               <term>
  58                 <para>InstanceName</para>
  59               </term>
  60               <description>
  61                 <para>Name of the server instance. Blank if the server is running as the default instance.</para>
  62               </description>
  63             </item>
  64             <item>
  65               <term>
  66                 <para>IsClustered</para>
  67               </term>
  68               <description>
  69                 <para>Indicates whether the server is part of a cluster.</para>
  70               </description>
  71             </item>
  72             <item>
  73               <term>
  74                 <para>Version</para>
  75               </term>
  76               <description>
  77                 <para>Version of the server (8.00.x for SQL Server 2000, and 9.00.x for SQL Server 2005).</para>
  78               </description>
  79             </item>
  80           </list>
  81           <block subset="none" type="note">
  82             <para>Due to the nature of the mechanism used by <see cref="T:System.Data.Sql.SqlDataSourceEnumerator" /> to locate data sources on a network, the method will not always return a complete list of the available servers, and the list might not be the same on every call. If you plan to use this function to let users select a server from a list, make sure that you always also supply an option to type in a name that is not in the list, in case the server enumeration does not return all the available servers. In addition, this method may take a significant amount of time to execute, so be careful about calling it when performance is critical.</para>
  83           </block>
  84         </remarks>
  85         <summary>
  86           <attribution license="cc4" from="Microsoft" modified="false" />
  87           <para>Retrieves a <see cref="T:System.Data.DataTable" /> containing information about all visible SQL Server 2000 or SQL Server 2005 instances.</para>
  88         </summary>
  89       </Docs>
  90       <AssemblyInfo>
  91         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  92       </AssemblyInfo>
  93     </Member>
  94     <Member MemberName="Instance">
  95       <MemberSignature Language="C#" Value="public static System.Data.Sql.SqlDataSourceEnumerator Instance { get; }" />
  96       <MemberType>Property</MemberType>
  97       <ReturnValue>
  98         <ReturnType>System.Data.Sql.SqlDataSourceEnumerator</ReturnType>
  99       </ReturnValue>
 100       <Docs>
 101         <value>To be added.</value>
 102         <since version=".NET 2.0" />
 103         <remarks>
 104           <attribution license="cc4" from="Microsoft" modified="false" />
 105           <para>The <see cref="T:System.Data.Sql.SqlDataSourceEnumerator" /> class does not provide a constructor. Use the <see cref="P:System.Data.Sql.SqlDataSourceEnumerator.Instance" /> property to retrieve an instance of the class instead.</para>
 106         </remarks>
 107         <summary>
 108           <attribution license="cc4" from="Microsoft" modified="false" />
 109           <para>Gets an instance of the <see cref="T:System.Data.Sql.SqlDataSourceEnumerator" />, which can be used to retrieve information about available SQL Server instances.</para>
 110         </summary>
 111       </Docs>
 112       <AssemblyInfo>
 113         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 114       </AssemblyInfo>
 115     </Member>
 116   </Members>
 117 </Type>