mcs/class/System.Data/Documentation/en/System.Data.Odbc/OdbcType.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="OdbcType" FullName="System.Data.Odbc.OdbcType">
   3   <TypeSignature Language="C#" Value="public enum OdbcType" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Data</AssemblyName>
   6     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.Enum</BaseTypeName>
  11   </Base>
  12   <Docs>
  13     <remarks>
  14       <attribution license="cc4" from="Microsoft" modified="false" />
  15       <para>The following table shows mappings between <see cref="T:System.Data.Odbc.OdbcType" /> data types, ODBC data types (shown in parentheses), and .NET Framework types.</para>
  16     </remarks>
  17     <summary>
  18       <attribution license="cc4" from="Microsoft" modified="false" />
  19       <para>Specifies the data type of a field, property, for use in an <see cref="T:System.Data.Odbc.OdbcParameter" />.</para>
  20     </summary>
  21   </Docs>
  22   <Members>
  23     <Member MemberName="BigInt">
  24       <MemberSignature Language="C#" Value="BigInt" />
  25       <MemberType>Field</MemberType>
  26       <ReturnValue>
  27         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
  28       </ReturnValue>
  29       <Docs>
  30         <summary>
  31           <attribution license="cc4" from="Microsoft" modified="false" />
  32           <para>Exact numeric value with precision 19 (if signed) or 20 (if unsigned) and scale 0 (signed: –2[63] &lt;= n &lt;= 2[63] – 1, unsigned:0 &lt;= n &lt;= 2[64] – 1) (SQL_BIGINT). This maps to <see cref="T:System.Int64" />.</para>
  33         </summary>
  34       </Docs>
  35       <AssemblyInfo>
  36         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  37         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  38       </AssemblyInfo>
  39     </Member>
  40     <Member MemberName="Binary">
  41       <MemberSignature Language="C#" Value="Binary" />
  42       <MemberType>Field</MemberType>
  43       <ReturnValue>
  44         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
  45       </ReturnValue>
  46       <Docs>
  47         <summary>
  48           <attribution license="cc4" from="Microsoft" modified="false" />
  49           <para>A stream of binary data (SQL_BINARY). This maps to an <see cref="T:System.Array" /> of type <see cref="T:System.Byte" />.</para>
  50         </summary>
  51       </Docs>
  52       <AssemblyInfo>
  53         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  54         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  55       </AssemblyInfo>
  56     </Member>
  57     <Member MemberName="Bit">
  58       <MemberSignature Language="C#" Value="Bit" />
  59       <MemberType>Field</MemberType>
  60       <ReturnValue>
  61         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
  62       </ReturnValue>
  63       <Docs>
  64         <summary>
  65           <attribution license="cc4" from="Microsoft" modified="false" />
  66           <para>Single bit binary data (SQL_BIT). This maps to <see cref="T:System.Boolean" />.</para>
  67         </summary>
  68       </Docs>
  69       <AssemblyInfo>
  70         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  71         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  72       </AssemblyInfo>
  73     </Member>
  74     <Member MemberName="Char">
  75       <MemberSignature Language="C#" Value="Char" />
  76       <MemberType>Field</MemberType>
  77       <ReturnValue>
  78         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
  79       </ReturnValue>
  80       <Docs>
  81         <summary>
  82           <attribution license="cc4" from="Microsoft" modified="false" />
  83           <para>A fixed-length character string (SQL_CHAR). This maps to <see cref="T:System.String" />.</para>
  84         </summary>
  85       </Docs>
  86       <AssemblyInfo>
  87         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  88         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  89       </AssemblyInfo>
  90     </Member>
  91     <Member MemberName="Date">
  92       <MemberSignature Language="C#" Value="Date" />
  93       <MemberType>Field</MemberType>
  94       <ReturnValue>
  95         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
  96       </ReturnValue>
  97       <Docs>
  98         <summary>
  99           <attribution license="cc4" from="Microsoft" modified="false" />
 100           <para>Date data in the format yyyymmdd (SQL_TYPE_DATE). This maps to <see cref="T:System.DateTime" />.</para>
 101         </summary>
 102       </Docs>
 103       <AssemblyInfo>
 104         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 105         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 106       </AssemblyInfo>
 107     </Member>
 108     <Member MemberName="DateTime">
 109       <MemberSignature Language="C#" Value="DateTime" />
 110       <MemberType>Field</MemberType>
 111       <ReturnValue>
 112         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 113       </ReturnValue>
 114       <Docs>
 115         <summary>
 116           <attribution license="cc4" from="Microsoft" modified="false" />
 117           <para>Date data in the format yyyymmddhhmmss (SQL_TYPE_TIMESTAMP). This maps to <see cref="T:System.DateTime" />.</para>
 118         </summary>
 119       </Docs>
 120       <AssemblyInfo>
 121         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 122         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 123       </AssemblyInfo>
 124     </Member>
 125     <Member MemberName="Decimal">
 126       <MemberSignature Language="C#" Value="Decimal" />
 127       <MemberType>Field</MemberType>
 128       <ReturnValue>
 129         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 130       </ReturnValue>
 131       <Docs>
 132         <summary>
 133           <attribution license="cc4" from="Microsoft" modified="false" />
 134           <para>Signed, exact, numeric value with a precision of at least p and scale s, where 1 &lt;= p &lt;= 15 and s &lt;= p. The maximum precision is driver-specific (SQL_DECIMAL). This maps to <see cref="T:System.Decimal" />.</para>
 135         </summary>
 136       </Docs>
 137       <AssemblyInfo>
 138         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 139         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 140       </AssemblyInfo>
 141     </Member>
 142     <Member MemberName="Double">
 143       <MemberSignature Language="C#" Value="Double" />
 144       <MemberType>Field</MemberType>
 145       <ReturnValue>
 146         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 147       </ReturnValue>
 148       <Docs>
 149         <summary>
 150           <attribution license="cc4" from="Microsoft" modified="false" />
 151           <para>Signed, approximate, numeric value with a binary precision 53 (zero or absolute value 10[–308] to 10[308]) (SQL_DOUBLE). This maps to <see cref="T:System.Double" />.</para>
 152         </summary>
 153       </Docs>
 154       <AssemblyInfo>
 155         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 156         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 157       </AssemblyInfo>
 158     </Member>
 159     <Member MemberName="Image">
 160       <MemberSignature Language="C#" Value="Image" />
 161       <MemberType>Field</MemberType>
 162       <ReturnValue>
 163         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 164       </ReturnValue>
 165       <Docs>
 166         <summary>
 167           <attribution license="cc4" from="Microsoft" modified="false" />
 168           <para>Variable length binary data. Maximum length is data source–dependent (SQL_LONGVARBINARY). This maps to an <see cref="T:System.Array" /> of type <see cref="T:System.Byte" />.</para>
 169         </summary>
 170       </Docs>
 171       <AssemblyInfo>
 172         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 173         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 174       </AssemblyInfo>
 175     </Member>
 176     <Member MemberName="Int">
 177       <MemberSignature Language="C#" Value="Int" />
 178       <MemberType>Field</MemberType>
 179       <ReturnValue>
 180         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 181       </ReturnValue>
 182       <Docs>
 183         <summary>
 184           <attribution license="cc4" from="Microsoft" modified="false" />
 185           <para>Exact numeric value with precision 10 and scale 0 (signed: –2[31] &lt;= n &lt;= 2[31] – 1, unsigned:0 &lt;= n &lt;= 2[32] – 1) (SQL_INTEGER). This maps to <see cref="T:System.Int32" />.</para>
 186         </summary>
 187       </Docs>
 188       <AssemblyInfo>
 189         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 190         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 191       </AssemblyInfo>
 192     </Member>
 193     <Member MemberName="NChar">
 194       <MemberSignature Language="C#" Value="NChar" />
 195       <MemberType>Field</MemberType>
 196       <ReturnValue>
 197         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 198       </ReturnValue>
 199       <Docs>
 200         <summary>
 201           <attribution license="cc4" from="Microsoft" modified="false" />
 202           <para>Unicode character string of fixed string length (SQL_WCHAR). This maps to <see cref="T:System.String" />.</para>
 203         </summary>
 204       </Docs>
 205       <AssemblyInfo>
 206         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 207         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 208       </AssemblyInfo>
 209     </Member>
 210     <Member MemberName="NText">
 211       <MemberSignature Language="C#" Value="NText" />
 212       <MemberType>Field</MemberType>
 213       <ReturnValue>
 214         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 215       </ReturnValue>
 216       <Docs>
 217         <summary>
 218           <attribution license="cc4" from="Microsoft" modified="false" />
 219           <para>Unicode variable-length character data. Maximum length is data source–dependent. (SQL_WLONGVARCHAR). This maps to <see cref="T:System.String" />.</para>
 220         </summary>
 221       </Docs>
 222       <AssemblyInfo>
 223         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 224         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 225       </AssemblyInfo>
 226     </Member>
 227     <Member MemberName="Numeric">
 228       <MemberSignature Language="C#" Value="Numeric" />
 229       <MemberType>Field</MemberType>
 230       <ReturnValue>
 231         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 232       </ReturnValue>
 233       <Docs>
 234         <summary>
 235           <attribution license="cc4" from="Microsoft" modified="false" />
 236           <para>Signed, exact, numeric value with a precision p and scale s, where 1 &lt;= p &lt;= 15, and s &lt;= p (SQL_NUMERIC). This maps to <see cref="T:System.Decimal" />.</para>
 237         </summary>
 238       </Docs>
 239       <AssemblyInfo>
 240         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 241         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 242       </AssemblyInfo>
 243     </Member>
 244     <Member MemberName="NVarChar">
 245       <MemberSignature Language="C#" Value="NVarChar" />
 246       <MemberType>Field</MemberType>
 247       <ReturnValue>
 248         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 249       </ReturnValue>
 250       <Docs>
 251         <summary>
 252           <attribution license="cc4" from="Microsoft" modified="false" />
 253           <para>A variable-length stream of Unicode characters (SQL_WVARCHAR). This maps to <see cref="T:System.String" />.</para>
 254         </summary>
 255       </Docs>
 256       <AssemblyInfo>
 257         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 258         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 259       </AssemblyInfo>
 260     </Member>
 261     <Member MemberName="Real">
 262       <MemberSignature Language="C#" Value="Real" />
 263       <MemberType>Field</MemberType>
 264       <ReturnValue>
 265         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 266       </ReturnValue>
 267       <Docs>
 268         <summary>
 269           <attribution license="cc4" from="Microsoft" modified="false" />
 270           <para>Signed, approximate, numeric value with a binary precision 24 (zero or absolute value 10[–38] to 10[38]).(SQL_REAL). This maps to <see cref="T:System.Single" />.</para>
 271         </summary>
 272       </Docs>
 273       <AssemblyInfo>
 274         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 275         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 276       </AssemblyInfo>
 277     </Member>
 278     <Member MemberName="SmallDateTime">
 279       <MemberSignature Language="C#" Value="SmallDateTime" />
 280       <MemberType>Field</MemberType>
 281       <ReturnValue>
 282         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 283       </ReturnValue>
 284       <Docs>
 285         <summary>
 286           <attribution license="cc4" from="Microsoft" modified="false" />
 287           <para>Data and time data in the format yyyymmddhhmmss (SQL_TYPE_TIMESTAMP). This maps to <see cref="T:System.DateTime" />.</para>
 288         </summary>
 289       </Docs>
 290       <AssemblyInfo>
 291         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 292         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 293       </AssemblyInfo>
 294     </Member>
 295     <Member MemberName="SmallInt">
 296       <MemberSignature Language="C#" Value="SmallInt" />
 297       <MemberType>Field</MemberType>
 298       <ReturnValue>
 299         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 300       </ReturnValue>
 301       <Docs>
 302         <summary>
 303           <attribution license="cc4" from="Microsoft" modified="false" />
 304           <para>Exact numeric value with precision 5 and scale 0 (signed: –32,768 &lt;= n &lt;= 32,767, unsigned: 0 &lt;= n &lt;= 65,535) (SQL_SMALLINT). This maps to <see cref="T:System.Int16" />.</para>
 305         </summary>
 306       </Docs>
 307       <AssemblyInfo>
 308         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 309         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 310       </AssemblyInfo>
 311     </Member>
 312     <Member MemberName="Text">
 313       <MemberSignature Language="C#" Value="Text" />
 314       <MemberType>Field</MemberType>
 315       <ReturnValue>
 316         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 317       </ReturnValue>
 318       <Docs>
 319         <summary>
 320           <attribution license="cc4" from="Microsoft" modified="false" />
 321           <para>Variable length character data. Maximum length is data source–dependent (SQL_LONGVARCHAR). This maps to <see cref="T:System.String" />.</para>
 322         </summary>
 323       </Docs>
 324       <AssemblyInfo>
 325         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 326         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 327       </AssemblyInfo>
 328     </Member>
 329     <Member MemberName="Time">
 330       <MemberSignature Language="C#" Value="Time" />
 331       <MemberType>Field</MemberType>
 332       <ReturnValue>
 333         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 334       </ReturnValue>
 335       <Docs>
 336         <summary>
 337           <attribution license="cc4" from="Microsoft" modified="false" />
 338           <para>Date data in the format hhmmss (SQL_TYPE_TIMES). This maps to <see cref="T:System.DateTime" />.</para>
 339         </summary>
 340       </Docs>
 341       <AssemblyInfo>
 342         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 343         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 344       </AssemblyInfo>
 345     </Member>
 346     <Member MemberName="Timestamp">
 347       <MemberSignature Language="C#" Value="Timestamp" />
 348       <MemberType>Field</MemberType>
 349       <ReturnValue>
 350         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 351       </ReturnValue>
 352       <Docs>
 353         <summary>
 354           <attribution license="cc4" from="Microsoft" modified="false" />
 355           <para>A stream of binary data (SQL_BINARY). This maps to an <see cref="T:System.Array" /> of type <see cref="T:System.Byte" />.</para>
 356         </summary>
 357       </Docs>
 358       <AssemblyInfo>
 359         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 360         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 361       </AssemblyInfo>
 362     </Member>
 363     <Member MemberName="TinyInt">
 364       <MemberSignature Language="C#" Value="TinyInt" />
 365       <MemberType>Field</MemberType>
 366       <ReturnValue>
 367         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 368       </ReturnValue>
 369       <Docs>
 370         <summary>
 371           <attribution license="cc4" from="Microsoft" modified="false" />
 372           <para>Exact numeric value with precision 3 and scale 0 (signed: –128 &lt;= n &lt;= 127, unsigned:0 &lt;= n &lt;= 255)(SQL_TINYINT). This maps to <see cref="T:System.Byte" />.</para>
 373         </summary>
 374       </Docs>
 375       <AssemblyInfo>
 376         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 377         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 378       </AssemblyInfo>
 379     </Member>
 380     <Member MemberName="UniqueIdentifier">
 381       <MemberSignature Language="C#" Value="UniqueIdentifier" />
 382       <MemberType>Field</MemberType>
 383       <ReturnValue>
 384         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 385       </ReturnValue>
 386       <Docs>
 387         <summary>
 388           <attribution license="cc4" from="Microsoft" modified="false" />
 389           <para>A fixed-length GUID (SQL_GUID). This maps to <see cref="T:System.Guid" />.</para>
 390         </summary>
 391       </Docs>
 392       <AssemblyInfo>
 393         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 394         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 395       </AssemblyInfo>
 396     </Member>
 397     <Member MemberName="VarBinary">
 398       <MemberSignature Language="C#" Value="VarBinary" />
 399       <MemberType>Field</MemberType>
 400       <ReturnValue>
 401         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 402       </ReturnValue>
 403       <Docs>
 404         <summary>
 405           <attribution license="cc4" from="Microsoft" modified="false" />
 406           <para>Variable length binary. The maximum is set by the user (SQL_VARBINARY). This maps to an <see cref="T:System.Array" /> of type <see cref="T:System.Byte" />.</para>
 407         </summary>
 408       </Docs>
 409       <AssemblyInfo>
 410         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 411         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 412       </AssemblyInfo>
 413     </Member>
 414     <Member MemberName="VarChar">
 415       <MemberSignature Language="C#" Value="VarChar" />
 416       <MemberType>Field</MemberType>
 417       <ReturnValue>
 418         <ReturnType>System.Data.Odbc.OdbcType</ReturnType>
 419       </ReturnValue>
 420       <Docs>
 421         <summary>
 422           <attribution license="cc4" from="Microsoft" modified="false" />
 423           <para>A variable-length stream character string (SQL_CHAR). This maps to <see cref="T:System.String" />.</para>
 424         </summary>
 425       </Docs>
 426       <AssemblyInfo>
 427         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 428         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 429       </AssemblyInfo>
 430     </Member>
 431   </Members>
 432 </Type>