Images

Classifications

G06F9/06—Arrangements for program control, e.g. control units using stored programs, i.e. using an internal store of processing equipment to receive or retain programs

G06F9/46—Multiprogramming arrangements

Y—GENERAL TAGGING OF NEW TECHNOLOGICAL DEVELOPMENTS; GENERAL TAGGING OF CROSS-SECTIONAL TECHNOLOGIES SPANNING OVER SEVERAL SECTIONS OF THE IPC; TECHNICAL SUBJECTS COVERED BY FORMER USPC CROSS-REFERENCE ART COLLECTIONS [XRACs] AND DIGESTS

Y—GENERAL TAGGING OF NEW TECHNOLOGICAL DEVELOPMENTS; GENERAL TAGGING OF CROSS-SECTIONAL TECHNOLOGIES SPANNING OVER SEVERAL SECTIONS OF THE IPC; TECHNICAL SUBJECTS COVERED BY FORMER USPC CROSS-REFERENCE ART COLLECTIONS [XRACs] AND DIGESTS

Y—GENERAL TAGGING OF NEW TECHNOLOGICAL DEVELOPMENTS; GENERAL TAGGING OF CROSS-SECTIONAL TECHNOLOGIES SPANNING OVER SEVERAL SECTIONS OF THE IPC; TECHNICAL SUBJECTS COVERED BY FORMER USPC CROSS-REFERENCE ART COLLECTIONS [XRACs] AND DIGESTS

Abstract

An application program interface (API) provides a set of functions for application developers who build Web applications on Microsoft Corporation's .NET™ platform.

Description

TECHNICAL FIELD

This invention relates to network software, such as Web applications, and to computer software development of such network software. More particularly, this invention relates to an application program interface (API) that facilitates use of a network software platform by application programs and computer hardware.

BACKGROUND

Very early on, computer software came to be categorized as “operating system” software or “application” software. Broadly speaking, an application is software meant to perform a specific task for the computer user such as solving a mathematical equation or supporting word processing. The operating system is the software that manages and controls the computer hardware. The goal of the operating system is to make the computer resources available to the application programmer while at the same time, hiding the complexity necessary to actually control the hardware.

The operating system makes the resources available via functions that are collectively known as the Application Program Interface or API. The term API is also used in reference to a single one of these functions. The functions are often grouped in terms of what resource or service they provide to the application programmer. Application software requests resources by calling individual API functions. API functions also serve as the means by which messages and information provided by the operating system are relayed back to the application software.

In addition to changes in hardware, another factor driving the evolution of operating system software has been the desire to simplify and speed application software development. Application software development can be a daunting task, sometimes requiring years of developer time to create a sophisticated program with millions of lines of code. For a popular operating system such as Microsoft Windows®, application software developers write thousands of different applications each year that utilize the operating system. A coherent and usable operating system base is required to support so many diverse application developers.

Often, development of application software can be made simpler by making the operating system more complex. That is, if a function may be useful to several different application programs, it may be better to write it once for inclusion in the operating system, than requiring dozens of software developers to write it dozens of times for inclusion in dozens of different applications. In this manner, if the operating system supports a wide range of common functionality required by a number of applications, significant savings in applications software development costs and time can be achieved.

Regardless of where the line between operating system and application software is drawn, it is clear that for a useful operating system, the API between the operating system and the computer hardware and application software is as important as efficient internal operation of the operating system itself Over the past few years, the universal adoption of the Internet, and networking technology in general, has changed the landscape for computer software developers. Traditionally, software developers focused on single-site software applications for standalone desktop computers, or LAN-based computers that were connected to a limited number of other computers via a local area network (LAN). Such software applications were typically referred to as “shrink wrapped” products because the software was marketed and sold in a shrink-wrapped package. The applications utilized well-defined APIs to access the underlying operating system of the computer.

As the Internet evolved and gained widespread acceptance, the industry began to recognize the power of hosting applications at various sites on the World Wide Web (or simply the “Web”). In the networked world, clients from anywhere could submit requests to server-based applications hosted at diverse locations and receive responses back in fractions of a second. These Web applications, however, were typically developed using the same operating system platform that was originally developed for standalone computing machines or locally networked computers. Unfortunately, in some instances, these applications do not adequately transfer to the distributed computing regime. The underlying platform was simply not constructed with the idea of supporting limitless numbers of interconnected computers.

To accommodate the shift to the distributed computing environment being ushered in by the Internet, Microsoft Corporation is developing a network software platform known as the “.NET” platform (read as “Dot Net”). The platform allows developers to create Web services that will execute over the Internet. Such a dynamic shift requires a new ground-up design of an entirely new API.

In response to this challenge, the inventors developed a unique set of API functions for Microsoft's .NET™ platform.

SUMMARY

An application program interface (API) provides a set of functions for application developers who build Web applications on a network platform, such as Microsoft Corporation's .NET™ platform.

BRIEF DESCRIPTION OF THE DRAWINGS

The same numbers are used throughout the drawings to reference like features.

FIG. 1 illustrates a network architecture in which clients access Web services over the Internet using conventional protocols.

FIG. 2 is a block diagram of a software architecture for Microsoft's .NET™ platform, which includes an application program interface (API).

FIG. 3 is a block diagram of unique namespaces supported by the API, as well as function classes of the various API functions.

FIG. 4 is a block diagram of an exemplary computer that may execute all or part of the software architecture.

BRIEF DESCRIPTION OF ACCOMPANYING COMPACT DISC

Accompanying this specification is a compact disc that stores a compiled HTML help file identifying the API (application program interface) for Microsoft's .NET™ network platform. The file is named “cpref.chm” and was created on Jun. 8, 2001. It is 30.81 Mbytes in size. The file can be executed on a Windows®-based computing device (e.g., IBM-PC, or equivalent) that executes a Windows®-brand operating system (e.g., Windows® NT, Windows® 98, Windows® 2000, etc.). The compiled HTML help file stored on the compact disk is hereby incorporated by reference.

Additionally, the APIs contained in the compiled HTML help file are also provided in approximately 100 separate text files named “NamespaceName.txt”. The text files comply with the ASCII format.

The compact disc itself is a CD-ROM, and conforms to the ISO 9660 standard.

DETAILED DESCRIPTION

This disclosure addresses an application program interface (API) for a network platform upon which developers can build Web applications and services. More particularly, an exemplary API is described for the .NET™ platform created by Microsoft Corporation. The .NET™ platform is a software platform for Web services and Web applications implemented in the distributed computing environment. It represents the next generation of Internet computing, using open communication standards to communicate among loosely coupled Web services that are collaborating to perform a particular task.

In the described implementation, the .NET™ platform utilizes XML (extensible markup language), an open standard for describing data. XML is managed by the World Wide Web Consortium (W3C). XML is used for defining data elements on a Web page and business-to-business documents. XML uses a similar tag structure as HTML; however, whereas HTML defines how elements are displayed, XML defines what those elements contain. HTML uses predefined tags, but XML allows tags to be defined by the developer of the page. Thus, virtually any data items can be identified, allowing Web pages to function like database records. Through the use of XML and other open protocols, such as Simple Object Access Protocol (SOAP), the .NET™ platform allows integration of a wide range of services that can be tailored to the needs of the user. Although the embodiments described herein are described in conjunction with XML and other open standards, such are not required for the operation of the claimed invention. Other equally viable technologies will suffice to implement the inventions described herein.

As used herein, the phrase application program interface or API includes traditional interfaces that employ method or function calls, as well as remote calls (e.g., a proxy, stub relationship) and SOAP/XML invocations.

Exemplary Network Environment

FIG. 1 shows a network environment 100 in which a network platform, such as the .NET™ platform, may be implemented. The network environment 100 includes representative Web services 102(1), . . . , 102(N), which provide services that can be accessed over a network 104 (e.g., Internet). The Web services, referenced generally as number 102, are programmable application components that are reusable and interact programmatically over the network 104, typically through industry standard Web protocols, such as XML, SOAP, WAP (wireless application protocol), HTTP (hypertext transport protocol), and SMTP (simple mail transfer protocol) although other means of interacting with the Web services over the network may also be used, such as Remote Procedure Call (RPC) or object broker type technology. A Web service can be self-describing and is often defined in terms of formats and ordering of messages.

Web services 102 are accessible directly by other services (as represented by communication link 106) or a software application, such as Web application 110 (as represented by communication links 112 and 114). Each Web service 102 is illustrated as including one or more servers that execute software to handle requests for particular services. Such services often maintain databases that store information to be served back to requesters. Web services may be configured to perform any one of a variety of different services. Examples of Web services include login verification, notification, database storage, stock quoting, location directories, mapping, music, electronic wallet, calendar/scheduler, telephone listings, news and information, games, ticketing, and so on. The Web services can be combined with each other and with other applications to build intelligent interactive experiences.

The network environment 100 also includes representative client devices 120(1), 120(2), 120(3), 120(4), . . . , 120(M) that utilize the Web services 102 (as represented by communication link 122) and/or the Web application 110 (as represented by communication links 124, 126, and 128). The clients may communicate with one another using standard protocols as well, as represented by an exemplary XML link 130 between clients 120(3) and 120(4).

The Web application 110 is an application designed to run on the network platform and may utilize the Web services 102 when handling and servicing requests from clients 120. The Web application 110 is composed of one or more software applications 130 that run a top a programming framework 132, which are executing on one or more servers 134 or other computer systems. Note that a portion of Web application 110 may actually reside on one or more of clients 120. Alternatively, Web application 110 may coordinate with other software on clients 120 to actually accomplish its tasks.

The programming framework 132 is the structure that supports the applications and services developed by application developers. It permits multi-language development and seamless integration by supporting multiple languages. It supports open protocols, such as SOAP, and encapsulates the underlying operating system and object model services. The framework provides a robust and secure execution environment for the multiple programming languages and offers secure, integrated class libraries.

The framework 132 is a multi-tiered architecture that includes an application program interface (API) layer 142, a common language runtime (CLR) layer 144, and an operating system/services layer 146. This layered architecture allows updates and modifications to various layers without impacting other portions of the framework. A common language specification (CLS) 140 allows designers of various languages to write code that is able to access underlying library functionality. The specification 140 functions as a contract between language designers and library designers that can be used to promote language interoperability. By adhering to the CLS, libraries written in one language can be directly accessible to code modules written in other languages to achieve seamless integration between code modules written in one language and code modules written in another language. One exemplary detailed implementation of a CLS is described in an ECMA standard created by participants in ECMA TC39/TG3. The reader is directed to the ECMA web site at www.ecma.ch.

The API layer 142 presents groups of functions that the applications 130 can call to access the resources and services provided by layer 146. By exposing the API functions for a network platform, application developers can create Web applications for distributed computing systems that make full use of the network resources and other Web services, without needing to understand the complex interworkings of how those network resources actually operate or are made available. Moreover, the Web applications can be written in any number of programming languages, and translated into an intermediate language supported by the common language runtime 144 and included as part of the common language specification 140. In this way, the API layer 142 can provide methods for a wide and diverse variety of applications.

Additionally, the framework 132 can be configured to support API calls placed by remote applications executing remotely from the servers 134 that host the framework. Representative applications 148(1) and 148(2) residing on clients 120(3) and 120(M), respectively, can use the API functions by making calls directly, or indirectly, to the API layer 142 over the network 104.

The framework may also be implemented at the clients. Client 120(3) represents the situation where a framework 150 is implemented at the client. This framework may be identical to server-based framework 132, or modified for client purposes. Alternatively, the client-based framework may be condensed in the event that the client is a limited or dedicated function device, such as a cellular phone, personal digital assistant, handheld computer, or other communication/computing device.

Developers' Programming Framework

FIG. 2 shows the programming framework 132 in more detail. The common language specification (CLS) layer 140 supports applications written in a variety of languages 130(1), 130(2), 130(3), 130(4), . . . , 130(K). Such application languages include Visual Basic, C++, C#, COBOL, Jscript, Perl, Eiffel, Python, and so on. The common language specification 140 specifies a subset of features or rules about features that, if followed, allow the various languages to communicate. For example, some languages do not support a given type (e.g., an “int*” type) that might otherwise be supported by the common language runtime 144. In this case, the common language specification 140 does not include the type. On the other hand, types that are supported by all or most languages (e.g., the “int[ ]” type) is included in common language specification 140 so library developers are free to use it and are assured that the languages can handle it. This ability to communicate results in seamless integration between code modules written in one language and code modules written in another language. Since different languages are particularly well suited to particular tasks, the seamless integration between languages allows a developer to select a particular language for a particular code module with the ability to use that code module with modules written in different languages. The common language runtime 144 allow seamless multi-language development, with cross language inheritance, and provide a robust and secure execution environment for the multiple programming languages. For more information on the common language specification 140 and the common language runtime 144, the reader is directed to co-pending applications entitled “Method and System for Compiling Multiple Languages”, filed Jun. 21, 2000 (Ser. No. 09/598,105) and “Unified Data Type System and Method” filed Jul. 7, 2000 (Ser. No. 09/613,289), which are incorporated by reference.

The API 142 groups API functions into multiple namespaces. Namespaces essentially define a collection of classes, interfaces, delegates, enumerations, and structures, which are collectively called “types”, that provide a specific set of related functionality. A class represents managed heap allocated data that has reference assignment semantics. A delegate is an object oriented function pointer. An enumeration is a special kind of value type that represents named constants. A structure represents static allocated data that has value assignment semantics. An interface defines a contract that other types can implement.

By using namespaces, a designer can organize a set of types into a hierarchical namespace. The designer is able to create multiple groups from the set of types, with each group containing at least one type that exposes logically related functionality. In the exemplary implementation, the API 142 is organized into four root namespaces: a first namespace 200 for Web applications, a second namespace 202 for client applications, a third namespace 204 for data and XML, and a fourth namespace 206 for base class libraries (BCLs). Each group can then be assigned a name. For instance, types in the Web applications namespace 200 are assigned the name “Web”, and types in the data and XML namespace 204 can be assigned names “Data” and “XML” respectively. The named groups can be organized under a single “global root” namespace for system level APIs, such as an overall System namespace. By selecting and prefixing a top level identifier, the types in each group can be easily referenced by a hierarchical name that includes the selected top level identifier prefixed to the name of the group containing the type. For instance, types in the Web applications namespace 200 can be referenced using the hierarchical name “System.Web”. In this way, the individual namespaces 200, 202, 204, and 206 become major branches off of the System namespace and can carry a designation where the individual namespaces are prefixed with a designator, such as a “System.” prefix.

The Web applications namespace 200 pertains to Web based functionality, such as dynamically generated Web pages (e.g., Microsoft's Active Server Pages (ASP)). It supplies types that enable browser/server communication. The client applications namespace 202 pertains to drawing and client side UI functionality. It supplies types that enable drawing of two-dimensional (2D), imaging, and printing, as well as the ability to construct window forms, menus, boxes, and so on.

In addition to the framework 132, programming tools 210 are provided to assist the developer in building Web services and/or applications. One example of the programming tools 200 is Visual Studio™, a multi-language suite of programming tools offered by Microsoft Corporation.

Root API Namespaces

FIG. 3 shows the API 142 and its four root namespaces in more detail. In one embodiment, the namespaces are identified according to a hierarchical naming convention in which strings of names are concatenated with periods. For instance, the Web applications namespace 200 is identified by the root name “System.Web”. Within the “Sytem.Web” namespace is another namespace for Web services, identified as “System.Web.Services”, which further identifies another namespace for a description known as “System.Web.Services.Description”. With this naming convention in mind, the following provides a general overview of selected namespaces of the API 142, although other naming conventions could be used with equal effect.

A services namespace 300 (“System.Web.Services”) containing classes that enable a developer to build and use Web services. The services namespace 300 defines additional namespaces, including a description namespace 302 (“System.Web.Services.Description”) containing classes that enable a developer to publicly describe a Web service via a service description language (such as WSDL, a specification available from the W3C), a discovery namespace 304 (“System.Web.Services.Discovery”) containing classes that allow Web service consumers to locate available Web Services on a Web server, and a protocols namespace 306 (“System.Web.Services.Protocols”) containing classes that define the protocols used to transmit data across a network during communication between Web service clients and the Web service itself.

A caching namespace 308 (“System.Web.Caching”) containing classes that enable developers to decrease Web application response time through temporarily caching frequently used resources on the server. This includes ASP.NET pages, web services, and user controls. (ASP.NET is the updated version of Microsoft's ASP technology.) Additionally, a cache dictionary is available for developers to store frequently used resources, such as hash tables and other data structures.

A configuration namespace 310 (“System.Web.Configuration”) containing classes that are used to read configuration data in for an application.

A UI namespace 312 (“System.Web.UI”) containing types that allow developers to create controls and pages that will appear in Web applications as user interfaces on a Web page. This namespace includes the control class, which provides all web based controls, whether those encapsulating HTML elements, higher level Web controls, or even custom User controls, with a common set of functionality. Also provided are classes which provide the web forms server controls data binding functionality, the ability to save the view state of a given control or page, as well as parsing functionality for both programmable and literal controls. Within the UI namespace 312 are two additional namespaces: an HTML controls namespace 314 (“System.Web.UI.HtmlControls”) containing classes that permit developers to interact with types that encapsulates html 3.2 elements create HTML controls, and a Web controls namespace 316 (“System.Web.UI.WeblControls”) containing classes that allow developers to create higher level Web controls.

A security namespace 318 (“System.Web.Security”) containing classes used to implement security in web server applications, such as basic authentication, challenge response authentication, and role based authentication.

A session state namespace 320 (“System.Web.SessionState”) containing classes used to access session state values (i.e., data that lives across requests for the lifetime of the session) as well as session-level settings and lifetime management methods.

The client applications namespace 202 is composed of two namespaces:

A windows forms namespace 322 (“System.Windows.Forms”) containing classes for creating Windows®-based client applications that take full advantage of the rich user interface features available in the Microsoft Windows® operating system, such as the ability to drag and drop screen elements. Such classes may include wrapped APIs available in the Microsoft Windows® operating system that are used in a windowing UI environment. Within this namespace are a design namespace 324 (“System.Windows.Forms.Design”) that contains classes to extend design-time support for Windows forms and a component model namespace 326 (“System.Windows.Forms.ComponentModel”) that contains the windows form implementation of the general component model defined in System.ComponentModel. This namespace contains designer tools, such as Visual Studio, which offer a rich experience for developers at design time.

A data namespace 340 (“System.Data”) containing classes that enable developers to build components that efficiently manage data from multiple data sources. It implements an architecture that, in a disconnected scenario (such as the Internet), provides tools to request, update, and reconcile data in multiple tier systems. The data namespace 340 includes a common namespace 342 that contains types shared by data providers. A data provider describes a collection of types used to access a data source, such as a database, in the managed space. The data namespace 340 also includes an OLE DB namespace 344 that contains types pertaining to data used in object-oriented databases (e.g., Microsoft's SQL Server), and a SQL client namespace 346 that contains types pertaining to data used by SQL clients. The data namespace also includes a SQL types namespace 348 (“System.Data.SqlTypes”) that contains classes for native data types within Microsoft's SQL Server. The classes provide a safer, faster alternative to other data types. Using the objects within this namespace helps prevent type conversion errors caused in situations where loss of precision could occur. Because other data types are converted to and from SQL types behind the scenes, explicitly creating and using objects within this namespace results in faster code as well.

A diagnostics namespace 364 (“System.Diagnostics”) containing classes that are used to debug applications and to trace code execution. The namespace allows developers to start system processes, read and write to event logs, and monitor system performance using performance counters.

A globalization namespace 366 (“System.Globalization”) containing classes that define culture-related information, including the language, the country/region, the calendars in use, the format patterns for dates, currency and numbers, and the sort order for strings.

An I/O namespace 368 (“System.IO”) containing the infrastructure pieces to operate with the input/output of data streams, files, and directories. This namespace includes a model for working with streams of bytes, higher level readers and writers which consume those bytes, various constructions or implementations of the streams (e.g., FileStream and MemoryStream) and, a set of utility classes for working with files and directories.

A net namespace 370 (“System.Net”) providing an extensive set of classes for building network-enabled application, referred to as the Net Class Libraries (NCL). One element to the design of the Net Class Libraries is an extensible, layered approach to exposing networking functionality. The NCL stack contains three basic layers. A base layer (System.Net.Socket) provides access to an interface to TCP/IP, the communications protocol of UNIX networks and the Internet. One example of such an interface is the “WinSock API” from Microsoft Corporation. The next layer is the Transport Protocol classes, which support such transport protocols as TCP and UDP. Developers may write their own protocol classes to provide support for protocols such as IGMP and ICMP. The third layer is the Web request, which provides an abstract factory pattern for the creation of other protocol classes. The NCL provides implementations for Hyper Text Transport Protocol (HTTP).

A reflection namespace (“System.Reflection”) 372 containing types that provide a managed view of loaded types, methods, and fields, with the ability to dynamically create and invoke types.

A resources namespace 374 (“System.Resources”) containing classes and interfaces that allow developers to create, store and manage various culture-specific resources used in an application.

A security namespace 376 (“System.Security”) supporting the underlying structure of the security system, including interfaces, attributes, exceptions, and base classes for permissions.

A service process namespace 378 (“System.ServiceProcess”) containing classes that allow developers to install and run services. Services are long-running executables that run without a user interface. They can be installed to run under a system account that enables them to be started at computer reboot. Services whose implementation is derived from processing in one class can define specific behavior for start, stop, pause, and continue commands, as well as behavior to take when the system shuts down.

A text namespace 380 (“System.Text”) containing classes representing various types of encodings (e.g., ASCII, Unicode, UTF-7, and UTF-8), abstract base classes for converting blocks of characters to and from blocks of bytes, and a helper class that manipulates and formats string objects without creating intermediate instances.

A threading namespace 382 (“System.Threading”) containing classes and interfaces that enable multi-threaded programming. The threading namespace includes a ThreadPool class that manages groups of threads, a Timer class that enables a delegate to be called after a specified amount of time, and a Mutex class for synchronizing mutually-exclusive threads. This namespace also provides classes for thread scheduling, wait notification, and deadlock resolution.

A runtime namespace 384 (“System.Runtime”) containing multiple namespaces concerning runtime features, including an interoperation services namespace 386 (“System.Runtime.InteropServices”) that contains a collection of classes useful for accessing COM objects. The types in the InteropServices namespace fall into the following areas of functionality: attributes, exceptions, managed definitions of COM types, wrappers, type converters, and the Marshal class. The runtime namespace 384 further includes a remoting namespace 388 (“System.Runtime.Remoting”) that contains classes and interfaces allowing developers to create and configure distributed applications. Another namespace within the runtime namespace 384 is a serialization namespace 390 (“System.Runtime.Serialization”) that contains classes used for serializing and deserializing objects. Serialization is the process of converting an object or a graph of objects into a linear sequence of bytes for either storage or transmission to another location.

The data namespace 340 contains various classes, including a constraint class that contains rules to maintain the integrity of data in a data table. A data column class provides the fundamental components for creating the schema of a data table. This schema is built by adding together one or more data column objects. A data column collection class defines the schema of a data table and determines the type of data each data column can contain. A data relation class is used to relate two data table objects to one another through data column objects.

The data namespace 340 also includes a data row class that provides a primary component of the data table. A data row collection contains the actual data for the data table. A data row change event and a data column change event occur when a change is made to a data row's value or a data column's value, respectively.

The common namespace 342 contains types shared by multiple data providers. The common namespace 342 also includes various classes, such as a data adapter class that allows for the exchange of data between a data source and a data set. A data column mapping class maps column names from a data source to corresponding column names in a data table. A data table mapping class maps data returned from a query of a data source to a data table.

The OLE DB namespace 344 includes a command builder class that automatically generates SQL statements for data table updates and a connection class that provides connections to a data source, such as a network server.

The SQL client namespace 346 also includes a command builder class. Additionally, the SQL client namespace includes a connection class that represents a unique session to an SQL server data source and a data adapter class that exchanges data between a data set and an SQL server for retrieving and saving data.

Using these classes helps prevent type conversion errors caused in situations where loss of precision could occur. Other data types are converted to and from SQL types (behind the scenes), such that explicitly creating and using objects in the data namespace results in faster code. Specific details regarding the System.Data namespace are provided below.

System.Data

Description

The System.Data namespace consists mostly of the classes that constitute the ADO.NET architecture. The ADO.NET architecture enables you to build components that efficiently manage data from multiple data sources. In a disconnected scenario (such as the Internet), ADO.NET provides the tools to request, update, and reconcile data in multiple tier systems. The ADO.NET architecture is also implemented in client applications, such as Windows Forms, or HTML pages created by ASP.NET.

AcceptRejectRule enumeration (System.Data)

Description

Determines the action that occurs when the System.Data.DataSet.AcceptChanges or System.Data.DataTable.RejectChanges method is invoked on a System.Data.DataTable with a System.Data.ForeignKeyConstraint.

Changes to a System.Data.DataTable are not final until you call the System.Data.DataTable.AcceptChanges method. At that time, constraint-related errors can occur because any System.Data.ForeignKeyConstraint objects associated with a System.Data.DataTable are activated to allow deletions and edits to occur freely. Prior to that time, System.Data.ForeignKeyConstraint objects are inactive. When the System.Data.ForeignKeyConstraint becomes activated, and errors occur, System.Data.AcceptRejectRule is called to determine the next course of action.

[C#] public const AcceptRejectRule Cascade;

[C++] public: const AcceptRejectRule Cascade;

[VB] Public Const Cascade As AcceptRejectRule

[JScript] public var Cascade: AcceptRejectRule;
Description

Changes are cascaded across the relationship.

[C#] public const AcceptRejectRule None;

[C++] public: const AcceptRejectRule None;

[VB] Public Const None As AcceptRejectRule

[JScript] public var None: AcceptRejectRule;
Description

No action occurs.

Methods:

CommandBehavior enumeration (System.Data)

ToString

Description

Specifies a description of the results and the affect on the database of the query command.

The System.Data.CommandBehavior values are used by the System.Data.IDbCommand.ExecuteReader method of System.Data.IDbCommand and any classes derived from it.

ToString

[C#] public const CommandBehavior CloseConnection;

[C++] public: const CommandBehavior CloseConnection;

[VB] Public Const CloseConnection As CommandBehavior

[JScript] public var CloseConnection: CommandBehavior;
Description

When the command is executed, the associated Connection object is closed when the associated DataReader object is closed.

ToString

[C#] public const CommandBehavior Default;

[C++] public: const CommandBehavior Default;

[VB] Public Const Default As CommandBehavior

[JScript] public var Default: CommandBehavior;

ToString

[C#] public const CommandBehavior KeyInfo;

[C++] public: const CommandBehavior KeyInfo;

[VB] Public Const KeyInfo As CommandBehavior

[JScript] public var KeyInfo: CommandBehavior;
Description

The query returns column and primary key information. The query is executed without any locking on the selected rows. When using System.Data.CommandBehavior.KeyInfo, the SQL Server .NET Data Provider appends a FOR BROWSE clause to the statement being executed. The user should be aware of potential side effects, such as interference with the use of SET FMTONLY ON statements. See SQL Server Books Online for more information.

ToString

[C#] public const CommandBehavior SchemaOnly;

[C++] public: const CommandBehavior SchemaOnly;

[VB] Public Const SchemaOnly As CommandBehavior

[JScript] public var SchemaOnly: CommandBehavior;
Description

The query returns column information only and does not affect the database state.

ToString

[C#] public const CommandBehavior SequentialAccess;

[C++] public: const CommandBehavior SequentialAccess;

[VB] Public Const SequentialAccess As CommandBehavior

[JScript] public var SequentialAccess: CommandBehavior;
Description

The results of the query are read sequentially to the column level. This allows an application to read large binary values using the GetChars or GetBytes methods of a .NET data provider. Execution of the query may affect the database state.

ToString

[C#] public const CommandBehavior SingleResult;

[C++] public: const CommandBehavior SingleResult;

[VB] Public Const SingleResult As CommandBehavior

[JScript] public var SingleResult: CommandBehavior;
Description

The query returns a single result. Execution of the query may affect the database state.

ToString

[C#] public const CommandBehavior SingleRow;

[C++] public: const CommandBehavior SingleRow;

[VB] Public Const SingleRow As CommandBehavior

[JScript] public var SingleRow: CommandBehavior;
Description

The query is expected to return a single row. Execution of the query may affect the database state. Some .NET data providers may, but are not required to, use this information to optimize the performance of the command. When you specify System.Data.CommandBehavior.SingleRow with the System.Data.OleDb.OleDbCommand.ExecuteReader method of the System.Data.OleDb.OleDbCommand object, the OLE DB .NET Data Provider performs binding using the OLE DB IRow interface if it is available. Otherwise, it uses the IRowset interface. If your SQL statement is expected to return only a single row, specifying System.Data.CommandBehavior.SingleRow can also improve application performance.

CommandType enumeration (System.Data)

ToString

Description

Specifies how a command string is interpreted.

When the System.Data.IDbCommand.CommandType property is set to StoredProcedure, set the System.Data.IDbCommand.CommandText property to the name of the stored procedure. The command executes this stored procedure when you call System.Data.IDbCommand.ExecuteReader.

ToString

[C#] public const CommandType StoredProcedure;

[C++] public: const CommandType StoredProcedure;

[VB] Public Const StoredProcedure As CommandType

[JScript] public var StoredProcedure: CommandType;
Description

The name of a stored procedure.

ToString

[C#] public const CommandType TableDirect;

[C++] public: const CommandType TableDirect;

[VB] Public Const TableDirect As CommandType

[JScript] public var TableDirect: CommandType;
Description

A table name whose columns are all returned (OLE DB .NET Data Provider only).

ToString

[C#] public const CommandType Text;

[C++] public: const CommandType Text;

[VB] Public Const Text As CommandType

[JScript] public var Text: CommandType;
Description

A SQL text command.

ConnectionState enumeration (System.Data)

ToString

Description

Returns the current state of the connection to a data source.

The System.Data.ConnectionState values are used by the System.Data.OleDb.OleDbConnection.State property of the System.Data.OleDb.OleDbConnection and System.Data.SqlClient.SqlConnection objects.

ToString

[C#] public const ConnectionState Broken;

[C++] public: const ConnectionState Broken;

[VB] Public Const Broken As ConnectionState

[JScript] public var Broken: ConnectionState;
Description

The object is broken. This can occur only after the connection has been opened. A connection in this state may be closed and then re-opened.

ToString

[C#] public const ConnectionState Closed;

[C++] public: const ConnectionState Closed;

[VB] Public Const Closed As ConnectionState

[JScript] public var Closed: ConnectionState;
Description

The object is closed.

ToString

[C#] public const ConnectionState Connecting;

[C++] public: const ConnectionState Connecting;

[VB] Public Const Connecting As ConnectionState

[JScript] public var Connecting: ConnectionState;
Description

The object is connecting.

ToString

[C#] public const ConnectionState Executing;

[C++] public: const ConnectionState Executing;

[VB] Public Const Executing As ConnectionState

[JScript] public var Executing: ConnectionState;
Description

The object is executing a command.

ToString

[C#] public const ConnectionState Fetching;

[C++] public: const ConnectionState Fetching;

[VB] Public Const Fetching As ConnectionState

[JScript] public var Fetching: ConnectionState;
Description

Data is being retrieved.

ToString

[C#] public const ConnectionState Open;

[C++] public: const ConnectionState Open;

[VB] Public Const Open As ConnectionState

[JScript] public var Open: ConnectionState;
Description

The object is open.

Constraint class (System.Data)

ToString

Description

Represents a constraint that can be enforced on one or more System.Data.DataColumn objects.

A constraint is a rule used to maintain the integrity of the data in the System.Data.DataTable. For example, when you delete a value that is used in one or more related tables, a System.Data.ForeignKeyConstraint determines whether the values in the related tables are also deleted, set to null values, set to default values, or whether no action occurs. A System.Data.UniqueConstraint, on the other hand, simply ensures that all values within a particular table are unique. For more information, see.

Sets the constraint's System.Data.DataSet. The System.Data.DataSet to which this constraint will belong.

ToString

[C#] public override string ToString( );

[C++] public: String* ToString( );

[VB] Overrides Public Function ToString( ) As String

[JScript] public override function ToString( ): String;
Description

Gets the System.Data.Constraint.ConstraintName, if there its one, as a string.

Return Value: The string value of the System.Data.Constraint.ConstraintName

ConstraintCollection class (System.Data)

ToString

Description

Represents a collection of constraints for a System.Data.DataTable.

The System.Data.ConstraintCollection is accessed through the System.Data.DataTable.Constraints property.

Count

IsReadOnly

IsSynchronized

Item

ToString

Description

Gets the System.Data.Constraint from the collection with the specified name.

The System.Data.ConstraintCollection.Contains(System.Stiring) method can be used to test for the existence of a specific constraint. The System.Data.Constraint.ConstraintName of the constraint to return.

Constructs a new System.Data.UniqueConstraint, using the specified System.Data.DataColumn, and adds it to the collection.

The System.Data.ConstraintCollection.CollectionChanged event occurs if the constraint is added successfully. The name of the System.Data.UniqueConstraint. The System.Data.DataColumn affected by the constraint. Indicates whether the column is a primary key column.

Constructs a new System.Data.ForeignKeyConstraint, with the specified parent and child columns, and adds the constraint to the collection.

A System.Data.ForeignKeyConstraint and System.Data.UniqueConstraint are both created and added automatically when a System.Data.DataRelation is added to a System.Data.DataSet object's System.Data.DataRelationCollection. The System.Data.ForeignKeyConstraint (which gets the same name as the System.Data.DataRelation) is added to the child table's System.Data.ConstraintCollection, and the System.Data.UniqueConstraint is added to the parent table's System.Data.ConstraintCollection. The name of the System.Data.UniqueConstraint. The primary key System.Data.DataColumn. The foreign key System.Data.DataColumn.

Constructs a new System.Data.UniqueConstraint using the specified array of System.Data.DataColumn objects, and adds it to the collection.

The System.Data.ConstraintCollection.CollectionChanged event occurs if the constraint is added succesfully. The name of the System.Data.UniqueConstraint. An array of System.Data.DataColumn objects that are affected by the constraint. Indicates whether the columns are primary key columns.

Constructs a new System.Data.ForeignKeyConstraint, with the specified parent columns and child columns, and adds the constraint to the collection.

A System.Data.ForeignKeyConstraint and a System.Data.UniqueConstraint are created automatically when you add a System.Data.DataRelation to a System.Data.DataSet. In that case, adding a second System.Data.ForeignKeyConstraint on the same columns will result in an exception. To avoid this, use the System.Data.ForeignKeyConstraint constructor to create the System.Data.ForeignKeyConstraint and test it against existing collection members with the System.Data.ForeignKeyConstraint.Equals(System.Object) method. The name of the System.Data.UniqueConstraint. An array of System.Data.DataColumn objects that are the primary key columns. An array of System.Data.DataColumn objects that are the foreign key columns.

Return Value: Generates an exception if the System.Data.Constraint can't be removed from collection. Otherwise, true if the System.Data.Constraint can be removed.

When a System.Data.DataRelation is added to a System.Data.DataSet, a System.Data.ForeignKeyConstraint and System.Data.UniqueConstraint are added automatically to the parent table and the child table. The System.Data.UniqueConstraint is applied to the parent table's primary key column, and the System.Data.ForeignKeyConstraint is applied to the child table's foreign key column. In that case, attempting to remove the System.Data.UniqueConstraint will cause an exception to be thrown because the System.Data.ForeignKeyConstraint must be removed first. To avoid this, use the System.Data.ConstraintCollection.CanRemove(System.Data.Constraint) to determine if a System.Data.UniqueConstraint can be removed. The System.Data.Constraint to be tested for removal from the collection.

Clear

[C#] public void Clear( );

[C++] public: void Clear( );

[VB] Public Sub Clear( )

[JScript] public function Clear( );
Description

Clears the collection of any System.Data.Constraint objects.

The System.Data.ConstraintCollection.CollectionChanged occurs if this action is succesful.

Use the System.Data.ConstraintCollection.Contains(System.String) method to determine if the specified System.Data.Constraint exists before attempting to remove it from the collection. You can also use the System.Data.ConstraintCollection.CanRemove(System.Data.Constraint) method to determine if a System.Data.Constraint can be removed. The System.Data.Constraint.ConstraintName of the constraint.

IndexOf

[C#] public int IndexOf(Constraint constraint);

[C++] public: int IndexOf(Constraint* constraint);

[VB] Public Function IndexOf(ByVal constraint As Constraint) As Integer

Return Value: The index of the System.Data.Constraint if it is in the collection; otherwise, −1.

Use the System.Data.ConstraintCollection.IndexOf(System.Data.Constraint) method to return an index to be used with either the System.Data.ConstraintCollection.Contains(System.String) or System.Data.ConstraintCollection.Remove(System.Data.Constraint) method. The System.Data.Constraint to search for.

IndexOf

[C#] public virtual int IndexOf(string constraintName);

[C++] public: virtual int IndexOf(String* constraintName);

[VB] Overridable Public Function IndexOf(ByVal constraintName As String) As Integer

Return Value: The index of the System.Data.Constraint if it is in the collection; otherwise, −1.

Use the System.Data.ConstraintCollection.IndexOf(System.Data.Constraint) method to return an index to be used with either the System.Data.ConstraintCollection.Contains(System.String) or System.Data.ConstraintCollection.Remove(System.Data.Constraint) method. The name of the System.Data.Constraint.

Raising an event invokes the event handler through a delegate. For more information, see. A System.ComponentModel.CollectionChangeEventArgs that contains the event data.

Remove

[C#] public void Remove(Constraint constraint);

[C++] public: void Remove(Constraint* constraint);

[VB] Public Sub Remove(ByVal constraint As Constraint)

[JScript] public function Remove(constraint: Constraint); Removes a System.Data.Constraint from the System.Data.ConstraintCollection.
Description

Removes the specified System.Data.Constraint from the collection.

Use the System.Data.ConstraintCollection.Contains(System.String) method to determine if the collection contains the target System.Data.Constraint. The System.Data.Constraint to remove.

Remove

[C#] public void Remove(string name);

[C++] public: void Remove(String* name);

[VB] Public Sub Remove(ByVal name As String)

[JScript] public function Remove(name: String);
Description

Removes the constraint, specified by name, from the collection. Use the System.Data.ConstraintCollection.Contains(System.String) method to determine if the collection contains the target System.Data.Constraint. The name of the System.Data.Constraint to remove.

RemoveAt

[C#] public void RemoveAt(int index);

[C++] public: void RemoveAt(int index);

[VB] Public Sub RemoveAt(ByVal index As Integer)

[JScript] public function RemoveAt(index: int);
Description

Removes the constraint at the specified index from the collection.

The System.Data.ConstraintCollection.IndexOf(System.Data.Constraint) method returns the index of a given System.Data.Constraint. The index of the System.Data.Constraint to remove.

ConstraintException class (System.Data)

ToString

Description

Represents the exception that is thrown when attempting an action that violates a constraint.

ConstraintException

Example Syntax:

ToString

[C#] public ConstraintException( );

[C++] public: ConstraintException( );

[VB] Public Sub New( )

[JScript] public function ConstraintException( ); Initializes a new instance of the System.Data.ConstraintException class.
Description

Initializes a new instance of the System.Data.ConstraintException class.

ConstraintException

Example Syntax:

ToString

[C#] public ConstraintException(string s);

[C++] public: ConstraintException(String* s);

[VB] Public Sub New(ByVal s As String)

[JScript] public function ConstraintException(s: String);
Description

Initializes a new instance of the System.Data.ConstraintException class with the specified string. The string to display when the exception is thrown.

[JScript] public function ConstraintException(info: SerializationInfo, context: StreamingContext); Initializes a new instance of the System.Data.ConstraintException class.
Description

Initializes a new instance of the System.Data.ConstraintException class. The data necessary to serialize or deserialize an object. Description of the source and destination of the specified serialized stream.

HelpLink

HResult

InnerException

Message

Source

StackTrace

TargetSite

DataColumn class (System.Data)

ToString

Description

Represents the schema of a column in a System.Data.DataTable.

The System.Data.DataColumn is the fundamental building block for creating the schema of a System.Data.DataTable. You build the schema by adding one or more System.Data.DataColumn objects to the System.Data.DataColumnCollection. For more information, see.

DataColumn

Example Syntax:

ToString

[C#] public DataColumn( );

[C++] public: DataColumn( );

[VB] Public Sub New( )

[JScript] public function DataColumn( ); Initializes a new instance of the System.Data.DataColumn class.
Description

Initializes a new instance of a System.Data.DataColumn class.

When created, a new System.Data.DataColumn object has no default System.Data.DataColumn.ColumnName or System.Data.DataColumn.Caption. When added to a System.Data.DataColumnCollection, however, a default name (“Column1”, “Column2”, etc.) is given to the column.

DataColumn

Example Syntax:

ToString

[C#] public DataColumn(string columnName);

[C++] public: DataColumn(String* columnName);

[VB] Public Sub New(ByVal columnName As String)

[JScript] public function DataColumn(columnName: String);
Description

Inititalizes a new instance of the System.Data.DataColumn class using the specified column name.

By default, the name given to a column becomes the System.Data.DataColumn.Caption property value. A string that represents the name of the column to be created. If set to null or an empty string (″″), a default name will be given when added to the columns collection.

Inititalizes a new instance of the System.Data.DataColumn class using the specified column name and data type. A string that represents the name of the column to be created. If set to null or an empty string (″″), a default name will be given when added to the columns collection. A supported System.Data.DataColumn.DataType.

Initializes a new instance of the System.Data.DataColumn class using the specified name, data type, and expression. A string that represents the name of the column to be created. If set to null or an empty string (″″), a default name will be given when added to the columns collection. A supported System.Data.DataColumn.DataType. The expression used to create this column. For more details, see the System.Data.DataColumn.Expression property.

Initializes a new instance of the System.Data.DataColumn class using the specified name, data type, expression, and value that determines whether the column is an attribute.

The type argument sets the System.Data.DataColumn.ColumnMapping property. The property specifies how a System.Data.DataColumn is mapped when a System.Data.DataSet is transformed into an XML document. For example, if the the column is named “fName,” and the value it contains is “Bob,” and type is set to MappingType.Attribute, the XML element would be: For more details on how columns are mapped to elements or attributes, see the System.Data.DataColumn.ColumnMapping property. A string that represents the name of the column to be created. If set to null or an empty string (″″), a default name will be given when added to the columns collection. A supported System.Data.DataColumn.DataType. The expression used to create this column. For more details, see the System.Data.DataColumn.Expression property. One of the System.Data.MappingType values.

Gets or sets a value indicating whether the column automatically increments the value of the column for new rows added to the table.

If the type of this column is not Int16, Int32, or Int64 when this property is set, the System.Data.DataColumn.DataType property is coerced to Int32. An exception is generated if this is a computed column (that is, the System.Data.DataColumn.Expression property is set.) The incremented value is used only if the row's value for this column, when added to the columns collection, is equal to the default value.

The System.Data.DataColumn.ColumnMapping property determines how a System.Data.DataColumn is mapped when a System.Data.DataSet is saved as an XML document using the System.Data.DataSet.WriteXml(System.IO.Stream) method.

Gets or sets the name of the column in the System.Data.DataColumnCollection.

When a System.Data.DataColumn is created, it has no System.Data.DataColumn.ColumnName value. When the System.Data.DataColumn is added to a System.Data.DataTable object's System.Data.DataColumnCollection, however, it is given a default name (“Column1”, “Column2”, etc.).

Container

DataType

ToString

Description

Gets or sets the type of data stored in the column.

Setting the System.Data.DataColumn.DataType value is critical to ensuring the correct creation and updating of data in a DBMS.

Gets or sets the default value for the column when creating new rows. A default value is the value that is automatically assigned to the column when a System.Data.DataRow is created. By setting a default value, you can give the user an idea of what information to input. On the other hand, you can use the System.Data.DataColumn.DefaultValue property to automatically insert a value that shouldn't be touched by the user; for example, the current date and time of the row's creation.

DesignMode

Events

Expression

ToString

Description

Gets or sets the expresssion used to filter rows, calculate the values in a column, or create an aggregate column.

One use of the System.Data.DataColumn.Expression property is to create calculated columns. For example, to calculate a tax value, the unit price is multiplied by a tax rate of a given region. Since tax rates vary from region to region, it would be impossible to put a single tax rate in a column; instead, the value is calculated using the System.Data.DataColumn.Expression property, as shown in the Visual Basic code below:

DataSet1.Tables(“Products”).Columns(“tax”).Expression=“UnitPrice*0.086” A second use is to create an aggregate column. Similar to a calculated value, an aggregate performs an operation based on the entire set of rows in the System.Data.DataTable. A simple example is to count the number of rows returned in the set, which is the method you would use to count the number of transactions completed by a particular salesperson, as shown in this Visual Basic code: DataSet1.Tables(“Orders”).Columns(“OrderCount”).Expression=“Count(OrderID)” EXPRESSION SYNTAX When creating an expression, use the System.Data.DataColumn.ColumnName property to refer to columns. For example, if the System.Data.DataColumn.ColumnName for one column is “UnitPrice”, and another “Quantity”, the expression would be: “UnitPrice*Quantity” When creating an expression for a filter, enclose strings with single quotes: “LastName=‘Jones’” The following characters are special characters and must be escaped, as explained below, if they are to be used in a column name: \n (newline)\t (tab)\r (carriage return)˜ ( ) # \ /= > < + − * % & | ^ ′ ″ [ ] If a column name contains one of the above characters, the name must be wrapped in brackets. For example to use a column named “Column#” in an expression, you would write “[Column#]”: Total*[Column#] Because brackets are special characters, you must use a slash (“\”) to escape the bracket, if it is part of a column name. For example, a column named “Column[ ]” would be written: Total*[Column[\]] (Only the second bracket must be escaped.) USER-DEFINED VALUES User-defined values may be used within expressions to be compared against column values. String values should be enclosed within single quotes. Date values should be enclosed within pound signs (#). Decimals and scientific notation are permissible for numeric values. For example: “FirstName=‘John’” “Price <=50.00” “Birthdate <#Jan. 31, 1982#” For columns that contain enumeration values, cast the value to an integer data type. For example: “EnumColumn=5” OPERATORS Concatenation is allowed using Boolean AND, OR, and NOT operators. You can use parentheses to group clauses and force precedence. The AND operator has precedence over other operators. For example: (LastName=‘Smith’ OR LastName=‘Jones’) AND FirstName=‘John’ When creating comparison expressions, the following operators are allowed: < ><=>=< >=IN LIKE The following arithmetic operators are also supported in expressions: + (addition) − (subtraction) * (multiplication) / (division) % (modulus) STRING OPERATORS To concatenate a string, use the + character. Whether string comparisons are casesensitive or not is determined by the value of the System.Data.DataSet class's System.Data.DataSet.CaseSensitive property. However, you can override that value with the System.Data.DataTable class's System.Data.DataTable.CaseSensitive property.

The System.Data.DataColumn.Namespace property is used when reading and writing an XML document into a System.Data.DataTable in the System.Data.DataSet using the System.Data.DataSet.ReadXml(System.Xml.XmlReader), System.Data.DataSet.WriteXml(System.IO.Stream), System.Data.DataSet.ReadXmlSchema(System.Xml.XmlReader), or System.Data.DataSet.WriteXmlSchema(System.IO.Stream) methods.

Ordinal

ToString

[C#] public int Ordinal {get;}

[C++] public: _property int get_Ordinal( );

[VB] Public ReadOnly Property Ordinal As Integer

[JScript] public function get Ordinal( ): int;
Description

Gets the position of the column in the System.Data.DataColumnCollection collection.

Gets or sets an XML prefix that aliases the namespace of the System.Data.DataTable.

The System.Data.DataTable.Prefix is used throughout an XML document to identify elements which belong to the System.Data.DataSet object's namespace (as set by the System.Data.DataSet.Namespace property).

Represents the method that will handle the the System.Data.DataTable.ColumnChanging event. The source of the event. A System.Data.DataColumnChangeEventArgs that contains the event data.

When you create a System.Data.DataColumnChangeEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, until you remove the delegate. For more information about delegates, see Represents the method that will handle the the System.Data.DataTable.ColumnChanging event.

DataColumnCollection class (System.Data)

ToString

Description

Represents a collection of System.Data.DataColumn objects for a System.Data.DataTable.

The System.Data.DataColumnCollection defines the schema of a System.Data.DataTable, and determines what kind of data each System.Data.DataColumn can contain. You can access the System.Data.DataColumnCollection through the System.Data.DataTable.Columns property of the System.Data.DataTable object.

Count

IsReadOnly

IsSynchronized

Item

ToString

System.Data.DataColumn

Description

Gets the System.Data.DataColumn from the collection at the specified index.

The System.Data.DataColumnCollection.Contains(System.String) method can be used to test for the existence of a column, which is useful before attempting to use System.Data.DataColumnCollection.Item(System.Int32). The zero-based index of the column to return.

Item

ToString

[C#] public virtual DataColumn this[string name] {get;}

[C++] public: _property virtual DataColumn* get_Item(String* name);

[VB] Overridable Public Default ReadOnly Property Item(ByVal name As String) As DataColumn

Gets the System.Data.DataColumn from the collection with the specified name.

System.Data.DataColumnCollection.Item(System.Int32) is not case-sensitive when searching for column names. The System.Data.DataColumn.ColumnName of the column to return.

List

ToString

[C#] protected override ArrayList List {get;}

[C++] protected: _property virtual ArrayList* get_List( );

[VB] Overrides Protected ReadOnly Property List As ArrayList

[JScript] protected function get List( ): ArrayList;
Description

Gets the list of the collection items.

SyncRoot

ToString

Description

Occurs when the columns collection changes, either by adding or removing a column.

The System.Data.DataColumnCollection.Contains(System.String) and System.Data.DataColumnCollection.CanRemove(System.Data.DataColumn) methods can be used to determine if a column exists and can be removed.

Add

[C#] public virtual DataColumn Add( );

[C++] public: virtual DataColumn* Add( );

[VB] Overridable Public Function Add( ) As DataColumn

[JScript] public function Add( ): DataColumn;
Description

Creates and adds a System.Data.DataColumn to a System.Data.DataColumnCollection.

Return Value: The newly created System.Data.DataColumnn.

A default name (“Column1”, “Column2”, etc.) is given to the column.

Add

[C#] public void Add(DataColumn column);

[C++] public: void Add(DataColumn* column);

[VB] Public Sub Add(ByVal column As DataColumn)

[JScript] public function Add(column: DataColumn); Adds a System.Data.DataColumn to the System.Data.DataColumnCollectiion.
Description

Adds the specified System.Data.DataColumn to the System.Data.DataColumnCollection.

If the collection is successfuilly changed by adding or removing columns, the System.Data.DataColumnCollection.CollectionChanged event occurs. The System.Data.DataColumn to add.

Add

[C#] public virtual DataColumn Add(string columnName);

[C++] public: virtual DataColumn* Add(String* columnName);

[VB] Overridable Public Function Add(ByVal columnName As String) As DataColumn

Creates and adds a System.Data.DataColumn with the specified name and type to the System.Data.DataColumnCollection.

Return Value: The newly created System.Data.DataColumn.

If null or an empty string (″″) is passed in for the name, a default name (“Column1”, “Column2”, etc.) is given to the column. The System.Data.DataColumn.ColumnName to create the column with. The column's System.Data.DataColumn.DataType.

Creates and adds a System.Data.DataColumn with the specified name, type, and compute expression to the System.Data.DataColumnCollection.

Return Value: The newly created System.Data.DataColumn.

If null or an empty string (″″) is passed in for the name, a default name (“Column1”, “Column2”, etc.) is given to the column. The column name. The System.Data.DataColumn.DataType of the column. The expression to assign to the System.Data.DataColumn.Expression property.

The System.Data.DataColumnCollection.CanRemove(System.Data.DataColumn) method performs several checks before returning a true or false including the following: whether the column exists, belongs to the table, or is involved in a constraint or relation. A System.Data.DataColumn in the collection.

Clear

[C#] public void Clear( );

[C++] public: void Clear( );

[VB] Public Sub Clear( )

[JScript] public function Clear( );
Description

Clears the collection of any columns.

If the collection is succesfully changed by adding or removing columns, the System.Data.DataColumnCollection.OnCollectionChanged(System.ComponentModel.CollectionChangeEventArgs) event occurs.

Checks whether the collection contains a column with the specified name.

Return Value: true if a column exists with this name; otherwise, false.

The System.Data.DataColumnCollection.Contains(System.String) method can confirm the existence of a column before performing further operations on the column. The System.Data.DataColumn.ColumnName of the column.

IndexOf

[C#] public virtual int IndexOf(DataColumn column);

[C++] public: virtual int IndexOf(DataColumn* column);

[VB] Overridable Public Function IndexOf(ByVal column As DataColumn) As Integer

Raises the System.Data.DataColumnCollection.OnCollectionChanged(System.ComponentModel.CollectionChangeEventArgs) event. Raising an event invokes the event handler through a delegate. For an overview, see. A System.ComponentModel.CollectionChangeEventArgs that contains the event data.

Raising an event invokes the event handler through a delegate. For an overview, see. A System.ComponentModel.CollectionChangeEventArgs that contains the event data.

Remove

[C#] public void Remove(DataColumn column);

[C++] public: void Remove(DataColumn* column);

[VB] Public Sub Remove(ByVal column As DataColumn)

[JScript] public function Remove(column: DataColumn); Removes a column from the collection.
Description

Removes the specified System.Data.DataColumn from the collection.

If the collection is succesfully changed by adding or removing columns, the System.Data.DataColumnCollection.OnCollectionChanged(System.ComponentModel.CollectionChangeEventArgs) event occurs. The System.Data.DataColumn to remove.

Remove

[C#] public void Remove(string name);

[C++] public: void Remove(string* name);

[VB] Public Sub Remove(ByVal name As String)

[JScript] public function Remove(name: String);
Description

Removes the column with the specified name from the collection.

If the collection is succesfully changed by adding or removing columns, the System.Data.DataColumnCollection.OnCollectionChanged(System.ComponentModel.CollectionChangeEventArgs) event occurs. The name of the column to remove.

RemoveAt

[C#] public void RemoveAt(int index);

[C++] public: void RemoveAt(int index);

[VB] Public Sub RemoveAt(ByVal index As Integer)

[JScript] public function RemoveAt(index: int);
Description

Removes the column at the specified index from the collection.

If the collection is succesfully changed by adding or removing columns, the System.Data.DataColumnCollection.OnCollectionChanged(System.ComponentModel.CollectionChangeEventArgs) event occurs. The index of the column to remove.

DataException class (System.Data)

ToString

Description

Represents the exception that is thrown when errors are generated using ADO.NET components.

DataException

Example Syntax:

ToString

[C#] public DataException( );

[C++] public: DataException( );

[VB] Public Sub New( )

[JScript] public function DataException( );
Description

Initializes a new instance of the System.Data.DataException class.

DataException

Example Syntax:

ToString

[C#] public DataException(string s);

[C++] public: DataException(String* s);

[VB] Public Sub New(ByVal s As String)

[JScript] public function DataException(s: String);
Description

Initializes a new instance of the System.Data.DataException class with the specified string. The string to display when the exception is thrown.

[JScript] public function DataException(info: SerializationInfo, context: StreamingContext); Initializes a new instance of the System.Data.DataException class.
Description

Initializes a new instance of the System.Data.DataException class. The data necessary to serialize or deserialize an object. Description of the source and destination of the specified serialized stream.

[JScript] public function DataException(s: String, innerException: Exception); Initializes a new instance of the System.Data.DataException class.
Description

Initializes a new instance of the System.Data.DataException class with the specified string and inner exception.

You can create a new exception that catches an earlier exception. The code that handles the second exception can make use of the additional information from the earlier exception, also called an inner exception, to examine the cause of the initial error. The string to display when the exception is thrown. A reference to an inner exception.

HelpLink

HResult

InnerException

Message

Source

StackTrace

TargetSite

DataRelation class (System.Data)

ToString

Description

Represents a parent/child relationship between two System.Data.DataTable objects.

A System.Data.DataRelation is used to relate two System.Data.DataTable objects to each other through System.Data.DataColumn objects. For example, in a Customer/Orders relationship, the Customers table is the parent and the Orders table is the child of the relationship. This is similar to a primary key/foreign key relationship. For more information, see.

Initializes a new instance of the System.Data.DataRelation class using the specified System.Data.DataRelation name, and parent and child System.Data.DataColumn objects. The name of the System.Data.DataRelation If null or an empty string (″″), a default name will be given when the created object is added to the System.Data.DataRelationCollection. The parent System.Data.DataColumn in the relationship. The child System.Data.DataColumn in the relationship.

Initializes a new instance of the System.Data.DataRelation class using the specified System.Data.DataRelation name and matched arrays of parent and child System.Data.DataColumn objects. The name of the relation. If null or an empty string (″″), a default name will be given when the created object is added to the System.Data.DataRelationCollection. An array of parent System.Data.DataColumn objects. An array of child System.Data.DataColumn objects.

Initializes a new instance of the System.Data.DataRelation class using the specified name, parent and child System.Data.DataColumn objects, and a value indicating whether to create constraints. The name of the relation. If null or an empty string (″″), a default name will be given when the created object is added to the System.Data.DataRelationCollection. The parent System.Data.DataColumn in the relation. The child System.Data.DataColumn in the relation. A value indicating whether constraints are created.

Initializes a new instance of the System.Data.DataRelation class using the specified name, matched arrays of parent and child System.Data.DataColumn objects, and value indicating whether to create constraints. The name of the relation. If null or an empty string (″″), a default name will be given when the created object is added to the System.Data.DataRelationCollection. An array of parent System.Data.DataColumn objects. An array of child System.Data.DataColumn objects. A value indicating whether to create constraints.

Initializes a new instance of the System.Data.DataRelation class using the specified System.Data.DataRelation name, parent and child System.Data.DataTable names, a matching array of parent and child System.Data.DataColumn objects, and a value indicating whether relationships are nested. The name of the relation. If null or an empty string (″″), a default name will be given when the created object is added to the System.Data.DataRelationCollection. The name of the System.Data.DataTable that is the parent table of the relation. The name of the System.Data.DataTable that is the child table of the relation. An array of System.Data.DataColumn object names in the parent System.Data.DataTable of the relation. An array of System.Data.DataColumn object namess in the child System.Data.DataTable of the relation. A value indicating whether relationships are nested.

Gets or sets the name used to retrieve a System.Data.DataRelation from the System.Data.DataRelationCollection. Use the System.Data.DataRelation.RelationName property to retrieve a System.Data.DataRelation from the System.Data.DataRelationCollection.

CheckStateForProperty

[C#] protected void CheckStateForProperty( );

[C++] protected: void CheckStateForProperty( );

[VB] Protected Sub CheckStateForProperty( )

[JScript] protected function CheckStateForProperty( );
Description

Ensures that the System.Data.DataRelation is a valid object.

System.Data.DataRelation.CheckStateForProperty verifies the validity of a System.Data.DataRelation object, even if it does not belong to a System.Data.DataSet.

Creates a relation given the parameters and adds it to the collection. The name is defaulted. An ArgumentException is generated if this relation already belongs to this collection or belongs to another collection. An InvalidConstraintException is generated if the relation can't be created based on the parameters. The CollectionChanged event is fired if it succeeds.

Return Value: The created relation. parent column of relation. child column of relation.

Creates a relation given the parameters and adds it to the collection. The name is defaulted. An ArgumentException is generated if this relation already belongs to this collection or belongs to another collection. An InvalidConstraintException is generated if the relation can't be created based on the parameters. The CollectionChanged event is fired if it succeeds.

Return Value: The created relation. parent columns of relation. child columns of relation.

Creates a relation given the parameters and adds it to the collection. An ArgumentException is generated if this relation already belongs to this collection or belongs to another collection. A DuplicateNameException is generated if this collection already has a relation with the same name (case insensitive). An InvalidConstraintException is generated if the relation can't be created based on the parameters. The CollectionChanged event is fired if it succeeds.

Return Value: The created relation. The name of the relation. parent column of relation. child column of relation.

Creates a System.Data.DataRelation with the specified name, and arrays of parent and child columns, and adds it to the collection.

Return Value: The created DataRelation.

If the relation is successfully added to the collection, the System.Data.DataRelationCollection.CollectionChanged event fires. The name of the DataRelation to create. An array of parent System.Data.DataColumn objects. An array of child DataColumn objects.

Creates a relation given the parameters and adds it to the collection. An ArgumentException is generated if this relation already belongs to this collection or belongs to another collection. A DuplicateNameException is generated if this collection already has a relation with the same name (case insensitive). An InvalidConstraintException is generated if the relation can't be created based on the parameters. The CollectionChanged event is fired if it succeeds.

Return Value: The created relation. The name of the relation. parent column of relation. child column of relation. whether to create a constraints

Creates a System.Data.DataRelation with the specified name, arrays of parent and child columns, and value specifying whether to create a constraint, and adds it to the collection.

Return Value: The created relation. The name of the DataRelation to create. An array of parent System.Data.DataColumn objects. An array of child DataColumn objects. true to create a constraint; otherwise false.

Performs verification on the table. An ArgumentNullException is generated if this relation is null. An ArgumentException is generated if this relation already belongs to this collection, belongs to another collection. A DuplicateNameException is generated if this collection already has a relation with the same name (case insensitive). The relation to check.

Raising an event invokes the event handler through a delegate. For an overview, see. A System.ComponentModel.CollectionChangeEventArgs that contains the event data.

Remove

[C#] public void Remove(DataRelation relation);

[C++] public: void Remove(DataRelation* relation);

[VB] Public Sub Remove(ByVal relation As DataRelation)

[JScript] public function Remove(relation: DataRelation); Removes the specified relation from the collection.
Description

Removes the specified relation from the collection. An ArgumentNullException is generated if this relation is null. An ArgumentException is generated if this relation doesn't belong to this collection. The CollectionChanged event is fired if it succeeds. The relation to remove.

Remove

[C#] public void Remove(string name);

[C++] public: void Remove(String* name);

[VB] Public Sub Remove(ByVal name As String)

[JScript] public function Remove(name: String);
Description

Removes the relation with the specified name from the collection. An IndexOutOfRangeException is generated if this collection doesn't have a relation with that name The CollectionChanged event is fired if it succeeds. The name of the relation to remove.

RemoveAt

[C#] public void RemoveAt(int index);

[C++] public: void RemoveAt(int index);

[VB] Public Sub RemoveAt(ByVal index As Integer)

[JScript] public function RemoveAt(index: int);
Description

Removes the relation at the specified index from the collection. An IndexOutOfRangeException is generated if this collection doesn't have a relation at this index. The CollectionChanged event is fired if it succeeds. The index at which to remove a relation.

Does verification on the relation. An ArgumentNullException is generated if this relation is null. An ArgumentException is generated if this relation doesn't belong to this collection. The relation to check.

DataRow class (System.Data)

ToString

Description

Represents a row of data in a System.Data.DataTable.

The System.Data.DataRow and System.Data.DataColumn objects are primary components of a System.Data.DataTable. Use the System.Data.DataRow object and its properties and methods to retrieve and evaluate; and insert, delete, and update the values in the System.Data.DataTable. The System.Data.DataRowCollection represents the actual System.Data.DataRow objects in the System.Data.DataTable, and the System.Data.DataColumnCollection contains the System.Data.DataColumn objects that describe the schema of the System.Data.DataTable. Use the overloaded System.Data.DataRow.Item(System.Int32) property to return or sets the value of a System.Data.DataColumn.

Gets a value indicating whether there are errors in a columns collection.

When validating data, you can set an error on any column in a row. Such a column, when displayed in the System.Windows.Forms.DataGrid control, is marked with a red exclamation point to signal the user that the column is in error.

The version shouldn't be confused with the System.Data.DataRow.RowState property. The version argument describes the state of the data contained by the column in relation to the column's original value. The System.Data.DataRow.RowState property describes the state of the entire row in relation to its parent System.Data.DataTable The name of the column. One of the System.Data.DataRowVersion values that specifies the desired row version. Possible values are Default, Original, Current, and Proposed.

Gets the specified version of data stored in the specified System.Data.DataColumn.

The version shouldn't be confused with the System.Data.DataRow.RowState property. The version argument describes the state of the data contained by the column in relation to the column's original value. A System.Data.DataColumn that contains information about the column. One of the System.Data.DataRowVersion values that specifies the desired row version. Possible values are Default, Original, Current, and Proposed.

Gets the data stored in the column, specified by index and version of the data to retrieve.

You can only create or update a row after calling the System.Data.DataRow.BeginEdit method; similarly, the System.Data.DataRow.EndEdit method must be called to commit the edit. After calling the System.Data.DataRow.EndEdit method, and before calling the System.Data.DataRow.AcceptChanges method, internal representations of the original and new proposed values are stored. Therefore, until you call the System.Data.DataRow.AcceptChanges, you can use the version argument to specify which version of a column's value you need, either the DataRowVersion.Original or DataRowVersion.Proposed. Once you call the System.Data.DataRow.AcceptChanges method, however, the version of the column reverts to DataRowVersion.Original. If the row is new, you can also pass DataRowVersion.Default for the parameter to retrieve the column's default value. When passing DataRowVersion.Current, the property will return the current value, whatever its version may be. The zero-based index of the column. One of the System.Data.DataRowVersion values that specifies the desired row version. Possible values are Default, Original, Current, and Proposed.

If a System.Data.DataColumn has its System.Data.DataColumn.DefaultValue property set, pass a null in the array to set the default value for that column. Similarly, if a column has its System.Data.DataColumn.AutoIncrement property set to true, pass the null in the array to set the automatically generated value for the row.

Uses the System.Data.DataRow.HasErrors property to first determine if a System.Data.DataRow contains errors.

RowState

ToString

[C#] public DataRowState RowState {get;}

[C++] public: _property DataRowState get_RowState( );

[VB] Public ReadOnly Property RowState As DataRowState

[JScript] public function get RowState( ): DataRowState;
Description

Gets the current state of the row in regards to its relationship to the System.Data.DataRowCollection.

The System.Data.DataRow.RowState property is used in conjunction with the System.Data.DataSet.GetChanges and System.Data.DataSet.HasChanges methods of the System.Data.DataSet.

Table

ToString

[C#] public DataTable Table {get;}

[C++] public: _property DataTable* get_Table( );

[VB] Public ReadOnly Property Table As DataTable

[JScript] public function get Table( ): DataTable;
Description

Gets the System.Data.DataTable for which this row has a schema.

A System.Data.DataRow does not necessarily belong to any table's collection of rows. This occurs when the System.Data.DataRow has been created but not added to the System.Data.DataRowCollection. If the System.Data.DataRow.RowState property returns DataRowState.Detached, the row is not in any collection.

AcceptChanges

[C#] public void AcceptChanges( );

[C++] public: void AcceptChanges( );

[VB] Public Sub AcceptChanges( )

[JScript] public function AcceptChanges( );
Description

Commits all the changes made to this row since the last time System.Data.DataRow.AcceptChanges was called.

When invoking System.Data.DataRow.AcceptChanges, the System.Data.DataRow.EndEdit method is implicitly called to end any edits. If the System.Data.DataRow.RowState of the row was Added or Modified, the System.Data.DataRow.RowState becomes Unchanged. If the System.Data.DataRow.RowState was Deleted, the row is removed.

BeginEdit

[C#] public void BeginEdit( );

[C++] public: void BeginEdit( );

[VB] Public Sub BeginEdit( )

[JScript] public function BeginEdit( );
Description

Begins an edit operation on a System.Data.DataRow object.

Use the System.Data.DataRow.BeginEdit method to put a System.Data.DataRow into edit mode. In this mode, events are temporarily suspended allowing the user to make multiple changes to more than one row without triggering validation rules. For example, if the values of several rows must add up to 100, you can put each of the rows into edit mode to suspend the validation of the row values until the user attempts to commit the values. While in edit mode, the The System.Data.DataRow.BeginEdit method is called implicitly when the user changes the value of a databound control; the System.Data.DataRow.EndEdit method is called implicitly when you invoke the System.Data.DataTable object's System.Data.DataTable.AcceptChanges method.) While in this edit mode, the System.Data.DataRow stores representations of the original and new proposed values Therefore, as long as the System.Data.DataRow.EndEdit method has not been called, you can retrieve either the original or proposed version by passing either DataRowVersion.Original or DataRowVersion.Proposed for the version parameter of the System.Data.DataRow.Item(System.Int32) properly. You can also cancel any edits at this time by invoking the System.Data.DataRow.CancelEdit method.

CancelEdit

[C#] public void CancelEdit( );

[C++] public: void CancelEdit( );

[VB] Public Sub CancelEdit( )

[JScript] public function CancelEdit( );
Description

Cancels the current edit on the row.

See the System.Data.DataRow.BeginEdit method for more details.

ClearErrors

[C#] public void ClearErrors( );

[C++] public: void ClearErrors( );

[VB] Public Sub ClearErrors( )

[JScript] public function ClearErrors( );
Description

Clears the errors for the row, including the System.Data.DataRow.RowError and errors set with System.Data.DataRow.SetColumnError(System.Int32,System.String).

Use System.Data.DataRow.SetColumnError(System.Int32,System.String) and System.Data.DataRow.GetColumnError(System.Int32) to set and return errors for individual columns.

Delete

[C#] public void Delete( );

[C++] public: void Delete( );

[VB] Public Sub Delete( )

[JScript] public function Delete( );
Description

Deletes the row.

If the System.Data.DataRow.RowState of the row is Added, the row will be removed from the table.

EndEdit

[C#] public void EndEdit( );

[C++] public: void EndEdit( );

[VB] Public Sub EndEdit( )

[JScript] public function EndEdit( );
Description

Ends the edit occurring on the row.

When setting the property, an exception is generated if an exception occurs in the System.Data.DataTable.RowChanging event.

GetChildRows

[C#] public DataRow[ ] GetChildRows(DataRelation relation);

[C++] public: DataRow* GetChildRows(DataRelation* relation) [ ];

[VB] Public Function GetChildRows(ByVal relation As DataRelation) As DataRow( )

Gets the child rows of this System.Data.DataRow using the specified System.Data.DataRelation.

Return Value: An array of System.Data.DataRow objects (or an array of length zero).

In a System.Data.DataSet, the collection of all System.Data.DataRelation objects for the data set is returned by the System.Data.DataSet.GetChildRelations method. The System.Data.DataRelation to use.

GetChildRows

[C#] public DataRow[ ] GetChildRows(string relationName);

[C++] public: DataRow* GetChildRows(String* relationName) [ ];

[VB] Public Function GetChildRows(ByVal relationName As String) As DataRow( )

[JScript] public function GetChildRows(relationName: String): DataRow[ ]; Gets the child rows in a related System.Data.DataTable of a System.Data.DataRow.
Description

Gets the child rows of a System.Data.DataRow using the specified System.Data.DataRelation.RelationName of a System.Data.DataRelation.

Return Value: An array of System.Data.DataRow objects (or an array of length zero).

In a System.Data.DataSet, the collection of all System.Data.DataRelation objects for the data set is returned by the System.Data.DataSet.GetChildRelations method. The System.Data.DataRelation.RelationName of the System.Data.DataRelation to use.

Gets the child rows of a System.Data.DataRow using the specified System.Data.DataRelation, and System.Data.DataRowVersion.

Return Value: An array of System.Data.DataRow objects.

In a System.Data.DataSet, the collection of all System.Data.DataRelation objects for the data set is returned by the System.Data.DataSet.GetChildRelations method. The System.Data.DataRelation to use. One of the System.Data.DataRowVersion values specifying the version of the data to get. Possible values are Default, Original, Current, and Proposed.

Gets the specified version of the child rows of a System.Data.DataRow using the specified System.Data.DataRelation.RelationName of a System.Data.DataRelation, and System.Data.DataRowVersion.

Return Value: An array of System.Data.DataRow objects (or an array of length zero).

In a System.Data.DataSet, the collection of all System.Data.DataRelation objects for the data set is returned by the System.Data.DataSet.GetChildRelations method. The System.Data.DataRelation.RelationName of the System.Data.DataRelation to use. One of the System.Data.DataRowVersion values specifying the version of the data to get. Possible values are Default, Original, Current, and Proposed.

GetColumnError

[C#] public string GetColumnError(DataColumn column);

[C++] public: String* GetColumnError(DataColumn* column);

[VB] Public Function GetColumnError(ByVal column As DataColumn) As String

Return Value: An array of System.Data.DataColumn objects that contain errors.

The System.Data.DataRow.GetColumnsInError allows you to reduce the number of System.Data.DataColumn objects that must be processed for errors by returning only those columns that have an error. Errors can be set to individual columns with the System.Data.DataRow.SetColumnError(System.Int32,System.String) method. To further reduce the number of processing, check the System.Data.DataRow class's System.Data.DataRow.HasErrors property to first determine if a System.Data.DataRow has errors before invoking System.Data.DataRow.GetColumnsInError.

GetParentRow

[C#] public DataRow GetParentRow(DataRelation relation);

[C++] public: DataRow* GetParentRow(DataRelation* relation);

[VB] Public Function GetParentRow(ByVal relation As DataRelation) As DataRow

Gets the parent row of a System.Data.DataRow using the specified System.Data.DataRelation.

Return Value: The parent System.Data.DataRow of the current row.

In a System.Data.DataSet, the collection of all parent System.Data.DataRelation objects for the data set is returned by the System.Data.DataSet.GetParentRelations(System.Data.DataTable) method. The System.Data.DataRelation to use.

GetParentRow

[C#] public DataRow GetParentRow(string relationName);

[C++] public: DataRow* GetParentRow(String* relationName);

[VB] Public Function GetParentRow(ByVal relationName As String) As DataRow

Gets the parent row of a System.Data.DataRow using the specified System.Data.DataRelation.RelationName of a System.Data.DataRelation.

Return Value: The parent System.Data.DataRow of the current row.

In a System.Data.DataSet, the collection of all parent System.Data.DataRelation objects for the data set is returned by the System.Data.DataSet.GetParentRelations(System.Data.DataTable) method. The System.Data.DataRelation.RelationName of a System.Data.DataRelation.

Gets the parent row of a System.Data.DataRow using the specified System.Data.DataRelation, and System.Data.DataRowVersion.

Return Value: The parent System.Data.DataRow of the current row.

In a System.Data.DataSet, the collection of all parent System.Data.DataRelation objects for the data set is returned by the System.Data.DataSet.GetParentRelations(System.Data.DataTable) method. The System.Data.DataRelation to use. One of the System.Data.DataRowVersion values specifying the version of the data to get.

Gets the parent row of a System.Data.DataRow using the specified System.Data.DataRelation.RelationName of a System.Data.DataRelation, and System.Data.DataRowVersion.

Return Value: The parent System.Data.DataRow of the current row.

In a System.Data.DataSet, the collection of all parent System.Data.DataRelation objects for the data set is returned by the System.Data.DataSet.GetParentRelations(System.Data.DataTable) method. The System.Data.DataRelation.RelationName of a System.Data.DataRelation. One of the System.Data.DataRowVersion values.

GetParentRows

[C#] public DataRow[ ] GetParentRows(DataRelation relation);

[C++] public: DataRow* GetParentRows(DataRelation* relation)

[VB] Public Function GetParentRows(ByVal relation As DataRelation) As DataRow( )

Gets the parent rows of a System.Data.DataRow using the specified System.Data.DataRelation.

Return Value: An array of System.Data.DataRow objects (or an array of length zero).

In a System.Data.DataSet, the collection of all parent System.Data.DataRelation objects for the data set is returned by the System.Data.DataSet.GetParentRelations(System.Data.DataTable) method. The System.Data.DataRelation to use.

GetParentRows

[C#] public DataRow[ ] GetParentRows(string relationName);

[C++] public: DataRow* GetParentRows(String* relationName) [ ];

[VB] Public Function GetParentRows(ByVal relationName As String) As DataRow( )

Gets the parent rows of a System.Data.DataRow using the specified System.Data.DataRelation.RelationName of a System.Data.DataRelation.

Return Value: An array of System.Data.DataRow objects (or an array of length zero).

In a System.Data.DataSet, the collection of all parent System.Data.DataRelation objects for the data set is returned by the System.Data.DataSet.GetParentRelations(System.Data.DataTable) method. The System.Data.DataRelation.RelationName of a System.Data.DataRelation.

Gets the parent rows of a System.Data.DataRow using the specified System.Data.DataRelation, and System.Data.DataRowVersion.

Return Value: An array of System.Data.DataRow objects (or an array of length zero).

In a System.Data.DataSet, the collection of all parent System.Data.DataRelation objects for the data set is returned by the System.Data.DataSet.GetParentRelations(System.Data.DataTable) method. The System.Data.DataRelation to use. One of the System.Data.DataRowVersion values specifying the version of the data to get.

Gets the parent rows of a System.Data.DataRow using the specified System.Data.DataRelation.RelationName of a System.Data.DataRelation, and System.Data.DataRowVersion.

Return Value: An array of System.Data.DataRow objects (or an array of length zero).

In a System.Data.DataSet, the collection of all parent System.Data.DataRelation objects for the data set is returned by the System.Data.DataSet.GetParentRelations(System.Data.DataTable) method. The System.Data.DataRelation.RelationName of a System.Data.DataRelation. One of the System.Data.DataRowVersion values specifying the version of the data to get. Possible values are Default, Original, Current, and Proposed.

HasVersion

[C#] public bool HasVersion(DataRowVersion version);

[C++] public: bool HasVersion(DataRowVersion version);

[VB] Public Function HasVersion(ByVal version As DataRowVersion) As Boolean

See the System.Data.DataRow.BeginEdit method for more details. One of the System.Data.DataRowVersion values that specifies the row version. Possible values are Default, Original, Current, and Proposed.

Return Value: true if the column contains a null value; otherwise, false. A System.Data.DataColumn. One of the System.Data.DataRowVersion values that specifies the row version. Possible values are Default, Original, Current, and Proposed.

RejectChanges

[C#] public void RejectChanges( );

[C++] public: void RejectChanges( );

[VB] Public Sub RejectChanges( )

[JScript] public function RejectChanges( );
Description

Rejects all changes made to the row since System.Data.DataRow.AcceptChanges was last called.

When calling the System.Data.DataRow.RejectChanges method, the System.Data.DataRow.CancelEdit method is implicitly called to cancel any edits. If System.Data.DataRow.RowState is Deleted or Modified, the row reverts to its previous values, and System.Data.DataRow.RowState becomes Unchanged. If the System.Data.DataRow.RowState is Added, the row is removed.

The method is used to set custom error descriptions on specified columns. You can use the System.Windows.Forms.ErrorProvider control to display the text of the error, or through by other reporting mechanisms. The zero-based index of the column. The error description.

The System.Data.DataTable.RowChanged, System.Data.DataTable.RowChanged, System.Data.DataTable.RowChanged, and System.Data.DataTable.RowChanged events occur when an action is performed on a System.Data.DataRow

Initializes a new instance of the System.Data.DataRowChangeEventArgs class. The System.Data.DataRow upon which an action is occuring. One of the System.Data.DataRowAction values.

Action

ToString

[C#] public DataRowAction Action {get;}

[C++] public: _property DataRowAction get_Action( );

[VB] Public ReadOnly Property Action As DataRowAction

[JScript] public function get Action( ): DataRowAction;
Description

Gets the action that has occurred on a System.Data.DataRow.

Row

ToString

[C#] public DataRow Row {get;}

[C++] public: _property DataRow* get_Row( );

[VB] Public ReadOnly Property Row As DataRow

[JScript] public function get Row( ): DataRow;
Description

Gets the row upon which an action has occurred.

DataRowChangeEventHandler delegate (System.Data)

ToString

Description

Represents the method that will handle the System.Data.DataTable.RowChanging, System.Data.DataTable.RowChanged, System.Data.DataTable.RowDeleting, and System.Data.DataTable.RowDeleted events of a System.Data.DataTable. The source of the event. A System.Data.DataRowChangeEventArgs that contains the event data.

When you create a System.Data.DataRowChangeEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, until you remove the delegate. For more information about delegates, see.

DataRowCollection class (System.Data)

ToString

Description

Represents a collection of rows for a System.Data.DataTable.

The System.Data.DataRowCollection is a major component of the System.Data.DataTable. While the System.Data.DataColumnCollection defines the schema of the table, the System.Data.DataRowCollection contains the actual data for the table, where each System.Data.DataRow in the System.Data.DataRowCollection represents a single row.

Count

IsReadOnly

IsSynchronized

Item

ToString

Description

Gets the row at the specified index.

Use the System.Data.DataRowCollection.Contains(System.Object) method to determine if a given value exists in the key column of a row. The zero-based index of the row to return.

List

ToString

[C#] protected override ArrayList List {get;}

[C++] protected: _property virtual ArrayList* get_List( );

[VB] Overrides Protected ReadOnly Property List As ArrayList

[JScript] protected function get List( ): ArrayList;
Description

Gets the list of the collection items.

SyncRoot

Add

[C#] public void Add(DataRow row);

[C++] public: void Add(DataRow* row);

[VB] Public Sub Add(ByVal row As DataRow)

[JScript] public function Add(row: DataRow); Adds a System.Data.DataRow to the System.Data.DataRowCollection.
Description

Adds the specified System.Data.DataRow to the System.Data.DataRowCollection object.

To create a new System.Data.DataRow, you must use the System.Data.DataTable class's System.Data.DataTable.NewRow method. When you use the System.Data.DataTable.NewRow method, a new System.Data.DataRow object is returned using the schema of parent System.Data.DataTable. After you create the System.Data.DataRow object and set the values for each of its columns, use the System.Data.DataRowCollection.Add(System.Data.DataRow) method to add the object to the collection. The System.Data.DataRow to add.

Creates a row using specified values and adds it to the System.Data.DataRowCollection.

If a System.Data.DataColumn object has its System.Data.DataColumn.AutoIncrement set to True, System.Object.Empty should be passed to get the default value for that column. The array of values that are used to create the new row.

Clear

[C#] public void Clear( );

[C++] public: void Clear( );

[VB] Public Sub Clear( )

[JScript] public function Clear( );
Description

Clears the collection of all rows.

To add a row to the collection, first use the System.Data.DataTable class's System.Data.DataTable.NewRow method to create the new row. Then add the new row using the System.Data.DataRowCollection.Add(System.Data.DataRow) method of the System.Data.DataRowCollection class.

Contains

[C#] public bool Contains(object key);

[C++] public: bool Contains(Object* key);

[VB] Public Function Contains(ByVal key As Object) As Boolean

[JScript] public function Contains(key: Object): Boolean; Gets a value indicating whether any row in the collection contains a specified value in the primary key or keys column.
Description

Gets a value indicating whether the primary key of any row in the collection contains the specified value.

To use the System.Data.DataRowCollection.Contains(System.Object) method, the System.Data.DataTable object to which the System.Data.DataRowCollection object belongs to must have at least one column designated as a primary key column. See the System.Data.DataTable.PrimaryKey property for details on creating a primary key column. The value of the primary key to test for.

Gets a value indicating if the System.Data.DataRow with the specified primary key values exists.

Return Value: true if the System.Data.DataRowCollection contains a System.Data.DataRow with the specified key values; otherwise, false.

To use the System.Data.DataRowCollection.Contains(System.Object) method with an array of values, the System.Data.DataTable object to which the System.Data.DataRowCollection object belongs must have at an array of columns designated as a primary keys. See the System.Data.DataTable.PrimaryKey property for details on creating an array of primary key columns. The number of array elements must correspond to the number of primary key columns in the System.Data.DataTable. An array of primary key values to test for.

Return Value: A System.Data.DataRow containing the primary key value specified; otherwise a null value if the primary key value does not exist in the System.Data.DataRowCollection.

To use the System.Data.DataRowCollection.Contains(System.Object) method, the System.Data.DataTable object to which the System.Data.DataRowCollection object belongs to must have at least one column designated as a primary key column. See the System.Data.DataTable.PrimaryKey property for details on creating a primary key column. The primary key value of the System.Data.DataRow to find.

Find

[C#] public DataRow Find(object[ ] keys);

[C++] public: DataRow* Find(Object* keys_gc[ ]);

[VB] Public Function Find(ByVal keys( ) As Object) As DataRow

[JScript] public function Find(keys: Object[ ]): DataRow;
Description

Gets the row containing the specified primary key values.

Return Value: An array of System.Data.DataRow objects containing the primary key values specified; otherwise a null value if the primary key values do not exist in the System.Data.DataRowCollection.

To use the System.Data.DataRowCollection.Find(System.Object) method, the System.Data.DataTable object to which the System.Data.DataRowCollection object belongs to must have at least one column designated as a primary key column. See the System.Data.DataTable.PrimaryKey property for details on creating a System.Data.DataTable.PrimaryKey column, or an array of System.Data.DataColumn objects when the table has more than one primary key. An array of primary key values to find. The type of the array is Object.

[JScript] public function Remove(row: DataRow); Removes a specific row from the System.Data.DataRowCollection.
Description

Removes the specified System.Data.DataRow from the collection.

When a row is removed, data in that row is lost. You can also call the System.Data.DataRow class's System.Data.DataRow.Delete method to simply mark a row for removal. The row is not actually removed until the System.Data.DataRow.AcceptChanges method is invoked. The System.Data.DataRow to remove.

RemoveAt

[C#] public void RemoveAt(int index);

[C++] public: void RemoveAt(int index);

[VB] Public Sub RemoveAt(ByVal index As Integer)

[JScript] public function RemoveAt(index: int);
Description

Removes the row with the specified index from the collection.

When a row is removed, data in that row is lost. You can also call the System.Data.DataRow class's System.Data.DataRow.Delete method to simply mark a row for removal. The row is not actually removed until the System.Data.DataRow.AcceptChanges method is invoked. The index of the row to remove.

DataRowState enumeration (System.Data)

ToString

Description

Gets the state of a System.Data.DataRow object.

The System.Data.DataRowState enumeration is returned by the System.Data.DataRow.RowState property of the System.Data.DataRow class.

ToString

[C#] public const DataRowState Added;

[C++] public: const DataRowState Added;

[VB] Public Const Added As DataRowState

[JScript] public var Added: DataRowState;
Description

The row has been added to a System.Data.DataRowCollection, and System.Data.DataRow.AcceptChanges has not been called.

ToString

[C#] public const DataRowState Deleted;

[C++] public: const DataRowState Deleted;

[VB] Public Const Deleted As DataRowState

[JScript] public var Deleted: DataRowState;
Description

The row was deleted using the System.Data.DataRow.Delete method of the System.Data.DataRow.

ToString

[C#] public const DataRowState Detached;

[C++] public: const DataRowState Detached;

[VB] Public Const Detached As DataRowState

[JScript] public var Detached: DataRowState;
Description

The row has been created but is not part of any System.Data.DataRowCollection. A System.Data.DataRow is in this state immediately after it has been created and before it is added to a collection, or if it has been removed from a collection.

ToString

[C#] public const DataRowState Modified;

[C++] public: const DataRowState Modified;

[VB] Public Const Modified As DataRowState

[JScript] public var Modified: DataRowState;
Description

The row has been modified and System.Data.DataRow.AcceptChanges has not been called.

ToString

[C#] public const DataRowState Unchanged;

[C++] public: const DataRowState Unchanged;

[VB] Public Const Unchanged As DataRowState

[JScript] public var Unchanged: DataRowState;
Description

The row has not changed since System.Data.DataRow.AcceptChanges was last called.

DataRowVersion enumeration (System.Data)

ToString

Description

Describes the version of a System.Data.DataRow.

The System.Data.DataRowVersion values are used when retrieving the value found in a System.Data.DataRow using System.Data.DataRow.Item(System.Int32) or the System.Data.DataRow.GetChildRows(System.String) of the System.Data.DataRow object.

ToString

[C#] public const DataRowVersion Current;

[C++] public: const DataRowVersion Current;

[VB] Public Const Current As DataRowVersion

[JScript] public var Current: DataRowVersion;
Description

The row contains current values.

ToString

[C#] public const DataRowVersion Default;

[C++] public: const DataRowVersion Default;

[VB] Public Const Default As DataRowVersion

[JScript] public var Default: DataRowVersion;
Description

The row contains its default values.

ToString

[C#] public const DataRowVersion Original;

[C++] public: const DataRowVersion Original;

[VB] Public Const Original As DataRowVersion

[JScript] public var Original: DataRowVersion;
Description

The row contains its original values.

ToString

[C#] public const DataRowVersion Proposed;

[C++] public: const DataRowVersion Proposed;

[VB] Public Const Proposed As DataRowVersion

[JScript] public var Proposed: DataRowVersion;
Description

The row contains a proposed value.

DataRowView class (System.Data)

ToString

Description

Represents a customized view of a System.Data.DataRow exposed as a fully featured Windows Forms control.

Whenever data is displayed (for example in a System.Windows.Forms.DataGrid control), only one version of each row can be displayed. The displayed row is a System.Data.DataRowView.

The System.Data.DataRowView.BeginEdit method is identical to the System.Data.DataRow.BeginEdit method of the System.Data.DataRow. After calling System.Data.DataRowView.BeginEdit, any changes made to the System.Data.DataRowView can be rolled back by calling System.Data.DataRow.CancelEdit. Call the System.Data.DataRowView.BeginEdit method before allowing users to change row values. After values have been changed, you retrieve the new values by setting the System.Data.DataRowView.RowVersion to DataRowVersion.Proposed. Check the values with a business rule, and roll back the changes if needed by calling System.Data.DataRowView.CancelEdit, or call System.Data.DataRowView.EndEdit to accept the changes.

CancelEdit

[C#] public void CancelEdit( );

[C++] public: _sealed void CancelEdit( );

[VB] NotOverridable Public Sub CancelEdit( )

[JScript] public function CancelEdit( );
Description

Cancels an edit procedure.

After calling System.Data.DataRowView.CancelEdit, all changes to the row are rolled back. You can also roll back changes by calling System.Data.DataTable.RejectChanges on the parent System.Data.DataTable.

CreateChildView

[C#] public DataView CreateChildView(DataRelation relation);

[C++] public: DataView* CreateChildView(DataRelation* relation);

[VB] Public Function CreateChildView(ByVal relation As DataRelation) As DataView

The System.Data.DataSet, which is an in-memory cache of data retrieved from a database, is a major component of the ADO.NET architecture. The System.Data.DataSet consists of a collection of System.Data.DataTable objects that you can relate to each other with System.Data.DataRelation objects. You can also enforce data integrity in the System.Data.DataSet by using the System.Data.UniqueConstraint and System.Data.ForeignKeyConstraint objects. For further details about working with System.Data.DataSet objects, see

DataSet

Example Syntax:

ToString

[C#] public DataSet( );

[C++] public: DataSet( );

[VB] Public Sub New( )

[JScript] public function DataSet( ); Initializes a new instance of the System.Data.DataSet class.
Description

Initializes a new instance of the System.Data.DataSet class.

This implementation of the System.Data.DataSet constructor takes no parameters, and creates a default name, “NewDataSet”, for the new instance.

DataSet

Example Syntax:

ToString

[C#] public DataSet(string dataSetName);

[C++] public: DataSet(String* dataSetName);

[VB] Public Sub New(ByVal dataSetName As String)

[JScript] public function DataSet(dataSetName: String);
Description

Initializes a new instance of a System.Data.DataSet class with the given name.

A name for the System.Data.DataSet is required to ensure that the XML representation of the System.Data.DataSet always has a name for the document element, which is the highest level element in a schema definition. The name of the System.Data.DataSet.

Initializes a new instance of the System.Data.DataSet class with the System.Runtime.Serialization.SerializationInfo and the System.Runtime.Serialization.StreamingContext.

This implemenation of the System.Data.DataSet constructor is required for System.Runtime.Serialization.ISerializable. The data needed to serialize or deserialize an object. The source and destination of a given serialized stream.

The System.Data.DataSet.CaseSensitive property affects how sorting, searching, and filtering operations are performed on each System.Data.DataTable contained in a System.Data.DataSet when using the System.Data.DataTable.Select method.

Gets a custom view of the data contained by the System.Data.DataSet that allows filtering, searching, and navigating using a custom System.Data.DataViewManager.

The System.Data.DataViewManager returned by the System.Data.DataSet.DefaultViewManager property allows you to create custom settings for each System.Data.DataTable in the System.Data.DataSet. When you add System.Data.DataTable objects to the System.Data.DataTableCollection, each table is automatically configured to display rows according to the specified property settings of the System.Data.DataView, including sort order, filtering, and System.Data.DataViewRowState.

DesignMode

EnforceConstraints

ToString

Description

Gets or sets a value indicating whether constraint rules are followed when attempting any update operation.

See the System.Data.DataTable.Constraints property for more details.

Events

ExtendedProperties

ToString

Description

Gets the collection of custom user information.

The System.Data.DataSet.ExtendedProperties property allows you to store custom information with the object. For example, you may store a time when the data should be refreshed.

HasErrors

ToString

[C#] public bool HasErrors {get;}

[C++] public: _property bool get_HasErrors( );

[VB] Public ReadOnly Property HasErrors As Boolean

[JScript] public function get HasErrors( ): Boolean;
Description

Gets a value indicating whether there are errors in any of the rows in any of the tables of this System.Data.DataSet.

The System.Data.DataSet.HasErrors property is usually consulted after creating using the System.Data.DataSet.GetChanges method. Check the System.Data.DataSet.HasErrors property of the System.Data.DataSet created with the System.Data.DataSet.GetChanges method to determine if any errors exists. If so, you should reconcile the errors before proceeding to update the data source with the changes.

The System.Data.DataSet.Namespace property is used when reading and writing an XML document into the System.Data.DataSet using the System.Data.DataSet.ReadXml(System.Xml.XmlReader), System.Data.DataSet.WriteXml(System.IO.Stream), System.Data.DataSet.ReadXmlSchema(System.Xml.XmlReader), or System.Data.DataSet.WriteXmlSchema(System.IO.Stream) methods.

Gets or sets an XML prefix that aliases the namespace of the System.Data.DataSet.

The System.Data.DataSet.Prefix is used throughout an XML document to identify elements which belong to the System.Data.DataSet object's namespace (as set by the System.Data.DataSet.Namespace property).

To add tables to the collection, use System.Data.DataTableCollection.Add(System.Data.DataTable) method of the System.Data.DataTableCollection. To remove tables, use the System.Data.DataTableCollection.Remove(System.Data.DataTable) method.

ToString

Description

Occurs when a target and source System.Data.DataRow have the same primary key value, and System.Data.DataSet.EnforceConstraints is set to true.

For more information about handling events, see.

AcceptChanges

[C#] public void AcceptChanges( );

[C++] public: void Acceptchanges( );

[VB] Public Sub AcceptChanges( )

[JScript] public function AcceptChanges( );
Description

Commits all the changes made to this System.Data.DataSet since it was loaded or the last time System.Data.DataSet.AcceptChanges was called.

Both the System.Data.DataRow and System.Data.DataTable classes also have System.Data.DataSet.AcceptChanges methods. Invoking System.Data.DataSet.AcceptChanges on the System.Data.DataSet causes System.Data.DataTable.AcceptChanges to be called on each table in a System.Data.DataSet. Consequently, calling System.Data.DataTable.AcceptChanges on each System.Data.DataTable causes each System.Data.DataRow object's System.Data.DataRow.AcceptChanges method to be called. In this manner, you have multiple levels at which the method can be invoked. Calling the System.Data.DataSet.AcceptChanges of the System.Data.DataSet however, allows you to invoke the method on all subordinate objects (for example, tables and rows) with one call.

BeginInit

[C#] public void BeginInit( );

[C++] public: _sealed void BeginInit( );

[VB] NotOverridable Public Sub BeginInit( )

[JScript] public function Beginnit( );
Description

Begins the initialization of a System.Data.DataSet that is used on a form or used by another component. The initialization occurs at runtime.

The Visual Studio.NET design environment uses this method to start the initialization of a component that is used on a form or used by another component. The System.Data.DataSet.EndInit method ends the initialization. Using the BeginInit and EndInit methods prevents the control from being used before it is fully initialized.

Clear

[C#] public void Clear( );

[C++] public: void Clear( );

[VB] Public Sub Clear( )

[JScript] public function Clear( );
Description

Clears the System.Data.DataSet of any data by removing all rows in all tables.

Clone

[C#] public DataSet Clone( );

[C++] public: DataSet* Clone( );

[VB] Public Function Clone( ) As DataSet

[JScript] public function Clone( ): DataSet;
Description

Clones the structure of the System.Data.DataSet, including all System.Data.DataTable schemas, relations, and constraints.

Return Value: A new System.Data.DataSet with the same schema as the current System.Data.DataSet.

If these classes have been subclassed, the clone will also be of the same subclasses.

Copy

[C#] public DataSet Copy( );

[C++] public: DataSet* Copy( );

[VB] Public Function Copy( ) As DataSet

[JScript] public function Copy( ): DataSet;
Description

Copies both the structure and data for this System.Data.DataSet.

Return Value: A new System.Data.DataSet with the same structure Stable schemas, relations, and constraints) and data as this System.Data.DataSet.

EndInit

[C#] public void EndInit( );

[C++] public: _sealed void EndInit( );

[VB] NotOverridable Public Sub EndInit( )

[JScript] public function EndInit( );
Description

Ends the initialization of a System.Data.DataSet that is used on a form or used by another component. The initialization occurs at runtime.

The Visual Studio.NET design environment uses this method to end the initialization of a component that is used on a form or used by another component. The System.Data.DataSet.BeginInit method starts the initialization. Using the BeginInit and EndInit methods prevents the control from being used before it is fully initialized.

GetChanges

[C#] public DataSet GetChanges( );

[C++] public: DataSet* GetChanges( );

[VB] Public Function GetChanges( ) As DataSet

[JScript] public function GetChanges( ): DataSet; Gets a copy of the System.Data.DataSet containing all changes made to it since it was last loaded, or since System.Data.DataSet.AcceptChanges was called.
Description

Gets a copy of the System.Data.DataSet that contains all changes made to it since it was loaded or System.Data.DataSet.AcceptChanges was last called.

Return Value: A copy of the changes from this System.Data.DataSet that can have actions performed on it and subsequently be merged back in using System.Data.DataSet.Merge(System.Data.DataSet), or null if none are found.

Gets a copy of the System.Data.DataSet that contains all changes made to it since it was loaded or System.Data.DataSet.AcceptChanges was last called. This copy is particularly designed so that it can be merged back in to this original System.Data.DataSet. Relationship constraints may cause Unchanged parent rows to be included. If no rows of these rowStates are found, this method returns null.

GetChanges

[C#] public DataSet GetChanges(DataRowState rowstates);

at [C++] public: DataSet* GetChanges(DataRowState rowStates);

[VB] Public Function GetChanges(ByVal rowStates As DataRowState) As DataSet

Gets a copy of the System.Data.DataSet containing all changes made to it since it was last loaded, or since System.Data.DataSet.AcceptChanges was called, filtered by System.Data.DataRowState.

Return Value: A filtered copy of the System.Data.DataSet that can have actions performed on it, and subsequently be merged back in using System.Data.DataSet.Merge(System.Data.DataSet). If no rows of the desired System.Data.DataRowState are found, the method returns null.

The System.Data.DataSet.GetChanges method is used to produce a second System.Data.DataSet object which contains only the changes introduced into the original. Use the rowStates argument to specify the type of changes the new object should include. One of the System.Data.DataRowState values.

GetNestedChanges

[C#] public DataSet GetNestedChanges(DataRowState rowStates);

[C++] public: DataSet* GetNestedChanges(DataRow State rowStates);

[VB] Public Function GetNestedChanges(ByVal rowStates As DataRowState) As DataSet

A user should not call System.Data.DataSet.GetSerializationData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext) directly. The data needed to serialize or deserialize an object. The source and destination of a given serialized stream.

GetXml

[C#] public string GetXml( );

[C++] public: String* GetXml( );

[VB] Public Function GetXml( ) As String

[JScript] public function GetXml( ): String;
Description

Returns the XML representation of the data stored in the System.Data.DataSet.

Return Value: String that is a representation of the data stored in the System.Data.DataSet.

If the System.Data.DataSet has changes, calling this method is identical to calling System.Data.DataSet.WriteXml(System.IO.Stream) with XmlWriteMode set to DiffGram; otherwise it is equivalent to calling System.Data.DataSet.WriteXml(System.IO.Stream) with XmlWriteMode set to IgnoreSchema.

GetXmlSchema

[C#] public string GetXmlSchema( );

[C++] public: String* GetXmlSchema( );

[VB] Public Function GetXmlSchema( ) As String

[JScript] public function GetXmlSchema( ): String;
Description

Returns the XSD schema for the XML representation of the data stored in the System.Data.DataSet.

Return Value: String that is the XSD schema for the XML representation of the data stored in the System.Data.DataSet.

Calling this method is identical to calling System.Data.DataSet.WriteXmlSchema(System.IO.Stream), except that only the primary schema is written.

Infers the XML schema from the specified System.IO.TextReader into the System.Data.DataSet. The System.IO.Stream from which to read. An array of namespace URI strings to be excluded from schema inference.

Infers the XML schema from the specified file into the System.Data.DataSet. The file name (including the path) from which to read. An array of namespace URI strings to be excluded from schema inference.

Infers the XML schema from the specified System.IO.TextReader into the System.Data.DataSet. The System.IO.TextReader from which to read. An array of namespace URI strings to be excluded from schema inference.

[JScript] public function InferXmlSchema(reader: XmlReader, nsArray: String[ ]); Infers the XML schema from the specified System.IO.TextReader or file into the System.Data.DataSet.
Description

Infer the XML schema from the specified System.IO.TextReader into the System.Data.DataSet. The System.IO.TextReader from which to read. An array of namespace URI strings to be excluded from schema inference.

Merge

[C#] public void Merge(DataRow[ ] rows);

[C++] public: void Merge(DataRow* rows[ ]);

[VB] Public Sub Merge(ByVal rows( ) As DataRow)

[JScript] public function Merge(rows: DataRow[ ]);
Description

Merges this System.Data.DataSet with an array of System.Data.DataRow objects.

The System.Data.DataSet.Merge(System.Data.DataSet) method is used to merge two System.Data.DataSet objects that have largely similar schemas. A merge is typically used on a client application to incorporate the latest changes from a data source into an existing System.Data.DataSet. This allows the client application to have a refreshed System.Data.DataSet with the latest data from the data source. The array of System.Data.DataRow objects that will be merged into the System.Data.DataSet.

Merge

[C#] public void Merge(DataSet dataSet);

[C++] public: void Merge(DataSet* dataSet);

[VB] Public Sub Merge(ByVal dataSet As DataSet)

[JScript] public function Merge(dataSet: DataSet); Merges this System.Data.DataSet with a specified System.Data.DataSet.
Description

Merges this System.Data.DataSet into a specified System.Data.DataSet.

The System.Data.DataSet.Merge(System.Data.DataSet) method is used to merge two System.Data.DataSet objects that have largely similar schemas. A merge is typically used on a client application to incorporate the latest changes from a data source into an existing System.Data.DataSet. This allows the client application to have a refreshed System.Data.DataSet with the latest data from the data source. The System.Data.DataSet whose data and schema will be merged.

Merge

[C#] public void Merge(DataTable table);

[C++] public: void Merge(DataTable* table);

[VB] Public Sub Merge(ByVal table As DataTable)

[JScript] public function Merge(table: DataTable);
Description

Merges a System.Data.DataSet with a specified System.Data.DataTable.

The System.Data.DataSet.Merge(System.Data.DataSet) method is used to merge two System.Data.DataSet objects that have largely similar schemas. A merge is typically used on a client application to incorporate the latest changes from a data source into an existing System.Data.DataSet. This allows the client application to have a refreshed System.Data.DataSet with the latest data from the data source. The System.Data.DataTable whose data and schema will be merged.

Merges this System.Data.DataSet with a specified System.Data.DataSet preserving changes according to the specified argument.

The System.Data.DataSet.Merge(System.Data.DataSet) method is used to merge two System.Data.DataSet objects that have largely similar schemas. A merge is typically used on a client application to incorporate the latest changes from a data source into an existing System.Data.DataSet. This allows the client application to have a refreshed System.Data.DataSet with the latest data from the data source. The System.Data.DataSet whose data and schema will be merged. A value indicating whether changes made to the current System.Data.DataSet should be maintained.

Merges this System.Data.DataSet with an array of System.Data.DataRow objects, preserving changes according to the specified argument, and handling an incompatible schema according to the specified argument.

The System.Data.DataSet.Merge(System.Data.DataSet) method is used to merge two System.Data.DataSet objects that have largely similar schemas. A merge is typically used on a client application to incorporate the latest changes from a data source into an existing System.Data.DataSet. This allows the client application to have a refreshed System.Data.DataSet with the latest data from the data source. The array of System.Data.DataRow objects to merge with. true to preserve changes made to the System.Data.DataSet; otherwise, false. One of the System.Data.MissingSchemaAction values.

Merges this System.Data.DataSet with a specified System.Data.DataSet preserving changes according to the specified argument, and handling an incompatible schema according to the specified argument.

The System.Data.DataSet.Merge(System.Data.DataSet) method is used to merge two System.Data.DataSet objects that have largely similar schemas. A merge is typically used on a client application to incorporate the latest changes from a data source into an existing System.Data.DataSet. This allows the client application to have a refreshed System.Data.DataSet with the latest data from the data source. The System.Data.DataSet whose data and schema will be merged. A value indicating whether changes in the current (target) System.Data.DataSet should be maintained. One of the System.Data.MissingSchemaAction values.

Merges this System.Data.DataTable with a specified System.Data.DataTable preserving changes according to the specified argument, and handling an incompatible schema according to the specified argument.

The System.Data.DataSet.Merge(System.Data.DataSet) method is used to merge two System.Data.DataSet objects that have largely similar schemas. A merge is typically used on a client application to incorporate the latest changes from a data source into an existing System.Data.DataSet. This allows the client application to have a refreshed System.Data.DataSet with the latest data from the data source. The System.Data.DataSet whose data and schema will be merged. Whether changes in the current (target) System.Data.DataSet should be maintained. One of the System.Data.MissingSchemaAction values.

Reads XML schema and data into the System.Data.DataSet using the specified System.IO.Stream and System.Data.XmlReadMode. The System.IO.Stream from which to read. One of the System.Data.XmlReadMode values.

Reads XML schema and data into the System.Data.DataSet using the specified file and System.Data.XmlReadMode. The file name (including the path) from which to read. One of the System.Data.XmlReadMode values.

Reads XML schema and data into the System.Data.DataSet using the specified System.IO.TextReader and System.Data.XmlReadMode. The System.IO.TextReader from which to read. One of the System.Data.XmlReadMode values.

[VB] Public Function ReadXml(ByVal reader As XmlReader, ByVal mode As XmlReadMode) As XmlReadMode

[JScript] public function ReadXml(reader: XmlReader, mode: XmlReadMode): XmlReadMode; Writes the current schema and data for the System.Data.DataSet to an XML document using the specified System.Data.XmlReadMode.
Description

Writes schema and data for the DataSet. The System.IO.TextReader from which to read. One of the System.Data.XmlReadMode values.

ReadXmlSchema

[C#] public void ReadXmlSchema(Stream stream);

[C++] public: void ReadXmlSchema(Stream* stream);

[VB] Public Sub ReadXmlSchema(ByVal stream As Stream)

[JScript] public function ReadXmlSchema(stream: Stream);
Description

Reads the XML schema from the specified System.IO.Stream into the System.Data.DataSet.

Use the System.Data.DataSet.ReadXmlSchema(System.Xml.XmlReader) method to create the schema for a System.Data.DataSet. The schema includes table, relation, and constraint definitions. To write a schema to an XML document, use the System.Data.DataSet.WriteXmlSchema(System.IO.Stream) method. The System.IO.Stream from which to read.

Reads the XML schema from the specified file into the System.Data.DataSet.

Use the System.Data.DataSet.ReadXmlSchema(System.Xml.XmlReader) method to create the schema for a System.Data.DataSet. The schema includes table, relation, and constraint definitions. To write a schema to an XML document, use the System.Data.DataSet.WriteXmlSchema(System.IO.Stream) method. The file name (including the path) from which to read.

Reads the XML schema from the specified System.IO.TextReader into the System.Data.DataSet.

Use the System.Data.DataSet.ReadXmlSchema(System.Xml.XmlReader) method to create the schema for a System.Data.DataSet. The schema includes table, relation, and constraint definitions. To write a schema to an XML document, use the System.Data.DataSet.WriteXmlSchema(System.IO.Stream) method. The System.IO.TextReader from which to read.

ReadXmlSchema

[C#] public void ReadXmlSchema(XmlReader reader);

[C++] public: void ReadXmlSchema(XmlReader* reader);

[VB] Public Sub ReadXmlSchema(ByVal reader As XmlReader)

[JScript] public function ReadXmlSchema(reader: XmlReader); Reads an XML schema into the System.Data.DataSet.
Description

Reads the XML schema from the specified System.Xml.XmlReader into the System.Data.DataSet.

Use the System.Data.DataSet.ReadXmlSchema(System.Xml.XmlReader) method to create the schema for a System.Data.DataSet. The schema includes table, relation, and constraint definitions. The System.Xml.XmlReader from which to read.

Reads XML serialization information for the implementation of IXmlSerializable.

Return Value: An System.Xml.XmlTextReader object.

A user should not call System.Data.DataSet.ReadXmlSerializable(System.Xml.XmlReader) directly. The System.Xml.XmlTextReader object.

RejectChanges

[C#] public virtual void RejectChanges( );

[C++] public: virtual void RejectChanges( );

[VB] Overridable Public Sub RejectChanges( )

[JScript] public function RejectChanges( );
Description

Rolls back all the changes made to the System.Data.DataSet since it was created, or since the last time System.Data.DataSet.AcceptChanges was called.

Invoke the System.Data.DataSet.RejectChanges to call the System.Data.DataTable.RejectChanges method on all System.Data.DataTable objects contained by the System.Data.DataSet. Additionally, any System.Data.Constraint rules contained by the System.Data.DataSet are enforced.

Reset

[C#] public virtual void Reset( );

[C++] public: virtual void Reset( );

[VB] Overridable Public Sub Reset( )

[JScript] public function Reset( );
Description

Resets the System.Data.DataSet to its original state. Subclasses should override System.Data.DataSet.Reset to restore a System.Data.DataSet to its original state.

Writes the current schema and data for the System.Data.DataSet using the specified System.IO.Stream.

Use the System.Data.DataSet.WriteXml(System.IO.Stream) method to write an XML document that includes both schema and data of a System.Data.DataSet. To read an XML document, that includes schema and data, use the System.Data.DataSet.ReadXml(System.Xml.XmlReader) method. A System.IO.Stream object used to write to a file.

WriteXml

[C#] public void WriteXml(string fileName);

[C++] public: void WriteXml(String* fileName);

[VB] Public Sub WriteXml(ByVal fileName As String)

[JScript] public function WriteXml(fileName: String);
Description

Writes the current schema and data for the System.Data.DataSet to the specified file. The file name (including the path) to which to write.

WriteXml

[C#] public void WriteXml(TextWriter writer);

[C++] public: void WriteXml(TextWriter* writer);

[VB] Public Sub WriteXml(ByVal writer As TextWriter)

[JScript] public function WriteXml(writer: TextWriter);
Description

Writes the current schema and data for the System.Data.DataSet using the specified System.IO.TextWriter. The System.IO.TextWriter object with which to write.

WriteXml

[C#] public void WrteXml(XmlWriter writer);

[C++] public: void WriteXml(XmlWriter* writer);

[VB] Public Sub WriteXml(ByVal writer As XmlWriter)

[JScript] public function WriteXml(writer: XmlWriter);
Description

Writes the current schema and data for the System.Data.DataSet to the specified System.Xml.XmlWriter. The System.Xml.XmlWriter with which to write.

Writes the current schema and data for the System.Data.DataSet using the specified System.IO.Stream and System.Data.XmlWriteMode. A System.IO.Stream object used to write to a file. One of the System.Data.XmlWriteMode values.

Writes the current schema and data for the System.Data.DataSet to the specified file using the specified System.Data.XmlWriteMode.

Use the System.Data.DataSet.WriteXml(System.IO.Stream) method to write an XML document that includes both schema and data of a System.Data.DataSet. To read an XML document, that includes schema and data, use the System.Data.DataSet.ReadXml(System.Xml.XmlReader) method. The file name (including the path) to which to write. One of the System.Data.XmlWriteMode values.

Writes the current schema and data for the System.Data.DataSet using the specified System.IO.TextWriter and System.Data.XmlWriteMode.

Use the System.Data.DataSet.WriteXml(System.IO.Stream) method to write an XML document that includes both schema and data of a System.Data.DataSet. To read an XML document, that includes schema and data, use the System.Data.DataSet.ReadXml(System.Xml.XmlReader) method. A System.IO.TextWriter object used to write the document. One of the System.Data.XmlWriteMode values.

Writes the current schema and data for the System.Data.DataSet using the specified System.Xml.XmlWriter and System.Data.XmlWriteMode.

Use the System.Data.DataSet.WriteXml(System.IO.Stream) method to write an XML document that includes both schema and data of a System.Data.DataSet. To read an XML document, that includes schema and data, use the System.Data.DataSet.ReadXml(System.Xml.XmlReader) method. The System.Xml.XmlWriter with which to write. One of the System.Data.XmlWriteMode values.

Writes the System.Data.DataSet structure as an XML schema to using the specified System.IO.Stream object.

Use the System.Data.DataSet.WriteXmlSchema(System.IO.Stream) method to write the schema for a System.Data.DataSet to an XML document. The schema includes table, relation, and constraint definitions. To write a schema to an XML document, use the System.Data.DataSet.WriteXmlSchema(System.IO.Stream) method. A System.IO.Stream object used to write to a file.

Use the System.Data.DataSet.WriteXmlSchema(System.IO.Stream) method to write the schema for a System.Data.DataSet to an XML document. The schema includes table, relation, and constraint definitions. To write a schema to an XML document, use the System.Data.DataSet.WriteXmlSchema(System.IO.Stream) method. The file name (including the path) to which to write.

Writes the System.Data.DataSet structure as an XML schema to a System.IO.TextWriter object.

Use the System.Data.DataSet.WriteXmlSchema(System.IO.Stream) method to write the schema for a System.Data.DataSet to an XML document. The schema includes table, relation, and constraint definitions. To write a schema to an XML document, use the System.Data.DataSet.WriteXmlSchema(System.IO.Stream) method. The System.IO.TextWriter object with which to write.

Writes the System.Data.DataSet structure as an XML schema to an System.Xml.XmlWriter object.

Use the System.Data.DataSet.WriteXmlSchema(System.IO.Stream) method to write the schema for a System.Data.DataSet to an XML document. The schema includes table, relation, and constraint definitions. To write a schema to an XML document, use the System.Data.DataSet.WriteXmlSchema(System.IO.Stream) method. The System.Xml.XmlWriter with which to write.

DataSysDescriptionAttribute class (System.Data)

WriteXmlSchema

Description

DescriptionAttribute marks a property, event, or extender with a description. Visual designers can display this description when referencing the member.

The System.Data.DataTable is a central object in the ADO.NET library. Other objects that use the System.Data.DataTable include the System.Data.DataSet and the System.Data.DataView.

ToString

[C#] protected internal bool fInitInProgress;

[C++] protected public: bool fInitInProgress;

[VB] Internal fInitInProgress As Boolean

[JScript] package var fInitInProgress: Boolean;
Description

DataTable

Example Syntax:

ToString

[C#] public DataTable( );

[C++] public: DataTable( );

[VB] Public Sub New( )

[JScript] public function DataTable( ); Initializes a new instance of the System.Data.DataTable class.
Description

Initializes a new instance of the System.Data.DataTable class with no arguments.

The constructor sets initial values for all properties of the System.Data.DataTable object. The following table shows the properties and their default values. When an instance System.Data.DataTable is created, the following read/write properties are set to initial values.

DataTable

Example Syntax:

ToString

[C#] public DataTable(string tableName);

[C++] public: DataTable(String* tableName);

[VB] Public Sub New(ByVal tableName As String)

[JScript] public function DataTable(tableName: String);
Description

Intitalizes a new instance of the System.Data.DataTable class with the specified table name. The name to give the table. If null or an empty string, a default name will be given when added to the System.Data.DataTableCollection.

Initializes a new instance of the System.Data.DataTable class with the System.Runtime.Serialization.SerializationInfo and the System.Runtime.Serialization.StreamingContext.

This implemenation of the System.Data.DataTable constructor is required for System.Runtime.Serialization.ISerializable. The data needed to serialize or deserialize an object. The source and destination of a given serialized stream.

Gets the collection of child relations for this System.Data.DataTable.

A System.Data.DataRelation defines the relationship between two tables. Typically, two tables are linked through a single field that contains the same data. For example, a table which contains address data may have a single field containing codes that represent countries/regions. A second table that contains country/region data will have a single field that contains the code that identifies the country/region, and it is this code which is inserted into the corresponding field in the first table. A System.Data.DataRelation, then, contains at least four pieces of information: (1) the name of the first table, (2) the column name in the first table, (3) the name of the second table, and (4) the column name in the second table.

A System.Data.ForeignKeyConstraint restricts the action performed when a value in a column (or columns) is either deleted or updated. Such a constraint is intended to be used with primary key columns. In a parent/child relationship between two tables, deleting a value from the parent table can affect the child rows in one of the following ways.

Container

DataSet

ToString

Description

Gets the System.Data.DataSet that this table belongs to.

If a control is data bound to a System.Data.DataTable, and the table belongs to a System.Data.DataSet, you can get to the System.Data. DataSet through this property.

DefaultView

ToString

[C#] public DataView DefaultView {get;}

[C++] public: _property DataView* get_DefaultView( );

[VB] Public ReadOnly Property DefaultView As DataView

[JScript] public function get DefaultView( ): DataView;
Description

Gets a customized view of the table which may include a filtered view, or a cursor position.

The System.Data.DataTable.DefaultView property returns a System.Data.DataView you can use to sort, filter, and search a System.Data.DataTable

DesignMode

DisplayExpression

ToString

Description

Gets or sets the expression that will return a value used to represent this table in the user interface.

For rules on forming the expression string, see the System.Data.DataColumn.Expression property.

Events

ExtendedProperties

ToString

Description

Gets the collection of customized user information.

Use the System.Data.DataTable.ExtendedProperties to add custom information to a System.Data.DataTable. Add information with the Add method. Retrieve information with the Item method.

HasErrors

ToString

[C#] public bool HasErrors {get;}

[C++] public: _property bool get_HasErrors( );

[VB] Public ReadOnly Property HasErrors As Boolean

[JScript] public function get HasErrors( ): Boolean;
Description

Gets a value indicating whether there are errors in any of the rows in any of the tables of the System.Data.DataSet to which the table belongs.

As users work on a set of data contained in a System.Data.DataSet, you can mark each change with an error if the change causes some validation failure. You can mark an entire System.Data.DataRow with an error message using the System.Data.DataRow.RowError property. You can also set errors on each column of the row with the System.Data.DataRow.SetColumnError(System.Int32,System.String) method.

The System.Data.DataTable.MinimumCapacity allows the system to create an appropriate set of resources before fetching data. In a situation when performance is critical, setting this property can optimize performance.

Gets or sets an array of columns that function as primary keys for the data table.

The primary key of a table must be unique to identify the record in the table. It's also possible to have a table with a primary key made up of two or more columns. This occurs when a single column can't contain enough unique values. For example, a two column primary key might consist of a “FirstName” and “LastName” column. Because primary keys can be made up of more than one column, the System.Data.DataTable.PrimaryKey property consists of an array of System.Data.DataColumn objects.

Rows

ToString

[C#] public DataRowCollection Rows {get;}

[C++] public: _property DataRowCollection* get_Rows( );

[VB] Public ReadOnly Property Rows As DataRowCollection

[JScript] public function get Rows( ): DataRowCollection;
Description

Gets the collection of rows that belong to this table.

To create a new System.Data.DataRow, you must use the System.Data.DataTable.NewRow method to return a new object. Such an object is automatically configured with according to the schema defined for the System.Data.DataTable through its collection of System.Data.DataColumn objects. After creating a new row and setting the values for each column in the row, add the row to the DataRowCollection using the Add method.

Commits all the changes made to this table since the last time System.Data.DataTable.AcceptChanges was called.

When System.Data.DataTable.AcceptChanges is called, any System.Data.DataRow object still in edit mode successfully ends its edits. The System.Data.DataRowState also changes: all Added and Modified rows become Unchanged; Deleted rows are removed.

BeginInit

[C#] public void BeginInit( );

[C++] public: _sealed void BeginInit( );

[VB] NotOverridable Public Sub BeginInit( )

[JScript] public function BeginInit( );
Description

Begins the initialization of a System.Data.DataTable that is used on a form or used by another component. The initialization occurs at runtime.

The Visual Studio.NET design environment uses this method to start the initialization of a component that is used on a form or used by another component. The System.Data.DataTable.EndInit method ends the initialization. Using the BeginInit and EndInit methods prevents the control from being used before it is fully initialized.

BeginLoadData

[C#] public void BeginLoadData( );

[C++] public: void BeginLoadData( );

[VB] Public Sub BeginLoadData( )

[JScript] public function BeginLoadData( );
Description

Turns off notifications, index maintenance, and constraints while loading data.

Use System.Data.DataTable.BeginLoadData in conjunction with System.Data.DataTable.LoadDataRow(System.Object[ ],System.Boolean) and System.Data.DataTable.EndLoadData.

Clear

[C#] public void Clear( );

[C++] public: void Clear( );

[VB] Public Sub Clear( )

[JScript] public function Clear( );
Description

Clears the System.Data.DataTable of all data.

All rows in all tables are removed. An exception is generated if the table has any enforced child relations that would cause child rows to be stranded.

Clone

[C#] public DataTable Clone( );

[C++] public: DataTable* Clone( );

[VB] Public Function Clone( ) As DataTable

[JScript] public function Clone( ): DataTable;
Description

Clones the structure of the System.Data.DataTable, including all System.Data.DataTable schemas, relations, and constraints.

Return Value: A new System.Data.DataTable with the same schema as the current System.Data.DataTable.

If these classes have been subclassed, the clone will also be of the same subclasses.

Compute

[C#] public object Compute(string expression, string filter);

[C++] public: Object* Compute(String* expression, String* filter);

[VB] Public Function Compute(ByVal expression As String, ByVal filter As String) As Object

Computes the given expression on the current rows that pass the filter criteria.

Return Value: An System.Object, set to the result of the computation.

The expression parameter requires an aggregate function. For example, the following is a legal expression: Count(Quantity) But this expression is not: Sum (Quantity*UnitPrice) If you must perform an operation on two or more columns, you should create a System.Data.DataColumn, set its System.Data.DataColumn.Expression property to an appropriate expression, and use an aggregate expression on the resulting column. In that case, given a System.Data.DataColumn with the name “total,” and the System.Data.DataColumn.Expression property set to: “Quantity*UnitPrice” The expression argument for the System.Data.DataTable.Compute(System.String,System.String) method would then be: Sum(total) The second parameter filter determines which rows are used in the expression. For example, if the table contains a date column named “colDate”, you could limit the rows with the following expression: colDate>Jan. 1, 1999 AND colDate<Jan. 17, 1999 For rules on creating expressions for both parameters, see the System.Data.DataColumn.Expression property of the System.Data.DataColumn class. The expression to compute. The filter to limit the rows that evaluate in the expression.

Copy

[C#] public DataTable Copy( );

[C++] public: DataTable* Copy( );

[VB] Public Function Copy( ) As DataTable

[JScript] public function Copy( ): DataTable;
Description

Copies both the structure and data for this System.Data.DataTable.

Return Value: A new System.Data.DataTable with the same structure (table schemas, relations, and constraints) and data as this System.Data.DataTable.

EndInit

[C#] public void EndInit( );

[C++] public: _sealed void EndInit( );

[VB] NotOverridable Public Sub EndInit( )

[JScript] public function EndInit( );
Description

Ends the initialization of a System.Data.DataTable that is used on a form or used by another component. The initialization occurs at runtime.

The Visual Studio.NET design environment uses this method to end the initialization of a component that is used on a form or used by another component. The System.Data.DataTable.BeginInit method starts the initialization. Using the BeginInit and EndInit methods prevents the control from being used before it is fully initialized.

EndLoadData

[C#] public void EndLoadData( );

[C++] public: void EndLoadData( );

[VB] Public Sub EndLoadData( )

[JScript] public function EndLoadData( );
Description

Turns off notifications, index maintenance, and constraints while loading data.

Use System.Data.DataTable.EndLoadData in conjunction with System.Data.DataTable.LoadDataRow(System.Object[ ],System.Boolean) and System.Data.DataTable.BeginLoadData.

GetChanges

[C#] public DataTable GetChanges( );

[C++] public: DataTable* GetChanges( );

[VB] Public Function GetChanges( ) As DataTable

[JScript] public function GetChanges( ): DataTable; Gets a copy of the System.Data.DataTable containing all changes made to it since it was last loaded, or since System.Data.DataTable.AcceptChanges was called.
Description

Gets a copy of the System.Data.DataTable that contains all changes made to it since it was loaded or System.Data.DataTable.AcceptChanges was last called.

Return Value: A copy of the changes from this System.Data.DataTable that can have actions performed on it and subsequently be merged back in using System.Data.DataSet.Merge(System.Data.DataSet), or null if none are found.

Gets a copy of the System.Data.DataTable that contains all changes made to it since it was loaded or System.Data.DataTable.AcceptChanges was last called. This copy is particularly designed so that it can be merged back in to this original System.Data.DataTable. Relationship constraints may cause Unchanged parent rows to be included. If no rows of these rowStates are found, this method returns null.

GetChanges

[C#] public DataTable GetChanges(DataRowState rowStates);

[C++] public: DataTable* GetChanges(DataRowState rowstates);

[VB] Public Function GetChanges(ByVal rowStates As DataRowState) As DataTable

Gets a copy of the System.Data.DataTable containing all changes made to it since it was last loaded, or since System.Data.DataTable.AcceptChanges was called, filtered by System.Data.DataRowState.

Return Value: A filtered copy of the System.Data.DataTable that can have actions performed on it, and subsequently be merged back in using System.Data.DataSet.Merge(System.Data.DataSet). If no rows of the desired System.Data.DataRowState are found, the method returns null.

The System.Data.DataTable.GetChanges method is used to produce a second System.Data.DataTable object which contains only the changes introduced into the original. Use the rowStates argument to specify the type of changes the new object should include. One of the System.Data.DataRowState values.

GetErrors

[C#] public DataRow[ ] GetErrors( );

[C++] public: DataRow* GetErrors( ) [ ];

[VB] Public Function GetErrors( ) As DataRow( )

[JScript] public function GetErrors( ): DataRow[ ];
Description

Gets an array of System.Data.DataRow objects that contain errors.

Return Value: An array of System.Data.DataRow objects that have errors.

Invoke System.Data.DataTable.GetErrors after invoking the System.Data.DataSet class's System.Data.DataSet.GetChanges method. Also, be sure you don't invoke the System.Data.DataTable.AcceptChanges on the System.Data.DataTable until after all errors have been succesfully resolved, and the System.Data.DataSet re-submitted for updating.

GetRowType

[C#] protected virtual Type GetRowType( );

[C++] protected: virtual Type* GetRowType( );

[VB] Overridable Protected Function GetRowType( ) As Type

[JScript] protected function GetRowType( ): Type;
Description

Gets the row type.

Return Value: The System.Type of the row.

ImportRow

[C#] public void ImportRow(DataRow row);

[C++] public: void ImportRow(DataRow* row);

[VB] Public Sub ImportRow(ByVal row As DataRow)

[JScript] public function ImportRow(row: DataRow);
Description

Copies a System.Data.DataRow, including original and current values, System.Data.DataRowState values, and errors, into a System.Data.DataTable. A System.Data.DataRow, including original and current values, System.Data.DataRowState values, and errors.

Finds and updates a specific row. If no matching row is found, a new row is created using the given values.

Return Value: The new System.Data.DataRow.

The System.Data.DataTable.LoadDataRow(System.Object[ ];System.Boolean) method takes an array of values and finds the matching value(s) in the primary key column(s). An array of values used to create the new row. true to accept changes; otherwise, false.

NewRow

[C#] public DataRow NewRow( );

[C++] public: DataRow* NewRow( );

[VB] Public Function NewRow( ) As DataRow

[JScript] public function NewRow( ): DataRow;
Description

Creates a new System.Data.DataRow with the same schema as the table.

Return Value: A System.Data.DataRow with the same schema as the System.Data.DataTable.

You must use the System.Data.DataTable.NewRow method to create new System.Data.DataRow objects with the same schema as the System.Data.DataTable. After creating a System.Data.DataRow, you can add it to the System.Data.DataRowCollection, through the System.Data.DataTable object's System.Data.DataTable.Rows property.

Raising an event invokes the event handler through a delegate. For an overview, see. A System.Data.DataRowChangeEventArgs that contains the event data.

RejectChanges

[C#] public void RejectChanges( );

[C++] public: void RejectChanges( );

[VB] Public Sub RejectChanges( )

[JScript] public function RejectChanges( );
Description

Rolls back all changes that have been made to the table since it was loaded, or the last time System.Data.DataTable.AcceptChanges was called.

When System.Data.DataTable.RejectChanges is called, any System.Data.DataRow objects that are still in edit-mode cancel their edits. New rows are removed. Rows with the System.Data.DataRowState set to Modified or Deleted return back to their original state.

The method returns the current rows in order of primary key (or lacking one, order of addition.) The following example returns an array of System.Data.DataRow objects through the System.Data.DataTable.Select method.

Select

[C#] public DataRow[ ] Select(string filterExpression);

[C++] public: DataRow* Select(String* filterExpression) [ ];

[VB] Public Function Select(ByVal filterExpression As String) As DataRow( )

Gets an array of all System.Data.DataRow objects that match the filter criteria in order of primary key (or lacking one, order of addition.)

Return Value: An array of System.Data.DataRow objects.

To create the filterExpression argument, use the same rules that apply to the System.Data.DataColumn class's System.Data.DataColumn.Expression property value for creating filters. The criteria to use to filter the rows.

To form the filterExpression argument, use the same rules for creating the System.Data.DataColumn class's System.Data.DataColumn.Expression property value. The Sort argument also uses the same rules for creating class's System.Data.DataColumn.Expression strings. The criteria to use to filter the rows. A string specifying the column and sort direction.

Gets an array of all System.Data.DataRow objects that match the filter in the order of the sort, that match the specified state.

Return Value: An array of System.Data.DataRow objects.

To form the filterExpression argument, use the same rules for creating the System.Data.DataColumn class's System.Data.DataColumn.Expression property value. The Sort argument also uses the same rules for creating class's System.Data.DataColumn.Expression strings. The criteria to use to filter the rows. A string specifying the column and sort direction. One of the System.Data.DataViewRowState values.

Gets the System.Data.DataTable.TableName and System.Data.DataTable.DisplayExpression, if there is one as a concatenated string.

Return Value: A string consisting of the System.Data.DataTable.TableName and the System.Data.DataTable.DisplayExpression values.

Gets the System.Data.DataTable.TableName and System.Data.DataTable.DisplayExpression for the System.Data.DataTable.

DataTableCollection class (System.Data)

ToString

Description

Represents the collection of tables for the System.Data.DataSet.

The System.Data.DataTableCollection contains all of the System.Data.DataTable objects for a System.Data.DataSet. To access the System.Data.DataTableCollection of a System.Data.DataSet, use the System.Data.DataSet.Tables property.

Count

IsReadOnly

IsSynchronized

Item

ToString

System.Data.DataTable

Description

Gets the System.Data.DataTable specified by its index.

The System.Data.DataTableCollection.Contains(System.String) method. can be used to determine if a table with a specified index exists. The zero-based index of the System.Data.DataTable to find.

Item

ToString

[C#] public DataTable this[string name] {get;}

[C++] public: _property DataTable* get_Item(String* name);

[VB] Public Default ReadOnly Property Item(ByVal name As String) As DataTable

The System.Data.DataTable object's name is specified by the System.Data.DataTable.TableName property. If you add a System.Data.DataTable to the System.Data.DataTableCollection with the System.Data.DataTableCollection.Add(System.Data.DataTable) method, passing no arguments, the table is given a default name such as Table1, Table2, and so on. The table name to check for.

IndexOf

[C#] public virtual int IndexOf(DataTable table);

[C++] public: virtual int Indexof(DataTable* table);

[VB] Overridable Public Function IndexOf(ByVal table As DataTable,) As Integer

Raising an event invokes the event handler through a delegate. For an overview, see. A System.ComponentModel.CollectionChangeEventArgs that contains the event data.

Remove

[C#] public void Remove(DataTable table);

[C++] public: void Remove(DataTable* table);

[VB] Public Sub Remove(ByVal table As DataTable)

[JScript] public function Remove(table: DataTable); Removes a table from the collection.
Description

Removes the specified table from the collection.

The System.Data.DataTableCollection.OnCollectionChanged(System.ComponentModel.CollectionChangeEventArgs) event occurs when a table is succesfully removed. The System.Data.DataTable to remove.

Remove

[C#] public void Remove(string name);

[C++] public: void Remove(String* name);

[VB] Public Sub Remove(ByVal name As String)

[JScript] public function Remove(name: String);
Description

Removes the table with a specified name from the collection.

The System.Data.DataTableCollection.OnCollectionChanged(System.ComponentModel.CollectionChangeEventArgs) event occurs when a table is succesfully removed. The name of the System.Data.DataTable to remove.

RemoveAt

[C#] public void RemoveAt(int index);

[C++] public: void RemoveAt(int index);

[VB] Public Sub RemoveAt(ByVal index As Integer)

[JScript] public function RemoveAt(index: int);
Description

Removes the table at the given index from the collection The collection doesn't have a table at this index.

The System.Data.DataTableCollection.OnCollectionChanged(System.ComponentModel.CollectionChangeEventArgs) event occurs when a table is successfully removed. The index at which to remove a table.

Data View class (System.Data)

ToString

Description

Represents a databindable, customized view of a System.Data.DataTable for sorting, filtering, searching, editing, and navigation.

A major function of the System.Data.DataView is to allow data binding on both Windows Forms and Web Forms.

DataView

Example Syntax:

ToString

[C#] public Data View( );

[C++] public: Data View( );

[VB] Public Sub New( )

[JScript] public function Data View( ); Initializes a new instance of the System.Data.DataView class.
Description

Initializes a new instance of the System.Data.DataView class.

DataView

Example Syntax:

ToString

[C#] public DataView(DataTable table);

[C++] public: DataView(DataTable* table);

[VB] Public Sub New(ByVal table As DataTable)

[JScript] public function DataView(table: DataTable);
Description

Initializes a new instance of the System.Data.DataView class with the specified System.Data.DataTable. A System.Data.DataTable to add to the System.Data.DataView.

Gets a value indicating whether the data source is currently open and projecting views of data on the System.Data.DataTable.

A System.Data.DataView is a “view” on a System.Data.DataTable because it provides custom sorting and filtering of the data. The System.Data.DataView.IsOpen property can be queried to determine if a System.Data.DataView has been opened using the System.Data.DataView. Open method.

Gets or sets the expression used to filter which rows are viewed in the System.Data.DataView.

To form a System.Data.DataView.RowFilter value, specify the name of a column followed by an operator and a value to filter on. The value must be in quotes. For example: “LastName=‘Smith’” See the System.Data.DataColumn class's System.Data.DataColumn.Expression property for more information.

Only rows that have been deleted using the System.Data.DataView.Delete(System.Int32) method will have their System.Data.DataView.RowStateFilter value set to Deleted. Those rows added using the System.Data.DataView.AddNew method will similarly have the property set to Added.

Site

Sort

ToString

Description

Gets or sets the sort column or columns, and sort order for the table.

See the System.Data.DataColumn.Expression property of System.Data.DataColumn for more details on forming a System.Data.DataView.Sort expression.

The System.Data.DataTable also has a System.Data.DataTable.DefaultView property which returns the default System.Data.DataView for the table. For example, if you wish to create a custom view on the table, set the System.Data.DataView.RowFilter on the System.Data.DataView returned by the System.Data.DataTable.DefaultView

ToString

Description

Occurs when the list managed by the System.Data.DataView changes.

AddNew

[C#] public virtual DataRowView AddNew( );

[C++] public: virtual DataRowView* AddNew( );

[VB] Overridable Public Function AddNew( ) As DataRow View

[JScript] public function AddNew( ): DataRowView;
Description

Adds a new row to the System.Data.DataView.

Return Value: A System.Data.DataRowView.

BeginInit

[C#] public void BeginInit( );

[C++] public: _sealed void BeginInit( );

[VB] NotOverridable Public Sub BeginInit( )

[JScript] public function BeginInit( );
Description

Begins the initialization of a System.Data.DataView that is used on a form or used by another component. The initialization occurs at runtime.

The Visual Studio.NET design environment uses this method to start the initialization of a component that is used on a form or used by another component. The System.Data.DataView.EndInit method ends the initialization. Using the BeginInit and EndInit methods prevents the control from being used before it is fully initialized.

Close

[C#] protected void Close( );

[C++] protected: void Close( );

[VB] Protected Sub Close( )

[JScript] protected function Close( );
Description

Closes the System.Data.DataView.

The method allows you to manually close the System.Data.DataView in derived classes. Use the corresponding System.Data.DataView. Open method to open the System.Data.DataView.

Copies items into an array. Only for Web Forms Interfaces. array to copy into. index to start at.

Delete

[C#] public void Delete(int index);

[C++] public: void Delete(int index);

[VB] Public Sub Delete(ByVal index As Integer)

[JScript] public function Delete(index: int);
Description

Deletes a row at the specified index.

After deleting a System.Data.DataRow, its state changes to DataViewRowState.Deleted. You can roll back the deletion by calling System.Data.DataTable.RejectChanges on the System.Data.DataTable. The index of the row to delete.

Disposes of the resources (other than memory) used by the System.Data.DataView object.

Property change notifications between the System.Data.DataView and the underlying System.Data.DataTable stop after this method is called.

EndInit

[C#] public void EndInit( );

[C++] public: _sealed void EndInit( );

[VB] NotOverridable Public Sub EndInit( )

[JScript] public function EndInit( );
Description

Ends the initialization of a System.Data.DataView that is used on a form or used by another component. The initialization occurs at runtime.

The Visual Studio.NET design environment uses this method to end the initialization of a component that is used on a form or used by another component. The System.Data.DataView.BeginInit method starts the initialization. Using the BeginInit and EndInit methods prevents the control from being used before it is fully initialized.

Find

[C#] public int Find(object key);

[C++] public: int Find(Object* key);

[VB] Public Function Find(ByVal key As Object) As Integer

[JScript] public function Find(key: Object): int; Finds a row in the System.Data.DataView by the specified primary key value.
Description

Finds a row in the System.Data.DataView by the specified primary key value.

Return Value: The index of the row in the System.Data.DataView containing the primary key value specified; otherwise a null value if the primary key value does not exist. The object to search for.

Find

[C#] public int Find(object[ ] key);

[C++] public: int Find(Object* key _gc[ ]);

[VB] Public Function Find(ByVal key( ) As Object) As Integer

[JScript] public function Find(key: Object[ ]) int;
Description

Finds an array of rows in the System.Data.DataView by the specified primary key values.

Return Value: The array of row indexes in the System.Data.DataView containing the primary key values specified; otherwise a null value if the primary key values do not exist. An array of values, typed as System.Object.

FindRows

[C#] public DataRowView[ ] FindRows(object key);

[C++] public: DataRowView* FindRows(Object* key) [ ];

[VB] Public Function FindRows(ByVal key As Object) As DataRowView( )

[JScript] public function FindRows(key: Object): DataRowView[ ]; Finds a row in the System.Data.DataView by the specified primary key value.

Raises a System.Data.DataRelation Collection.CollectionChanged event when a System.Data.DataRelation is added to or removed from the System.Data.DataRelationCollection. The source of the event. A System.ComponentModel.CollectionChangeEventArgs that contains the event data.

Raises a System.Data.DataTableCollection.CollectionChanged event when a System.Data.DataTable is added to or removed from the System.Data.DataTableCollection. The source of the event. A System.ComponentModel.CollectionChangeEventArgs that contains the event data.

DataViewRowState enumeration (System.Data)

ToString

Description

Describes the version of data in a System.Data.DataRow.

The System.Data.DataViewRowState values are used either to retrieve a particular version of data from a System.Data.DataRow, or to determine what versions exist.

ToString

[C#] public const DataViewRowState Added;

[C++] public: const DataViewRowState Added;

[VB] Public Const Added As DataViewRowState

[JScript] public var Added: DataViewRowState;
Description

A new row.

ToString

[C#] public const DataViewRowState CurrentRows;

[C++] public: const DataViewRowState CurrentRows;

[VB] Public Const CurrentRows As DataViewRowState

[JScript] public var CurrentRows: DataViewRowState;
Description

Current rows including unchanged, new, and modified rows.

ToString

[C#] public const DataViewRowState Deleted,

[C++] public: const DataViewRowState Deleted;

[VB] Public Const Deleted As DataViewRowState

[JScript] public var Deleted: DataViewRowState;
Description

A deleted row.

ToString

[C#] public const DataViewRowState ModifiedCurrent;

[C++] public: const DataViewRowState ModifiedCurrent;

[VB] Public Const ModifiedCurrent As DataViewRowState

[JScript] public var ModifiedCurrent: DataViewRowState;
Description

A current version, which is a modified version of original data (see ModifiedOriginal).

ToString

[C#] public const DataViewRowState ModifiedOriginal;

[C++] public: const DataViewRowState ModifiedOriginal;

[VB] Public Const ModifiedOriginal As DataViewRowState

[JScript] public var ModifiedOriginal: DataViewRowState;
Description

The original version (although it has since been modified and is available as ModifiedCurrent).

ToString

[C#] public const DataViewRowState None;

[C++] public: const DataViewRowState None;

[VB] Public Const None As DataViewRowState

[JScript] public var None: DataViewRowState;
Description

None.

ToString

[C#] public const DataViewRowState OriginalRows;

[C++] public: const DataViewRowState OriginalRows;

[VB] Public Const OriginalRows As DataViewRowState

[JScript] public var OriginalRows: DataViewRowState;
Description

Original rows including unchanged and deleted rows.

ToString

[C#] public const DataViewRowState Unchanged;

[C++] public: const DataViewRowState Unchanged;

[VB] Public Const Unchanged As DataViewRowState

[JScript] public var Unchanged: DataViewRowState;
Description

An unchanged row.

DataViewSetting class (System.Data)

ToString

Description

Represents the default settings for ApplyDefaultSort, DataViewManager, RowFilter, RowStateFilter, Sort, and Table for DataViews created from the System.Data.DataViewManager.

Gets or sets a value indicating the Sort to apply in the System.Data.DataView.

Table

ToString

[C#] public DataTable Table {get;}

[C++] public: _property DataTable* get_Table( );

[VB] Public ReadOnly Property Table As DataTable

[JScript] public function get Table( ): DataTable;
Description

Gets the System.Data.DataTable to which the System.Data.DataViewSetting properties apply.

DataViewSettingCollection class (System.Data)

ToString

Description

Contains a read-only collection of System.Data.DataViewSetting objects for each System.Data.DataTable in a System.Data.DataSet.

A user cannot add or remove a DataViewSetting from the collection, but can change the properties of the DataViewSetting corresponding to a particular DataTable. Adding or removing a DataTable from the DataSet adds or removes the corresponding DataViewSetting from the collection.

Count

ToString

[C#] public virtual int Count {get;}

[C++] public: _property virtual int get_Count( );

[VB] Overridable Public ReadOnly Property Count As Integer

[JScript] public function get Count( ): int;
Description

Gets the number of System.Data.DataViewSetting objects in the System.Data.DataViewSettingCollection.

The number of System.Data.DataViewSetting objects is the same as the number of System.Data.DataTable objects in the System.Data.DataSet.

IsReadOnly

ToString

[C#] public bool IsReadOnly {get;}

[C++] public: _property bool get_IsReadOnly( );

[VB] Public ReadOnly Property IsReadOnly As Boolean

[JScript] public function get IsReadOnly( ): Boolean;
Description

Gets a value indicating whether the System.Data.DataViewSettingCollection is read-only.

IsSynchronized

ToString

[C#] public bool IsSynchronized {get;}

[C++] public: _property bool get_IsSynchronized( );

[VB] Public ReadOnly Property IsSynchronized As Boolean

[JScript] public function get IsSynchronized( ): Boolean;
Description

Gets a value indicating whether access to the System.Data.DataViewSettingCollection is synchronized (thread-safe).

This property implements the System.Collections.ICollection interface.

Copies the elements of the System.Data.DataViewSettingCollection to the specified array. An System.Array to which to copy System.Data.DataViewSettingCollection elements. The starting index of the array.

GetEnumerator

[C#] public IEnumerator GetEnumerator( );

[C++] public: _sealed IEnumerator* GetEnumerator( );

[VB] NotOverridable Public Function GetEnumerator( ) As IEnumerator

[JScript] public function GetEnumerator( ): IEnumerator,
Description

Gets an IEnumerator for the collection.

DBConcurrencyException class (System.Data)

ToString

Description

The exception that is thrown by the DataAdapter during the update operation if the number of rows affected equals zero.

The DataAdapter examines the number of rows affected by the execution of each insert, update, or delete operation, and throws this exception if the number equals zero. This is usually the result of a concurrency violation.

DBConcurrencyException

Example Syntax:

ToString

[C#] public DBConcurrencyException(string message);

[C++] public: DBConcurrencyException(String* message);

[VB] Public Sub New(ByVal message As String)

[JScript] public function DBConcurrencyException(message: String); Initializes a new instance of the System.Data.DBConcurrencyException class.
Description

Initializes a new instance of the System.Data.DBConcurrencyException class. The text string describing the details of the exception.

Initializes a new instance of the System.Data.DBConcurrencyException class.

You can create a new exception that catches an earlier exception. The code that handles the second exception can make use of the additional information from the earlier exception, also called an inner exception, to examine the cause of the initial error. The text string describing the details of the exception. A reference to an inner exception.

HelpLink

HResult

InnerException

Message

Row

ToString

Description

Gets or sets the value of the System.Data.DataRow.

Use System.Data.DBConcurrencyException.Row to retrieve the value of the System.Data.DataRow row that generated the System.Data.DBConcurrencyException. Setting the value of the System.Data.DataRow has no effect.

Source

StackTrace

TargetSite

DbType enumeration (System.Data)

ToString

Description

Gets the data type of a field, a property, or a Parameter object of a .NET data provider.

The type of a parameter is specific to the .NET data provider. Specifying the type converts the value of the Parameter to the .NET data provider Type before passing the value to the data source. If the type is not specified, ADO.NET infers the .NET data provider Type of the Parameter from the .NET Framework Type from the Value property of the Parameter object.

ToString

[C#] public const DbType AnsiString;

[C++] public: const DbType AnsiString;

[VB] Public Const AnsiString As DbType

[JScript] public var AnsiString: DbType;
Description

A variable-length stream of non-Unicode characters ranging between 1 and 8,000 characters.

ToString

[C#] public const DbType AnsiStringFixedLength;

[C++] public: const DbType AnsiStringFixedLength;

[VB] Public Const AnsiStringFixedLength As DbType

[JScript] public var AnsiStringFixedLength: DbType;

ToString

[C#] public const DbType Binary;

[C++] public: const DbType Binary;

[VB] Public Const Binary As DbType

[JScript] public var Binary: DbType;
Description

A variable-length stream of binary data ranging between 1 and 8,000 bytes.

ToString

[C#] public const DbType Boolean;

[C++] public: const DbType Boolean;

[VB] Public Const Boolean As DbType

[JScript] public var Boolean: DbType;
Description

A simple type representing Boolean values of true or false.

ToString

[C#] public const DbType Byte;

[C++] public: const DbType Byte;

[VB] Public Const Byte As DbType

[JScript] public var Byte: DbType;
Description

An 8-bit unsigned integer.

ToString

[C#] public const DbType Currency;

[C++] public: const Db Type Currency;

[VB] Public Const Currency As DbType

[JScript] public var Currency: DbType;
Description

A currency value ranging from −2 (or −922,337,203,685,477.5808) to 2 −1 (or +922,337,203,685,477.5807) with an accuracy to a ten-thousandth of a currency unit.

ToString

[C#] public const DbType Date;

[C++] public: const DbType Date;

[VB] Public Const Date As DbType

[JScript] public var Date: DbType;
Description

Date and time data ranging in value from Jan. 1, 1753 to Dec. 31, 9999 to an accuracy of 3.33 milliseconds.

A floating point type representing values ranging from approximately 5.0×10 to 1.7×10 with a precision of 15-16 digits.

ToString

[C#] public const DbType Guid;

[C++] public: const DbType Guid;

[VB] Public Const Guid As DbType

[JScript] public var Guid: DbType;
Description

A globally unique identifier (or GUID).

ToString

[C#] public const DbType Int16;

[C++] public: const DbType Int16;

[VB] Public Const Int16 As DbType

[JScript] public var Int16: DbType;
Description

An integral type representing signed 16-bit integers with values between −32768 and 32767.

ToString

[C#] public const DbType Int32;

[C++] public: const DbType Int32;

[VB] Public Const Int32 As DbType

[JScript] public var Int32: DbType;
Description

An integral type representing signed 32-bit integers with values between −2147483648 and 2147483647.

ToString

[C#] public const DbType Int64;

[C++] public: const DbType Int64;

[VB] Public Const Int64 As DbType

[JScript] public var Int64: DbType;
Description

An integral type representing signed 64-bit integers with values between −9223372036854775808 and 9223372036854775807.

ToString

[C#] public const DbType Object;

[C++] public: const DbType Object;

[VB] Public Const Object As DbType

[JScript] public var Object: DbType;
Description

A general type representing any reference or value type not explicitly represented by another TypeCode.

ToString

[C#] public const DbType SByte;

[C++] public: const DbType SByte;

[VB] Public Const SByte As DbType

[JScript] public var SByte: DbType;
Description

An integral type representing signed 8-bit integers with values between −128 and 127.

ToString

[C#] public const DbType Single;

[C++] public: const DbType Single;

[VB] Public Const Single As DbType

[JScript] public var Single: DbType;
Description

A floating point type representing values ranging from approximately 1.5×10 to 3.4×10 with a precision of 7 digits.

ToString

[C#] public const DbType String;

[C++] public: const DbType String;

[VB] Public Const String As DbType

[JScript] public var String: DbType;
Description

A sealed class type representing Unicode character strings.

ToString

[C#] public const DbType StringFixedLength;.

[C++] public: const DbType StringFixedLength;

[VB] Public Const StringFixedLength As DbType

[JScript] public var StringFixedLength: DbType;

ToString

[C#] public const DbType Time;

[C++] public: const DbType Time;

[VB] Public Const Time As DbType

[JScript] public var Time: DbType;
Description

Date and time data ranging in value from Jan. 1, 1753 to Dec. 31, 9999 to an accuracy of 3.33 milliseconds.

ToString

[C#] public const DbType UInt16;

[C++] public: constDbType UInt16;

[VB] Public Const UInt16 As DbType

[JScript] public var UInt16: DbType;
Description

An integral type representing unsigned 16-bit integers with values between 0 and 65535.

ToString

[C#] public const DbType UInt32;

[C++] public: const DbType UInt32;

[VB] Public Const UInt32 As DbType

[JScript] public var UInt32: DbType;
Description

An integral type representing unsigned 32-bit integers with values between 0 and 4294967295.

ToString

[C#] public const DbType UInt64;

[C++] public: const DbType UInt64;

[VB] Public Const UInt64 As DbType

[JScript] public var UInt64: DbType;
Description

An integral type representing unsigned 64-bit integers with values between 0 and 18446744073709551615.

ToString

[C+] public const DbType VarNumeric;

[C++] public: const DbType VarNumeric;

[VB] Public Const VarNumeric As DbType

[JScript] public var VarNumeric: DbType;

DeletedRowInaccessibleException class (System.Data)

ToString

Description

Represents the exception that is thrown when an action is attempted on a System.Data.DataRow that has been deleted.

To delete a System.Data.DataRow, use the System.Data.DataRow class's System.Data.DataRow.Delete method. Once you have deleted a row, any attempts to manipulate it will generate the System.Data.DeletedRowInaccessibleException.

DeletedRowInaccessibleException

Example Syntax:

ToString

[C#] public DeletedRowInaccessibleException( );

[C++] public: DeletedRowInaccessibleException( );

[VB] Public Sub New( )

[JScript] public function DeletedRowInaccessibleException( ); Initializes a new instance of the System.Data.DeletedRowInaccessibleException class.
Description

Initializes a new instance of the System.Data.DeletedRowInaccessibleException class.

Use the System.Data.DataRow class's System.Data.DataRow.RowState to determine if a row has been deleted.

[JScript] public function DeletedRowInaccessibleException(info: SerializationInfo, context: StreamingContext); Initializes a new instance of the System.Data.DeletedRowInaccessibleException class.
Description

Initializes a new instance of the System.Data.DeletedRowInaccessibleException class with serialization information. The data necessary to serialize or deserialize an object. Description of the source and destination of the specified serialized stream.

HelpLink

HResult

InnerException

Message

Source

StackTrace

TargetSite

DuplicateNameException class (System.Data)

ToString

Description

Represents the exception that is thrown when a duplicate database object name is encountered during an add operation in a System.Data.DataSet-related object.

Examples of duplicate database object names that may be encountered are tables, columns, relations, or constraints.

DuplicateNameException

Example Syntax:

ToString

[C#] public DuplicateNameException( );

[C++] public: DuplicateNameException( );

[VB] Public Sub New( )

[JScript] public function DuplicateNameException( );
Description

Initializes a new instance of the System.Data.DuplicateNameException class.

[JScript] public function DuplicateNameException(info: SerializationInfo, context: StreamingContext); Initializes a new instance of the System.Data.DuplicateNameException class.
Description

Initializes a new instance of the System.Data.DuplicateNameException class with serialization information. The data necessary to serialize or deserialize an object. Description of the source and destination of the specified serialized stream.

HelpLink

HResult

InnerException

Message

Source

StackTrace

TargetSite

EvaluateException class (System.Data)

ToString

Description

Represents the exception that is thrown when the System.Data.DataColumn.Expression property of a System.Data.DataColumn cannot be evaluated.

EvaluateException

Example Syntax:

ToString

[C#] public EvaluateException( );

[C++] public: EvaluateException( );

[VB] Public Sub New( )

[JScript] public function EvaluateException( ); Initializes a new instance of the System.Data.EvaluateException class.
Description

Initializes a new instance of the System.Data.EvaluateException class.

EvaluateException

Example Syntax:

ToString

[C#] publicEvaluateException(strings);

[C++] public: EvaluateException(String* s);

[VB] Public Sub New(ByVal s As String)

[JScript] public function EvaluateException(s: String);
Description

Initializes a new instance of the System.Data.EvaluateException class with the specified string. The string to display when the exception is thrown.

Initializes a new instance of the System.Data.EvaluateException class with the System.Runtime.Serialization.SerializationInfo and the System.Runtime.Serialization.StreamingContext. The data needed to serialize or deserialize an object. The source and destination of a given serialized stream.

HelpLink

HResult

InnerException

Message

Source

StackTrace

TargetSite

FillErrorEventArgs class (System.Data)

ToString

Description

Provides data for the System.Data.Common.DbDataAdapter.FillError event of a System.Data.Common.DbDataAdapter.

The data is used by the System.Data.Common.DbDataAdapter.OnFillError(System.Data.FillErrorEvent Args) method of the System.Data.Common.DbDataAdapter.

Represents the method that will handle the System.Data.Common.DbDataAdapter.FillError event. The source of the event. The System.Data.FillErrorEventArgs that contains the event data.

When you create a System.Data.FillErrorEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see.

ForeignKeyConstraint class (System.Data)

ToString

Description

Represents an action restriction enforced on a set of columns in a primary key/foreign key relationship when a value or row is either deleted or updated.

A System.Data.ForeignKeyConstraint restricts the action performed when a value in a column (or columns) is either deleted or updated. Such a constraint is intended to be used with primary key columns. In a parent/child relationship between two tables, deleting a value from the parent table can affect the child rows in one of the following ways.

[VB] Public Sub New(ByValparentColumn As DataColumn, ByVal childColumn As DataColumn)

[JScript] public function ForeignKeyConstraint(parentColumn: DataColumn, childColumn: DataColumn); Initializes a new instance of the System.Data.ForeignKeyConstraint class.
Description

Initializes a new instance of the System.Data.ForeignKeyConstraint class with the specified parent and child System.Data.DataColumn objects. The parent System.Data.DataColumn in the constraint. The child System.Data.DataColumn in the constraint.

Initializes a new instance of the System.Data.ForeignKeyConstraint class with the specified arrays ofparent and child System.Data.DataColumn objects. An array of parent System.Data.DataColumn in the constraint. An array of child System.Data.DataColumn in the constraint.

Initializes a new instance of the System.Data.ForeignKeyConstraint class with the specified name, parent and child System.Data.DataColumn,objects. The name of the constraint. The parent System.Data.DataColumn in the constraint. The child System.Data.DataColumn in the constraint.

Initializes a new instance of the System.Data.ForeignKeyConstraint class with the specified name, and arrays of parent and child System.Data.DataColumn objects. The name of the System.Data.ForeignKeyConstraint. If null or empty string, a default name will be given when added to the constraints collection. An array of parent System.Data.DataColumn in the constraint. An array of child System.Data.DataColumn in the constraint.

Initializes a new instance of the System.Data.ForeignKeyConstraint class with the specified name, and arrays of parent and child System.Data.DataColumn objects, the parent System.Data.DataTable name, and various rule settings. The name of the constraint. The names of the parent System.Data.DataTable that contains parent System.Data.DataColumn objects in the constraint. An array of the names of parent System.Data.DataColumn objects in the constraint. An array of the names of child System.Data.DataColumn objects in the constraint. One of the System.Data.AcceptRejectRule values. Possible values include None, Cascade, and Default. One of the System.Data.Rule values to use when a row is deleted. The default is Cascade. Possible values include: None, Cascade, SetNull, SetDefault, and Default. One of the System.Data.Rule values to use when a row is updated. The default is Cascade. Possible values include: None, Cascade, SetNull, SetDefault, and Default.

_DataSet

AcceptRejectRule

ToString

Description

Indicates the action that should take place across this constraint when System.Data.DataTable.AcceptChanges is invoked.

Changes to a System.Data.DataRow or System.Data.DataTable are not final until the AcceptChanges method is invoked. At that point, the System.Data.ForeignKeyConstraint.AcceptRejectRule determines the course of action on any values that have been changed or deleted.

Columns

ToString

[C#] public virtual DataColumn[ ] Columns {get:}

[C++] public: _propertv virtual DataColumn* get_Columns( );

[VB] Overridable Public ReadOnly Property Columns As DataColumn ( )

[JScript] public function get Columns( ): DataColumn[ ];
Description

Gets the child columns of this constraint.

ConstraintName

DeleteRule

ToString

Description

Gets or sets the action that occurs across this constraint when a row is deleted.

When a row is deletedfrom a parent table, the System.Data.ForeignKeyConstraint.DeleteRule determines what will happen in the columns of the child table (or tables). If the rule is set to Cascade, child rows will be deleted.

Gets a value indicating whether the current System.Data.ForeignKeyConstraint is identical to the specified object.

Return Value: true, if the objects are identical; otherwise, false. The object to which this System.Data.ForeignKeyConstraint is compared. Two System.Data.ForeignKeyConstraint are equal if they constrain the same columns.

GetHashCode

[C#] public override int GetHashCode( );

[C++] public: int GetHashCode( );

[VB] Overrides Public Function GetHashCode( ) As Integer

[JScript] public override function GetHashCode( ): int;
Description

Gets the hash code of this instance of the System.Data.ForeignKeyConstraint object.

Return Value: A 32-bit signed integer hash code.

IColumnMapping interface (System.Data)

ToString

Description

Associates a data source column with a System.Data.DataSet column, and is implemented by the System.Data.Common.DataColumnMapping class, which is used in common by .NET data providers.

The System.Data.IColumnMapping interface allows an inheriting class to implement a ColumnMapping class, which associates a data source column with a System.Data.DataSet column. For more information, see.

Gets the location of the System.Data.Common.DataColumnMapping with the specified source column name.

Return Value: The location of the System.Data.Common.DataColumnMapping with the specified case-sensitive source column name. The case-sensitive name of the source column.

RemoveAt

[C#] void RemoveAt(string sourceColumnName);

[C++] void RemoveAt(String* source ColumnName);

[VB] Sub RemoveAt(ByVal sourceColumnName As String)

[JScript] function RemoveAt(sourceColumnName: String);
Description

Removes the System.Data.Common.DataColumnMapping object with the specified source column name from the collection. The case-sensitive source column name.

IDataAdapter interface (System.Data)

RemoveAt

Description

Allows an object to implement a DataAdapter, and represents a set of methods and mapping action-related properties used to fill and refresh a System.Data.DataSet and update a data source.

The System.Data.IDataAdapter interface allows an inheriting class to is implement a DataAdapter class, which represents the bridge between a data source and a System.Data.DataSet. For more information about DataAdapter classes, see. For more information about implementing .NET data providers, see.

The System.Data.IDataAdapter uses only the mappings for the source table named “Table”. All SELECT, INSERT, DELETE, and UPDATE statements returning data must do so using consistent column naming. The column names returned in the records must be unique, otherwise columns with duplicate names overwrite previous data. On System.Data.IDataAdapter.Update(System.Data.DataSet), only the table mapped to the source table named “Table” will have its changes reconciled.

Fill

[C#] int Fill(DataSet dataSet);

[C++] int Fill(DataSet* dataSet);

[VB] Function Fill(ByVal dataSet As DataSet) As Integer

[JScript] function Fill(dataSet: DataSet): int;
Description

Adds or refreshes rows in the System.Data.DataSet to match those in the data source using the System.Data.DataSet name, and creates a System.Data.DataTable named “Table”.

Return Value: The number of rows successfully added to or refreshed in the System.Data.DataSet. This does not include rows affected by statements that do not return rows.

System.Data.IDataAdapter.Fill(System.Data.DataSet) retrieves rows from the data source using the SELECT statement specified by an associated System.Data.IDbDataAdapter.SelectCommand property. The connection object associated with the SELECT statement must be valid, but it does not need to be open. If the connection is closed before System.Data.IDataAdapter.Fill(System.Data.DataSet) is called, it is opened to retrieve data, then closed. If the connection is open before System.Data.IDataAdapter.Fill(System.Data.DataSet) is called, it remains open. A System.Data.DataSet to fill with records and, if necessary, schema.

The System.Data.IDataAdapter.FillSchema(System.Data.DataSet,System.Data.SchemaType) method retrieves the schema from the data source using the System.Data.IDbDataAdapter.SelectCommand. The connection object associated with the System.Data.IDbDataAdapter.SelectCommand must be valid, but it does not need to be open. If the connection is closed before System.Data.IDataAdapter.FillSchema(System.Data.DataSet,System.Data.SchemaType) is called, it is opened to retrieve data, then closed. If the connection is open before System.Data.IDataAdapter.FillSchema(System.Data.DataSet,System.Data.SchemaType) is called, it remains open. The System.Data.DataSet to be filled with the schema from the data source. One of the System.Data.SchemaType values.

Gets the parameters set by the user when executing an SQL SELECT statement.

Return Value: An array of System.Data.IDataParameter objects that contains the parameters set by the user.

Update

[C#] int Update(DataSet dataSet);

[C++] int Update(DataSet* dataSet);

[VB] Function Update(ByVal dataSet As DataSet) As Integer

[JScript] function Update(dataSet: DataSet): int;
Description

Calls the respective INSERT, UPDATE, or DELETE statem ents for each inserted, updated, or deleted row in the specified System.Data.DataSet from a System.Data.DataTable named “Table”.

Return Value: The number of rows successfully updated from the System.Data.DataSet.

When an application calls the System.Data.IDataAdapter.Update(System.Data.DataSet) method, the System.Data.IDataAdapter examines the System.Data.DataRow.RowState property, and executes the required INSERT, UPDATE, or DELETE statements based on the order of the indexes configured in the System.Data.DataSet. For example, System.Data.IDataAdapter.Update(System.Data.DataSet) might execute a DELETE statement, followed by an INSERT statement, and then another DELETE statement, due to the ordering of the rows in the System.Data.DataTable. An application can call the System.Data.DataSet.GetChanges method in situations where you must control the sequence of statement types (for example, INSERTs before UPDATEs). For more information, see. The System.Data.DataSet used to update the data source.

IDataParameter interface (System.Data)

Update

Description

Represents a parameter to a Command object, and optionally, its mapping to System.Data.DataSet columns; and is implemented by .NET data providers that access data sources.

The System.Data.IDataParameter interface allows an inheriting class to implement a Parameter class, which represents a parameter to a Command object. For more information about Parameter classes, see. For more information about implementing .NET data providers, see.

The PrvDbType (where Prv represents the provider-specific prefix) and System.Data.SqlClient.SqlParameter.DbType are linked. Therefore, setting the System.Data.SqlClient.SqlParameter.DbType changes the PrvDbType to a supporting PrvDbType.

Gets or sets the System.Data.DataRowVersion to use when loading System.Data.IDataParameter.Value.

This property is used by the System.Data.IDbDataAdapter.UpdateCommand during the System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) to determine whether the original or current value is used for a parameter value. This allows primary keys to be updated. This property is ignored by the System.Data.IDbDataAdapter.InsertCommand and System.Data.IDbDataAdapter.DeleteCommand. This property is set to the version of the System.Data.DataRow used by the System.Data.DataRow.Item(System.Int32) property, or the System.Data.DataRow.GetChildRows(System.String) method of the System.Data.DataRow object.

For input parameters, the value is bound to the System.Data.IDbCommand that is sent to the server. For output and return value parameters, the value is set on completion of the System.Data.IDbCommand and after the System.Data.IDataReader is closed.

IDataParameterCollection interface (System.Data)

Update

Description

Collects allparameters relevant to a Command object and their mappings to System.Data.DataSet columns, and is implemented by .NET data providers that access data sources.

The System.Data.IDataParameterCollection interface allows an inheriting class to implement a Parameter collection. For more information about Parameter classes, see. For more information about implementing .NET data providers, see.

Gets a value indicating whether a parameter in the collection has the specified source table name.

Return Value: true if the collection contains the parameter; otherwise, false. The name of the parameter.

IndexOf

[C#] int IndexOf(string parameterName);

[C++] int IndexOf(String* parameterName);

[VB] Function IndexOf(ByVal parameterName As String) As Integer

[JScript] function IndexOf(parameterName: String): int;
Description

Gets the location of the System.Data.IDataParameter within the collection.

Return Value: The location of the System.Data.IDataParameter within the collection. The name of the parameter.

RemoveAt

[C#] void RemoveAt(string parameterName);

[C++] void RemoveAt(String* parameterName);

[VB] Sub RemoveAt(ByVal parameterName As String)

[JScript] function RemoveAt(parameterName: String);
Description

Removes the System.Data.IDataParameter from the collection. The name of the parameter.

IDataReader interface (System.Data)

RemoveAt

Description

Provides a means of reading one or more forward-only streams of result sets obtained by executing a command at a data source, and is implemented by .NET data providers that access relational databases.

The System.Data.IDataReader and System.Data.IDataRecord interfaces allow an inheriting class to implement a DataReader class, which provides a means of reading one or more forward-only streams of result sets. For more information about DataReader classes, see. For more information about implementing .NETdata providers, see.

Depth

RemoveAt

[C#] int Depth {get;}

[C++] int get_Depth( );

[VB] ReadOnly Property Depth As Integer

[JScript] abstract function get Depth( ): int;
Description

Gets a value indicating the depth of nesting for the current row.

The outermost table has a depth of zero.

IsClosed

RemoveAt

[C#] bool IsClosed {get;}

[C++] bool get_IsClosed( );

[VB] ReadOnly Property IsClosed As Boolean

[JScript] abstract function get IsClosed( ): Boolean;
Description

Gets a value indicating whether the data reader is closed.

System.Data.IDataReader.IsClosed and System.Data.IDataReader.RecordsAffected are the only properties that you can call after the System.Data.IDataReader is closed.

RecordsAffected

RemoveAt

[C#] int RecordsAffected {get;}

[C++] int get_RecordsAffected( );

[VB] ReadOnly Property RecordsAffected As Integer

[JScript] abstract function get RecordsAffected( ): int;
Description

Gets the number of rows changed, inserted, or deleted by execution of the SQL statement.

The System.Data.IDataReader.RecordsAffected property is not set until all rows are read and you close the System.Data.IDataReader.

Close

[C#] void Close( );

[C++] void Close( );

[VB] Sub Close( )

[JScript] function Close( );
Description

Closes the System.Data.IDataReader Object.

You must explicitly call the System.Data.IDataReader.Close method when you are through using the System.Data.IDataReader to use the associated System.Data.IDbConnection for any other purpose.

GetSchemaTable

[C#] DataTable GetSchemaTable( );

[C++] DataTable* GetSchemaTable( );

[VB] Function GetSchemaTable( ) As DataTable

[JScript] function GetSchemaTable( ): DataTable;
Description

Returns a System.Data.DataTable that describes the column metadata of the System.DataIDataReader.

Return Value: A System.Data.DataTable that describes the column metadata.

The implementation of System.Data.IDataReader.GetSchemaTable methodfor the OLE DB .NET Data Provider maps to the OLE DB IColumnsRowset::GetColumnsRowset method, while the implementation for the SQL Server .NET Data Provider does not use an OLE DB provider layer.

NextResult

[C#] bool NextResult( );

[C++] bool NextResult( );

[VB] Function NextResult( ) As Boolean

[JScript] function NextResult( ): Boolean;
Description

Advances the data reader to the next result, when reading the results of batch SQL statements.

Return Value: true if there are more rows; otherwise, false.

Used to process multiple results, which can be obtained by executing batch SQL statements.

Read

[C#] bool Read( );

[C++] bool Read( );

[VB] Function Read( ) As Boolean

[JScript] function Read( ): Boolean;
Description

Advances the System.Data.IDataReader to the next record.

Return Value: true if there are more rows; otherwise, false.

The default position of the System.Data.IDataReader is prior to the first record. Therefore you must call System.Data.IDataReader.Read to begin accessing any data.

IDataRecord interface (System.Data)

Read

Description

Provides access to the column values within each row for a DataReader, and is implemented by .NET data providers that access relational databases.

The System.Data.IData.Reader and System.Data.IData.Record interfaces allow an inheriting class to implement a DataReader class, which provides a means of reading one or more forward-only streams of result sets. For more information about DataReader classes, see. For more information about implementing .NET data providers, see.

FieldCount

Read

[C#] int FieldCount {get;}

[C++] int get_FieldCount( );

[VB] ReadOnly Property FieldCount As Integer

[JScript] abstract function get FieldCount( ): int;
Description

Gets the number of columns in the current row.

After executing a query that does not return rows (for example, using the System.Data.IDbCommand.ExecuteNonQuery method), System.Data.IDataRecord.FieldCount returns −1.

Reads a stream of bytes from the field offset in the specifted field into the buffer starting at the given buffer offset.

Return Value: The actual number of bytes read.

The actual number of bytes read can be less than the requested length, if the end of the row is reached. If you pass a buffer that is null, System.Data.IDataRecord.GetBytes(System.Int32,System.Int64,System.Byte[ ], System.Int32,System.Int32) returns the length of the row in bytes. The zero-based column ordinal. The index within the field from which to begin the read operation. The buffer into which to read the stream of bytes. The index for buffer to begin the read operation. The number of bytes to read.

GetChar

[C#] char GetChar(int i);

[C++] _wchar_t GetChar(int i);

[VB] Function GetChar(ByVal i As Integer) As Char

[JScript] function GetChar(i: int): Char;
Description

Gets the character value of the specifted field.

Return Value: The character value of the specified field. The index of the field to find.

Reads a stream of characters from the field offset in the specified field into the buffer starting at the given buffer offset.

Return Value: The actual number of characters read.

The actual number of characters read can be less than the requested length, if the end of the field is reached. If you pass a buffer that is null, System.Data.IDataRecord.GetChars(System.Int32,System.Int64,System.Char[ ],System.Int32,System.Int32) returns the length of the field in characters. The zero-based column ordinal. The index within the row from which to begin the read operation. The buffer into which to read the stream of bytes. The index for buffer to begin the read operation. The number of bytes to read.

GetData

[C#] IDataReader GetData(int i);

[C++] IDataReader* GetData(int i);

[VB] Function GetData(ByVal i As Integer) As IDataReader

[JScript] function GetData(i: int): IDataReader;
Description

Gets an System.Data.IDataReader to be used when the field points to more remote structured data.

Return Value: An System.Data.IDataReader to be used when the field points to more remote structured data. The index of the field to find.

GetDataTypeName

[C#] string GetDataTypeName(int i);

[C++] String* GetDataTypeName(int i);

[VB] Function GetDataTypeName(ByVal i As Integer) As String

[JScript] function GetDataTypeName(i: int): String;
Description

Gets the data type information for the specified field.

Return Value: The data type information for the specified field.

The data type information can differ from the type information returned by GetFieldType, especially where the underlying data types do not map one for one to the runtime types supported by the language. (e.g. DataTypeName may be “integer”, while Type.Name may be “Int32”.) Returns the data type information for the specified field. The index of the field to find.

GetDateTime

[C#] DateTime GetDateTime(int i);

[C++] DateTime GetDateTime(int i);

[VB] Function GetDateTime(ByVal i As Integer) As DateTime

[JScript] function GetDateTime(i: int): DateTime;
Description

Gets the date and time data value of the spcified field.

Return Value: The date and time data value of the spcified field. The index of the field to find.

GetDecimal

[C#] decimal GetDecimal(int i);

[C++] Decimal GetDecimal(int i);

[VB] Function GetDecimal(ByVal i As Integer) As Decimal

[JScript] function GetDecimal(i: int): Decimal;
Description

Gets the fixed-position numeric value of the specified field.

Return Value: The fixed-position numeric value of the specified field. The index of the field to find.

GetDouble

[C#] double GetDouble(int i);

[C++] double GetDouble(int i);

[VB] Function GetDouble(ByVal i As Integer) As Double

[JScript] function GetDouble(i: int): double;
Description

Gets the double-precision floating point number of the specified field.

Return Value: The double-precision floating point number of the specified field. The index of the field to find.

GetFieldType

[C#] Type GetFieldType(int i);

[C++] Type* GetFieldType(int i);

[VB] Function GetFieldType(ByVal i As Integer) As Type

[JScript] function GetFieldType(i: int): Type;
Description

Gets the System.Type information corresponding to the type of System.Object that would be returned from System.Data.IDataRecord.GetValue(System.Int32) .

Return Value: The System.Type information corresponding to the type of System.Object that would be returned from System.Data.IDataRecord.GetValue(System.Int32)

This information can be used to increase performance by indicating the strongly-typed accessor to call. (e.g. using GetInt32 is roughly ten times faster than using GetValue.) Returns the System.Type information corresponding to the type of System.Object that would be returned from System.Data.IDataRecord.GetValue(System.Int32) . The index of the field to find.

GetFloat

[C#] float GetFloat(int i);

[C++] float GetFloat(int i);

[VB] Function GetFloat(ByVal i As Integer) As Single

[JScript] function GetFloat(i: int): float;
Description

Gets the single-precision floating point number of the specified field.

Return Value: The single-precision floating point number of the specified field. The index of the field to find.

GetGuid

[C#] Guid GetGuid(int i);

[C++] Guid GetGuid(int i);

[VB] Function GetGuid(ByVal i As Integer) As Guid

[JScript] function GetGuid(i: int): Guid;
Description

Returns the guid value of the specified field.

Return Value: The guid value of the specified field. The index of the field to find.

GetInt16

[C#] short GetInt16(int i);

[C++] short GetInt16(int i);

[VB] Function GetInt16(ByVal i As Integer) As Short

[JScript] function GetInt16(i: int): Int16,
Description

Gets the 16-bit signed integer value of the specified field.

Return Value: The 16-bit signed integer value of the specified field. The index of the field to find.

GetInt32

[C#] int GetInt32(int i);

[C++] int GetInt32(int i); is [VB] Function GetInt32(ByVal i As Integer) As Integer

[JScript] function GetInt32(i: int): int;
Description

Gets the 32-bit signed integer value of the specified field.

Return Value: The 32-bit signed integer value of the specified field. The index of the field to find.

GetInt64

[C#] long GetInt64(int i);

[C++] _int64 GetInt64(int i);

[VB] Function GetInt64(ByVal i As Integer) As Long

[JScript] function GetInt64(i: int): long;
Description

Gets the 64-bit signed integer value of the specified field.

Return Value: The 64-bit signed integer value of the specified field. The index of the field to find.

GetName

[C#] string GetName(int i);

[C++] String* GetName(int i);

[VB] Function GetName(ByVal i As Integer) As String

[JScript]function GetName(i: int): String;
Description

Gets the name for the field to find.

Return Value: The name of the field or the empty string (″″), if there is no value to return. The index of the field to find.

GetOrdinal

[C#] int GetOrdinal(string name);

[C++] int Getordinal(String* name);

[VB] Function GetOrdinal(ByVal name As String) As Integer

[JScript] function GetOrdinal(name: String): int;
Description

Return the index of the named field.

Return Value: The index of the named field. The name of the field to find.

GetString

[C#] string GetString(int i);

[C++] String* GetString(int i);

[VB] Function GetString(ByVal i As Integer) As String

[JScript] function GetString(i: int): String;
Description

Gets the string value of the specified field.

Return Value: The string value of the specified field. The index of the field to find.

GetValue

[C#] object GetValue(int i);

[C++] Object* GetValue(int i);

[VB] Function Get Value(ByVal i As Integer) As Object

[JScript] function GetValue(i: int): Object;
Description

Return the value of the specified field.

Return Value: The System.Object which will contain the field value upon return. The index of the field to find.

GetValues

[C#] int GetValues(object[ ] values);

[C++] int Get Values(Object* values _gc[ ]);

[VB] Function GetValues(ByVal values( ) As Object) As Integer

[JScript] function GetValues(values: Object[ ]): int;
Description

Gets all the attribute fields in the collection for the current record.

Return Value: The number of instances of System.Object in the array.

For most applications, the System.Data.IDataRecord.GetValues(System.Object[ ]) method provides an efficient means for retrieving all columns, rather than retrieving each column individually. An array of System.Object to copy the attribute fields into.

IsDBNull

[C#] bool IsDBNull(int i);

[C++] bool IsDBNull(int i);

[VB] Function IsDBNull(ByVal i As Integer) As Boolean

[JScript] function IsDBNull(i: int): Boolean;
Description

Return whether the specified field is set to null.

Return Value: true if the specified field is set to null, otherwise false The index of the field to find.

IDbCommand interface (System.Data)

IsDBNull

Description

Represents a SQL statement that is executed while connected to a data source, and is implemented by .NET data providers that access relational databases.

The System.Data.IDbCommand interface allows an inheriting class to implement a Command class, which represents a SQL statement that is executed at a data source. For more information about Command classes, see. For more information about implementing .NET data providers, see.

When the System.Data.IDbCommand.CommandType property is set to StoredProcedure, set the System.Data.IDbCommand.CommandText property to the name of the stored procedure. The command will call this stored procedure when you call one of the Execute methods.

Indicates or specifies how the System.Data.IDbCommand.CommandText property is interpreted.

When you set the System.Data.IDbCommand.CommandType property to StoredProcedure, you should set the System.Data.IDbCommand.CommandText property to the name of the stored procedure. The command executes this stored procedure when you call one of the Execute methods.

Gets or sets how command results are applied to the System.Data.DataRow when used by the System.Data.IDataAdapter.Update(System.Data.DataSet) method of a System.Data.Common.DbDataAdapter.

Cancel

[C#] void Cancel( );

[C++] void Cancel( );

[VB] Sub Cancel( )

[JScript] function Cancel( );
Description

Cancels the execution of an System.Data.IDbCommand.

CreateParameter

[C#] IDbDataParameter CreateParameter( );

[C++] IDbDataParameter* CreateParameter( );

[VB] Function CreateParameter( ) As IDbDataParameter

[JScript] function CreateParameter( ): IDbDataParameter;
Description

Creates a new instance ofan ADO .NET Parameter object.

Return Value: An ADO .NET Parameter object.

When inheriting from System.Data.IDbCommand, an ADO .NET data provider implements a strongly-typed version of System.Data.IDbCommand.CreateParameter.

ExecuteNonQuery

[C#] int ExecuteNonQuery( );

[C++] int ExecuteNonQuery( );

[VB] Function ExecuteNonQuery( ) As Integer

[JScript] function ExecuteNonQuery( ): int;
Description

Executes a SQL statement against the Connection object of an ADO .NET data provider, and returns the number of rows affected.

Return Value: The number of rows affected.

You can use the System.Data.IDbCommand.ExecuteNonQuery to perform catalog operations (for example, querying the structure of a database or creating database objects such as tables), or to change the data in a database without using a System.Data.DataSet by executing UPDATE, INSERT, or DELETE statements.

ExecuteReader

[C#] IDataReader ExecuteReader( );

[C++] IDataReader* ExecuteReader( );

[VB] Function ExecuteReader( ) As IDataReader

[JScript] function ExecuteReader( ): IDataReader; Executes the System.Data.IDbCommand.CommandText against the System.Data.IDbCommand.Connection and builds an System.Data.IDataReader.
Description

Executes the System.Data.IDbCommand.CommandText against the System.Data.IDbCommand. Connection and builds an System.Data.IDataReader.

Executes the System.Data.IDbCommand.CommandText against the System.Data.IDbCommand.Connection, and builds an System.Data.IDataReader using one of the System.Data.CommandBehavior values.

Return Value: An System.Data.IDataReader object.

The caller must call the System.Data.IDbConnection.Open method of the System.Data.IDbCommand.Connection property. One of the System.Data.CommandBehaviorvalues.

ExecuteScalar

[C#] object ExecuteScalar( );

[C++] Object* ExecuteScalar( );

[VB] Function ExecuteScalar( ) As Object

[JScript] function ExecuteScalar( ): Object;
Description

Executes the query, and returns the first column of the first row in the resultset returned by the query. Extra columns or rows are ignored.

Return Value: The first column of the first row in the resultset.

Use the System.Data.IDbCommand.ExecuteScalar method to retrieve a single value (for example, an aggregate value) from a database. This requires less code than using the System.Data.IDbCommand.ExecuteReader method, and then performing the operations necessary to generate the single value using the data returned by an System.Data.IDbDataReader.

Prepare

[C#] void Prepare( );

[C++] void Prepare( );

[VB] Sub Prepare( )

[JScript] function Prepare( );
Description

Creates a prepared (or compiled) version of the command on the data source.

If the System.Data.IDbCommand.CommandType property is set to TableDirect, System.Data.IDbCommand.Prepare does nothing. If System.Data.IDbCommand.CommandType is set to StoredProcedure, the call to System.Data.IDbCommand.Prepare should succeed, although it may result in a no-op.

IDbConnection interface (System.Data)

Prepare

Description

Represents an open connection to a data source, and is implemented by .NET data providers that access relational databases.

The System.Data.IDbConnection interface allows an inheriting class to implement a Connection class, which represents a unique session with a data source (for example, a network connection to a server). For more information about Connection classes, see. For more information about implementing .NET data providers, see.

Gets the time to wait while trying to establish a connection before terminating the attempt and generating an error.

A value of 0 indicates no limit, and should be avoided in a System.Data.Db Connection.ConnectionString because an attempt to connect will wait indefinitely.

Database

Prepare

[C#] string Database {get;}

[C++] String* get_Database( );

[VB] ReadOnly Property Database As String

[JScript] abstract function get Database( ): String,
Description

Gets the name of the current database or the database to be used once a connection is open.

The System.Data.OleDb.OleDbConnection.Database property updates dynamically. If you change the current database using a SQL statement or the System.Data.OleDb.OleDbConnection.ChangeDatabase(System.String) method, an informational message is sent and the property is updated automatically.

You must explicity commit or roll back the transaction using the System.Data.IDbTransaction.Commit or System.Data.IDbTransaction.Rollback method. To ensure that the SQL Server .NET Data Provider transaction management model performs correctly, avoid using other transaction management models, such as the one provided by SQL Server.

You must explicity commit or roll back the transaction using the System.Data.IDbTransaction.Commit or System.DataIDbTransaction.Rollback method. To ensure that the SQL Server .NET Data Provider transaction management model performs correctly, avoid using other transaction management models, such as the one provided by SQL Server. The isolation level under which the transaction should run.

ChangeDatabase

[C#] void ChangeDatabase(string databaseName);

[C++] void ChangeDatabase(String* databaseName);

[VB] Sub ChangeDatabase(ByVal databaseName As String)

[JScript] function ChangeDatabase(databaseName: String);
Description

Changes the current database for an open System.Data.IDbConnection. The database name.

Close

[C#] void Close( );

[C++] void Close( );

[VB] Sub Close( )

[JScript] function Close( );
Description

Closes the connection to the database.

The System.DataSqlClient.SqlConnection.Close method rolls back any pending transactions. It then releases the connection to the connection pool, or closes the connection if connection pooling is disabled.

CreateCommand

[C#] IDbCommand CreateCommand( );

[C++] IDbCommand* Create Command( );

[VB] Function CreateCommand( ) As IDbCommand

[JScript] function CreateCommand( ): IDbCommand;
Description

Creates and returns an System.DataIDbCommand object associated with the System.Data.IDbConnection.

Open

[C#] void Open( ),

[C++] void Open( );

[VB] Sub Open( )

[JScript] function Open( );
Description

Opens a database connection with the property settings specified by the System.Data.IDbConnection.ConnectionString.

When overridding System.Data.OleDb.OleDbConnection.Open in a derived class, opens a connection to the data source.

IDbDataAdapter interface (System.Data)

Open

Description

Represents a set of command-related properties that are used to fill the System.Data.DataSet and update a data source, and is implemented by .NET data providers that access relational databases.

The System.Data.IDbDataAdapter interface inherits from the System.Data.IDataAdapter interface and allows an object to create a Data,dapter designed for use with a relational database. The System.Data.IDbDataAdapter interface and, optionally, the utility class, System.Data.Common.DbDataAdapter, allow an inheriting class to implement a DataAdapter class, which represents the bridge between a data source and a System.Data.DataSet. For more information about DataAdapter classes, see. For more information about implementing .NET data providers, see.

During System.Data.Common.DbDataAdapter.Update(System.Data.DataSet), if this property is not set and primary key information is present in the System.Data.DataSet, the System.Data.IDbDataAdapter.DeleteCommand can be generated automatically ifyou set the SelectCommand property of a .NET data provider. Then, any additional SQL statements that you do not set are generated by the CommandBuilder. This generation logic requires key column information to be present in the System.Data.DataSet. For more information see.

Gets or sets an SQL statement used to insert new records into the data source.

During System.Data.Common.DbDataAdapter.Update(System.Data.DataSet), if this property is not set and primary key information is present in the System.Data.DataSet, the System.Data.IDbDataAdapter.InsertCommand can be generated automatically ifyou set the SelectCommand property of a .NET data provider. Then, any additional SQL statements that you do not set are generated by the CommandBuilder. This generation logic requires key column information to be present in the System.Data.DataSet. For more information see.

Gets or sets an SQL statement used to select records in the data source.

When System.Data.IDbDataAdapter.SelectCommand is assigned to a previously created System.Data.IDbCommand, the System.Data.IDbCommand is not cloned. The System.Data.IDbDataAdapter.SelectCommand maintains a reference to the previously created System.Data.IDbCommand object.

Gets or sets an SQL statement used to update records in the data source.

During System.Data.Common.DbDataAdapter.Update(System.Data.DataSet), if this property is not set and primary key information is present in the System.Data.DataSet, the System.Data.IDbDataAdapter.UpdateCommand can be generated automatically if you set the SelectCommand property of a .NET data provider. Then, any additional SQL statements that you do not set are generated by the CommandBuilder. This generation logic requires key column information to be present in the System.Data.DataSet. For more information see.

IDbDataParameter interface (System.Data)

Open

Precision

Open

Scale

Open

Size

Open

IDbTransaction interface (System.Data)

Open

Description

Represents a transaction to be performed at a data source, and is implemented by .NET data providers that access relational databases.

The System.Data.IDbTransaction interface allows an inheriting class to implement a Transaction class, which represents the transaction to be performed at a data source. For more information about Transaction classes, see. For more information about implementing .NET data providers, see.

[JScript] public function InRowChangingEventException(info: SerializationInfo, context: StreamingContext); Initializes a new instance of the System.Data.InRowChangingEventException class.
Description

Initializes a new instance of the System.Data.InRowChangingEventException class with serialization information. The data necessary to serialize or deserialize an object. Description of the source and destination of the specified serialized stream.

HelpLink

HResult

InnerException

Message

Source

StackTrace

TargetSite

InternalDataCollectionBase class (System.Data)

ToString

Description

Provides the base functionality for creating collections.

The System.BaseCollection class and its members are not intended for use as a stand alone component, but as the class from which other collection classes derive standard functionality.

InternalDataCollectionBase

Example Syntax:

ToString

[C#] public InternalDataCollectionBase( );

[C++] public: InternalDataCollectionBase( );

[VB] Public Sub New( )

[JScript] public function InternalDataCollectionBase( );

Count

ToString

[C#] public virtual int Count {get;}

[C++] public: _property virtual int get_Count( );

[VB] Overridable Public ReadOnly Property Count As Integer

[JScript] public function get Count( ): int;
Description

Gets the total number of elements in a collection.

The System.BaseCollection class and its members are not intended for use as a stand alone component, but as the class from which other collection classes derive standard functionality.

IsReadOnly

ToString

[C#] public bool IsReadOnly {get;}

[C++] public: _property bool get_IsReadOnly( );

[VB] Public ReadOnly Property IsReadOnly As Boolean

[JScript] public function get IsReadOnly( ): Boolean;
Description

Gets a value indicating whether the System.Data.InternalDataCollectionBase is read-only.

The System.BaseCollection class and its members are not intended for use as a stand alone component, but as the class from which other collection classes derive standard functionality.

IsSynchronized

ToString

[C#] public bool IsSynchronized {get;}

[C++] public: _property bool get_IsSynchronized( );

[VB] Public ReadOnly Property IsSynchronized As Boolean

[JScript] public function get IsSynchronized( ): Boolean;
Description

Gets a value indicating whether the System.Data.InternalDataCollectionBase is synchonized.

The System.BaseCollection class and its members are not intended for use as a stand alone component, but as the class from which other collection classes derive standard functionality.

List

ToString

[C#] protected virtual ArrayList List {get;}

[C++] protected: _property virtual ArrayList* get_List( );

[VB] Overridable Protected ReadOnly Property List As ArrayList

[JScript] protected function get List( ): ArrayList;
Description

Gets the items of the collection as a list.

The System.BaseCollection class and its members are not intended for use as a stand alone component, but as the class from which other collection classes derive standard functionality.

SyncRoot

ToString

[C#] public object SyncRoot {get;}

[C++] public: _property Object* get_SyncRoot( );

[VB] Public ReadOnly Property SyncRoot As Object

[JScript] public function get SyncRoot( ): Object,
Description

Gets an object that can be used to synchronize the collection.

The System.BaseCollection class and its members are not intended for use as a stand alone component, but as the class from which other collection classes derive standard functionality.

Copies all the elements of the current System.Data.InternalDataCollectionBase to a one-dimensional System.Array, starting at the specified System.Data.InternalDataCollectionBase index.

This method can be overriden by a derived class. The one-dimensional System.Array to copy the current System.Data.InternalDataCollectionBase object's elements into. The destination System.Array index to start copying into.

GetEnumerator

[C#] public IEnumerator GetEnumerator( );

[C++] public: _sealed IEnumerator* GetEnumerator( );

[VB] NotOverridable Public Function GetEnumerator( ) As IEnumerator

[JScript] public function GetEnumerator( ): IEnumerator;
Description

Gets an System.Collections.IEnumerator for the collection.

Return Value: An System.Collections.IEnumerator for the collection.

The System.BaseCollection class and its members are not intended for use as a stand alone component, but as the class from which other collection classes derive standard functionality.

InvalidConstraintException class (System.Data)

ToString

Description

Represents the exception that is thrown when incorrectly attempting to create or access a relation.

The System.Data.InvalidConstraintException is thrown when incorrectly invoking the following methods while attempting to create or access a relation.

InvalidConstraintException

Example Syntax:

ToString

[C#] public InvalidConstraintException( );

[C++] public: InvalidConstraintException( );

[VB] Public Sub New( )

[JScript] public function InvalidConstraintException( );
Description

Initializes a new instance of the System.Data.InvalidConstraintException class.

[JScript] public function InvalidConstraintException(info: SerializationInfo, context: StreamingContext); Initializes a new instance of the System.Data.InvalidConstraintException class.
Description

Initializes a new instance of the System.Data.InvalidConstraintException class with serialization information. The data necessary to serialize or deserialize an object. Description of the source and destination of the specified serialized stream.

HelpLink

HResult

InnerException

Message

Source

StackTrace

TargetSite

InvalidExpressionException class (System.Data)

ToString

Description

Represents the exception that is thrown when attempting to add a System.Data.DataColumn containing an invalid System.Data.DataColumn.Expression to a System.Data.DataColumnCollection.

The System.Data.DataColumn.Expression property is use to calculate the value of a column, or create an aggregate column.

InvalidExpressionException

Example Syntax:

ToString

[C#] public InvalidExpressionException( );

[C++] public: InvalidExpressionException( );

[VB] Public Sub New( )

[JScript] public function InvalidExpressionException( ); Initializes a new instance of the System.Data.InvalidExpressionException class.
Description

Initializes a new instance of the System.Data.InvalidExpressionException class.

Initializes a new instance of the System.Data.InvalidExpressionException class with the System.Runtime.Serialization.SerializationInfo and the System.Runtime.Serialization.StreamingContext. The data needed to serialize or deserialize an object. The source and destination of a given serialized stream.

HelpLink

HResult

InnerException

Message

Source

StackTrace

TargetSite

IsolationLevel enumeration (System.Data)

ToString

Description

Specifies the transaction locking behavior for the connection.

The System.Data.IsolationLevel values are used by a .NET data provider when performing a transaction.

ToString

[C#] public const IsolationLevel Chaos;

[C++]public: const IsolationLevel Chaos;

[VB] Public Const Chaos As IsolationLevel

[JScript] public var Chaos: IsolationLevel;
Description

The pending changes from more highly isolated transactions cannot be overwritten.

ToString

[C#] pubic const IsolationLevel ReadCommitted;

[C++] public: const IsolationLevel ReadCommitted;

[VB] Public Const ReadCommitted As IsolationLevel

[JScript] public var ReadCommitted: IsolationLevel;
Description

Shared locks are held while the data is being read to avoid dirty reads, but the data can be changed before the end of the transaction, resulting in non-repeatable reads or phantom data.

ToString

[C#] public const IsolationLevel ReadUncommitted;

[C++] public: const IsolationLevel ReadUncommitted;

[VB] Public Const ReadUncommitted As IsolationLevel

[JScript] public var ReadUncommitted: IsolationLevel;
Description

A dirty read is possible, meaning that no shared locks are issued and no exclusive locks are honored.

ToString

[C#] public const IsolationLevel RepeatableRead;

[C++] public: const IsolationLevel RepeatableRead;

[VB] Public Const RepeatableRead As IsolationLevel

[JScript] public var RepeatableRead: IsolationLevel;
Description

Locks are placed on all data that is used in a query, preventing other users from updating the data. Prevents non-repeatable reads but phantom rows are still possible.

ToString

[C#] public const IsolationLevel Serializable;

[C++] public: const IsolationLevel Serializable;

[VB] Public Const Serializable As IsolationLevel

[JScript] public var Serializable: IsolationLevel;
Description

A range lock is palced on the System.Data.DataSet, preventing other users from updating or inserting rows into the dataset until the transaction is complete.

ToString

[C#] public const IsolationLevel Unspecified;

[C++] public: const IsolationLevel Unspecified;

[VB] Public Const Unspecified As IsolationLevel

[JScript] public var Unspecified: IsolationLevel;
Description

A different isolation level than the one specified is being used, but the level cannot be determined.

ITableMapping interface (System.Data)

ToString

Description

Associates a source table with a table in a System.Data.DataSet, and is implemented by the System.Data.Common.DataTableMapping class, which is used in common by .NET data providers.

The System.Data.ITableMapping interface allows an inheriting class to implement a TableMapping class, which associates a data source column with a System.Data.DataSet column. For more information, see.

Return Value: A reference to a System.Data.ITableMapping table mapping. The name of the System.Data.DataSet table within the collection.

IndexOf

[C#] int IndexOf(string sourceTableName);

[C++] int IndexOf(String* sourceTableName);

[VB] Function IndexOf(ByVal sourceTableName As String) As Integer

[JScript] function IndexOf(sourceTableName: String): int;
Description

Gets the location of the System.Data.ITableMapping object within the collection.

Return Value: The location of the System.Data.ITableMapping object within the collection. The case-sensitive name of the source table.

RemoveAt

[C#] void RemoveAt(string sourceTableName);

[C++] void RemoveAt(String* sourceTableName);

[VB] Sub RemoveAt(ByVal sourceTableName As String)

[JScript] function RemoveAt(sourceTableName: String);
Description

Removes the System.Data.ITableMapping object with the specified name from the collection. The case-sensitive name of the source table.

MappingType enumeration (System.Data)

RemoveAt

Description

Specifies how a System.Data.DataColumn is mapped.

The System.Data.MappingType enumeration is used when getting or setting the System.Data.DataColumn.ColumnMapping property of the System.Data.DataColumn. The property determines how a column's values will be written when the System.Data.DataSet.WriteXml(System.IO.Stream) method is called on a System.Data.DataSet to write the data and schema out as an XML document.

RemoveAt

[C#] public const MappingType Attribute;

[C++]public: const MappingType Attribute;

[VB] Public Const Attribute As MappingType

[JScript] public var Attribute: MappingType;
Description

The column is mapped to an XML attribute.

RemoveAt

[C#] public const MappingType Element,

[C++] public: const MappingType Element;

[VB] Public Const Element As MappingType

[JScript] public var Element: MappingType;
Description

The column is mapped to an XML element.

RemoveAt

[C#] public const MappingType Hidden;

[C++] public: const MappingType Hidden;

[VB] Public Const Hidden As MappingType

[JScript] public var Hidden: MappingType;
Description

The column is mapped to an internal structure.

RemoveAt

[C#] public const MappingType SimpleContent;

[C++] public: const MappingType SimpleContent;

[VB] Public Const SimpleContent As MappingType

[JScript] public var SimpleContent: MappingType;
Description

The column is mapped to an System.Xml.XmlText node.

MergeFailedEventArgs class (System.Data)

ToString

Description

Occurs when a target and source DataRow have the same primary key value, and the System.Data.DataSet.EnforceConstraints property is set to true.

Initializes a new instance of a System.Data.MergeFailedEventArgs class with the System.Data.DataTable name and a description of the merge conflict. The System.Data.DataTable name. A description of the merge conflict.

Conflict

ToString

[C#] public string Conflict {get;}

[C++] public: _property String* get_Conflict( );

[VB] Public ReadOnly Property Conflict As String

[JScript] public function get Conflict( ): String;
Description

Returns a description of the merge conflict.

Table

ToString

[C#] public DataTable Table {get;}

[C++] public: _property DataTable* get_Table( );

[VB] Public ReadOnly Property Table As DataTable

[JScript] public function get Table( ): DataTable;
Description

Returns the name of the System.Data.DataTable.

MergeFailedEventHandler delegate (System.Data)

ToString

Description

Represents the method that will handle the System.Data.DataSet.MergeFailed event.

When you create a System.Data.MergeFailedEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see.

MissingMappingAction enumeration (System.Data)

ToString

Description

Determines the action that occurs when a mapping is missing from a source table or a source column.

The System.Data.MissingMappingAction values are used as arguments in the System.Data.Common.DataColumnMappingCollection. GetColumnMappingBySchemaAction(System.Data.Common.DataColumnMappingCollection,System.String,System.Data.MissingMappingAction) method, and the System.Data.Common.DataTableMappingCollection. GetTableMappingBySchemaAction(System.Data.Common.DataTableMappingCollection,System.String,System.String,System.Data. MissingMappingAction) method.

ToString

[C#] public const MissingMappingAction Error;

[C++] public: const MissingMappingAction Error;

[VB] Public Const Error As MissingMappingAction

[JScript] public var Error: MissingMappingAction;
Description

A System.SystemException is generated.

ToString

[C#] public const MissingMappingAction Ignore;

[C++] public: const MissingMappingAction Ignore;

[VB] Public Const Ignore As MissingMappingAction

[JScript] public var Ignore: MissingMappingAction;
Description

The column or table not having a mapping is ignored. Returns null.

ToString

[C#] public const MissingMappingAction Passthrough;

[C++] public: const MissingMappingAction Passthrough;

[VB] Public Const Passthrough As MissingMappingAction

[JScript] public var Passthrough: MissingMappingAction;
Description

The source column or source table created and added to the System.Data.DataSet using its original name.

MissingPrimaryKeyException class (System.Data)

ToString

Description

Represents the exception that is thrown when attempting to access a row in a table that has no primary key.

The System.Data.MissingPrimaryKeyException is thrown when invoking the following methods to access a row in a table that has no primary key.

MissingPrimaryKeyException

Example Syntax:

ToString

[C#] public MissingPrimaryKeyException( );

[C++] public: MissingPrimaryKeyException( );

[VB] Public Sub New( )

[JScript] public function MissingPrimaryKeyException( );
Description

Initializes a new instance of the System.Data.MissingPrimaryKeyException class.

[JScript] public function MissingPrimaryKeyException(info: SerializationInfo, context: StreamingContext); Initializes a new instance of the System.Data.MissingPrimaryKeyException class.
Description

Initializes a new instance of the System.Data.MissingPrimaryKeyException class with serialization information.

The data necessary to serialize or deserialize an object. A description of the source and destination of the specified serialized stream.

HelpLink

HResult

InnerException

Message

Source

StackTrace

TargetSite

MissingSchemaAction enumeration (System.Data)

ToString

Description

Specifies the action to take when adding data to the System.Data.DataSet and the required System.Data.DataTable or System.DataDataColumn is missing.

The System.Data.MissingSchemaAction values are used whenever an action is taken that could change the schema of the System.Data.DataSet.

ToString

[C#] public const MissingSchemaAction Add;

[C++] public: const MissingSchemaAction Add;

[VB] Public Const Add As MissingSchemaAction

[JScript] public var Add: MissingSchemaAction;
Description

Adds the necessary columns to complete the schema.

ToString

[C#] public const MissingSchemaAction AddWithKey;

[C++] public: const MissingSchemaAction AddWithKey;

[VB] Public Const AddWithKey As MissingSchemaAction

[JScript] public var AddWithKey: MissingSchemaAction;
Description

Adds the necessary columns and primary key information to complete the schema. For more information about how primary key information is added to a System.Data.DataTable, see System.DataIDataAdapter.FillSchema(System.Data.DataSet,System.Data.SchemaType). To function properly with the OLE DB .NET Data Provider, AddWithKey requires that the native OLE DB provider obtains necessary primary key information by setting the DBPROP_UNIQUEROWS property, and then determines which columns are primary key columns by examining DBCOLUMN_KEYCOLUMN in the IColumnsRowset. As an alternative, the user may explicitly set the primary key constraints on each System.Data.DataTable. This ensures that incoming records that match existing records are updated instead of appended. When using AddWithKey, the SQL Server .NET Data Provider appends a FOR BROWSE clause to the statement being executed. The user should be aware of potential side effects, such as interference with the use of SET FMTONLY ON statements. See SQL Server Books Online for more information.

ToString

[C#] public const MissingSchemaAction Error,

[C++] public: const MissingSchemaAction Error;

[VB] Public Const Error As MissingSchemaAction

[JScript] public var Error: MissingSchemaAction;
Description.

A System.SystemException is generated.

ToString

[C#] public const MissingSchemaAction Ignore;

[C++] public: const MissingSchemaAction Ignore;

[VB] Public Const Ignore As MissingSchemaAction

[JScript] public var Ignore: MissingSchemaAction;
Description

Ignores the extra columns.

NoNullAllowedException class (System.Data)

ToString

Description

Represents the exception that is thrown when attempting to insert a null value into a column where System.Data.DataColumn.AllowDBNull is set to false The System.Data.NoNullAllowedException is thrown when invoking the following methods or properties when attempting to insert a null value into a column where System.Data.DataColumn.AllowDBNull is set to false.

NoNullAllowedException

Example Syntax:

ToString

[C#] public NoNullAllowedException( );

[C++] public: NoNullAllowedException( );

[VB] Public Sub New( )

[JScript] public function NoNullAllowedException( );
Description

Initializes a new instance of the System.Data.NoNullAllowedException class.

[JScript] public function NoNullAllowedException(info: SerializationInfo, context: StreamingContext); Initializes a new instance of the System.Data.NoNullAllowedException class.
Description

Initializes a new instance of the System.Data.NoNullAllowedException class with serialization information. The data necessary to serialize or deserialize an object. Description of the source and destination of the specified serialized stream.

HelpLink

HResult

InnerException

Message

Source

StackTrace

TargetSite

ParameterDirection enumeration (System.Data)

ToString

Description

Specifies the type of a parameter within a query relative to the System.Data.DataSet.

The System.Data.ParameterDirection values are used by the parameter direction properties of System.Data.OleDb.OleDbParameter and System.Data.SqlClient.SqlParameter.

ToString

[C#] public const ParameterDirection Input;

[C++] public: const ParameterDirection Input;

[VB] Public Const Input As ParameterDirection

[JScript] public var Input: ParameterDirection;
Description

The parameter is an input parameter.

ToString

[C#] public const ParameterDirection InputOutput;

[C++] public: const ParameterDirection InputOutput;

[VB] Public Const InputOutput As ParameterDirection

[JScript] public var InputOutput: ParameterDirection;
Description

The parameter is capable of both input and output.

ToString

[C#] public const ParameterDirection Output;

[C++] public: const ParameterDirection Output;

[VB] Public Const Output As ParameterDirection

[JScript] public var Output: ParameterDirection;
Description

The parameter is an output parameter.

ToString

[C#] public const ParameterDirection ReturnValue;

[C++] public: const ParameterDirection ReturnValue;

[VB] Public Const ReturnValue As ParameterDirection

[JScript] public var ReturnValue: ParameterDirection;
Description

The parameter represents a return value from an operation such as a storedprocedure, built-in function, or user-defined function.

PropertyAttributes enumeration (System.Data)

ToString

Description

Specifies the attributes of a property.

ToString

[C] public const PropertyAttributes NotSupported;

[C++] public: const PropertyAttributes NotSupported;

[VB] Public Const NotSupported As PropertyAttributes

[JScript] public var NotSupported: PropertyAttributes;
Description

The property is not supported by the provider.

ToString

[C#] public const PropertyAttributes Optional;

[C++] public: const PropertyAttributes Optional;

[VB] Public Const Optional As PropertyAttributes

[JScript] public var Optional: PropertyAttributes;
Description

The user does not need to specify a value for this property before the data source is initialized.

ToString

[C#] public const PropertyAttributes Read;

[C++] public: const PropertyAttributes Read;

[VB] Public Const Read As PropertyAttributes

[JScript] public var Read: PropertyAttributes;
Description

The user can read the property.

ToString

[C#] public const PropertyAttributes Required;

[C++] public: const PropertyAttributes Required;

[VB] Public Const Required As PropertyAttributes

[JScript] public var Required: PropertyAttributes;
Description

The user must specify a value for this property before the data source is initialized.

ToString

[C#] public const PropertyAttributes Write;

[C++] public: const PropertyAttributes Write;

[VB] Public Const Write As PropertyAttributes

[JScript] public var Write: PropertyAttributes;
Description

The user can write to the property.

PropertyCollection class (System.Data)

ToString

Description

Represents a collection ofproperties that can be added to System.Data.DataColumn, System.Data.DataSet, or System.Data.DataTable.

The System.Data.PropertyCollection can be accessed through the ExtendedProperties property of the System.Data.DataColumn, System.Data.DataSet, or System.Data.DataTable class.

PropertyCollection

Example Syntax:

ToString

[C#] public PropertyCollection( );

[C++] public: PropertyCollection( );

[VB] Public Sub New( )

[JScript] public function PropertyCollection( );

comparer

Count

hcp

IsFixedSize

IsReadOnly

IsSynchronized

Item

Keys

SyncRoot

Values

ReadOnlyException class (System.Data)

ToString

Description

Represents the exception that is thrown when attempting to change the value of a read-only column.

The System.Data.RowNotInTableException is thrown when invoking the following methods or properties when attempting to change the value of a read-only column.

ReadOnlyException

Example Syntax:

ToString

[C#] public ReadonlyException( );

[C++] public: ReadOnlyException( );

[VB] Public Sub New( )

[JScript] public function ReadOnlyException( );
Description

Initializes a new instance of the System.Data.ReadOnlyException class.

ReadOnlyException

Example Syntax:

ToString

[C#] public ReadOnlyException(string s);

[C++] public: ReadOnlyException(String* s);

[VB] Public Sub New(ByVal s As String)

[JScript] public function ReadOnlyException(s: String);
Description

Initializes a new instance of the System.Data.ReadOnlyException class with the specified string. The string to display when the exception is thrown.

[JScript] public function ReadOnlyException(info: SerializationInfo, context: StreamingContext); Initializes a new instance of the System.Data.ReadOnlyException class.
Description

Initializes a new instance of the System.Data.ReadOnlyException class with serialization information. The data necessary to serialize or deserialize an object. Description of the source and destination of the specified serialized stream.

HelpLink

HResult

InnerException

Message

Source

StackTrace

TargetSite

RowNotInTableException class (System.Data)

ToString

Description

Represents the exception that is thrown when trying to perform an operation on a System.Data.DataRow that is not in a System.Data.DataTable. The System.Data.RowNotInTableException is thrown when invoking the following methods on a row that has been deleted with either the System.Data.DataRow.Delete or the System.Data.DataRowCollection.Remove(System.Data.DataRow) method.

RowNotInTableException

Example Syntax:

ToString

[C#]public RowNotInTableException( );

[C++] public: RowNotInTableException( );

[VB] Public Sub New( )

[JScript] public function RowNotInTableException( ); Initializes a new instance of the System.Data.RowNotInTableException class with no arguments.
Description

Initializes a new instance of the System.Data.RowNotInTableException class.

[JScript] public function RowNotInTableException(info: SerializationInfo, context: StreamingContext); Initializes a new instance of the System.Data.RowNotInTableException class.
Description

Initializes a new instance of the System.Data.RowNotInTablejxception

class with serialization information. The data necessary to serialize or deserialize an object. Description of the source and destination of the specified serialized stream.

HelpLink

HResult

InnerException

Message

Source

StackTrace

TargetSite

Rule enumeration (System.Data)

ToString

Description

Indicates the action that occurs when a System.Data.ForeignKeyConstraint is enforced.

The System.Data.Rule values are set to the System.Data.ForeignKeyConstraint.UpdateRule and the System.Data.ForeignKeyConstraint.DeleteRule properties of a System.Data.ForeignKeyConstraint object found in a System.Data.DataTable object's System.Data.ConstraintCollection.

ToString

[C#] public const Rule Cascade;

[C++] public: const Rule Cascade;

[VB] Public Const Cascade As Rule

[JScript] public var Cascade: Rule;
Description

Delete or update related rows. This is the default.

ToString

[C#] public const Rule None;

[C++] public: const Rule None;

[VB] Public Const None As Rule

[JScript] public var None: Rule;
Description

No action taken on related rows.

ToString

[C#] public const Rule SetDefault;

[C++] public: const Rule SetDefault;

[VB] Public Const SetDefault As Rule

[JScript] public var SetDefault: Rule;
Description

Set values in related rows to the value contained in the System.Data.DataColumn.DefaultValue property.

ToString

[C#] public const Rule SetNull;

[C++] public: const Rule SetNull;

[VB] Public Const SetNull As Rule

[JScript] public var SetNull: Rule;
Description

Set values in related rows to DBNull.

Schema Type enumeration (System.Data)

ToString

Description

Specifies how to handle existing schema mappings when performing a System.Data.Common.DataAdapter.FillSchema(System.Data.DataSet,System.Data.SchemaType) operation.

The System.Data.SchemaType usually should be set to Mapped, because any established table and column mappings are used.

ToString

[C#] public const Schema Type Mapped;

[C++] public: const Schema Type Mapped;

[VB] Public Const Mapped As SchemaType

[JScript] public var Mapped: SchemaType;
Description

Apply any existing table mappings to the incoming schema. Configure the System.Data.DataSet with the transformed schema.

ToString

[C#] public const SchemaType Source;

[C++] public: const Schema Type Source;

[VB] Public Const Source As SchemaType

[JScript] public var Source: SchemaType;
Description

Ignore any table mappings on the DataAdapter. Configure the System.Data.DataSet using the incoming schema without applying any transformations.

SqlDbType enumeration (System.Data)

ToString

Description

Specifies SQL Server data types.

ToString

[C#] public const SqlDbType BigInt;

[C++] public: const SqlDbType BigInt;

[VB] Public Const BigInt As SqlDbType

[JScript] public var BigInt: SqlDbType;
Description

System.Int64 A 64-bit signed integer.

ToString

[C#] public const SqlDbType Binary;

[C++] public: const SqlDbType Binary;

[VB] Public Const Binary As SqlDbType

[JScript] public var Binary: SqlDbType;
Description

System.Array of type System.Byte A fixed-length stream of binary data ranging between 1 and 8,000 bytes.

ToString

[C#] public const SqlDbType Bit;

[C++] public: const SqlDbType Bit;

[VB] Public Const Bit As SqlDbType

[JScript] public var Bit: SqlDbType;
Description

System.Boolean An unsigned numeric value that can be 0, 1, or null.

ToString

[C#] public const SqlDbType Char;

[C++] public: const SqlDbType Char;

[VB] Public Const Char As SqlDbType

[JScript] public var Char: SqlDbType;
Description

System.String A fixed-length stream of non-Unicode characters ranging between 1 and 8,000 characters.

ToString

[C#] public const SqlDbType DateTime;

[C++] public: const SqlDbType DateTime;

[VB] Public Const DateTime As SqlDbType

[JScript] public var DateTime: SqlDbType;
Description

System.DateTime Date and time data ranging in value from Jan. 1, 1753 to Dec. 31, 9999 to an accuracy of 3.33 milliseconds.

System.String A variable-length stream of non-Unicode characters ranging between 1 and 8,000 characters.

ToString

[C#] public const SqlDbType Variant;

[C++] public: const SqlDbType Variant;

[VB] Public Const Variant As SqlDbType

[JScript] public var Variant: SqlDbType;
Description

System.Object A special data type that can contain numeric, string, binary, or date data as well as the SQL Server values Empty and Null, which is assumed if no other type is declared.

StateChangeEventArgs class (System.Data)

ToString

Description

Provides data for the state change event of a .NET data provider.

The data is used by the System.Data.OleDb.OleDbConnection.StateChange property of the System.Data.OleDb.OleDbConnection and the System.Data.SqlClient.SqlConnection.StateChange property of the System.Data.SqlClientSqlConnection.

Initializes a new instance of the System.DataStateChangeEventArgs class, when given the original state and the current state of the object. One of the System.Data.ConnectionState values. One of the System.Data.ConnectionState values.

Represents the method that will handle the System.Data.OleDb.OleDbConnection.StateChange event. The source of the event. The System.Data.StateChangeEventArgs that contains the event data.

When you create a System.Data.StateChangeEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see.

StatementType enumeration (System.Data)

ToString

Description

Specifies the type of SQL query to be used by the System.Data.OleDb.OleDbRowUpdatedEventArgs, System.Data.OleDb.OleDbRowUpdatingEventArgs, System.Data.SqlClient.SqlRowUpdatedEventArgs, or System.Data.SqlClient.SqlRowUpdatingEventArgs class.

ToString

[C#] public const StatementType Delete;

[C++] public: const StatementType Delete;

[VB] Public Const Delete As StatementType

[JScript] public var Delete: StatementType;
Description

A SQL query that is a DELETE statement.

ToString

[C#] public const StatementType Insert;

[C++] public: const StatementType Insert;

[VB] Public Const Insert As StatementType

[JScript] public var Insert: StatementType;
Description

A SQL query that is an INSERT statement.

ToString

[C#] public const StatementType Select;

[C++] public: const StatementType Select;

[VB] Public Const Select As StatementType

[JScript] public var Select: StatementType;
Description

A SQL query that is a SELECT statement.

ToString

[C#] public const StatementType Update;

[C++] public: const StatementType Update;

[VB] Public Const Update As StatementType

[JScript] public var UpDate: StatementType;
Description

A SQL query that is an UPDATE statement.

StrongTypingException class (System.Data)

ToString

Description

The exception that is thrown by a strongly-typed System.Data.DataSet when the user accesses DBNull value.

The System.Data.StrongTypingException class is not intended for use as a stand alone component, but as a class from which other classes derive standard functionality.

StrongTypingException

Example Syntax:

ToString

[C#] public StrongTypingException( );

[C++] public: StrongTypingException( );

[VB] Public Sub New( )

[JScript] public function StrongTypingException( ); Initializes a new instance of the System.Data.StrongTypingException class.
Description

Initializes a new instance of the System.Data.StrongTypingException class.

The System.Data.StrongTypingException class is not intended for use as a stand alone component, but as a class from which other classes derive standard functionality.

Initializes a new instance of the System.Data.StrongTypingException class with the specified string and inner exception.

The System.Data.StrongTypingException class is not intended for use as a stand alone component, but as a class from which other classes derive standard functionality. The string to display when the exception is thrown. A reference to an inner exception.

HelpLink

HResult

InnerException

Message

Source

StackTrace

TargetSite

SyntaxErrorException class (System.Data)

ToString

Description

Represents the exception that is thrown when the System.Data.DataColumn.Expression property of a System.Data.DataColumn contains a syntax error.

SyntaxErrorException

Example Syntax:

ToString

[C#] public SyntaxErrorException( );

[C++] public: SyntaxErrorException( );

[VB] Public Sub New( )

[JScript] public function SyntaxErrorException( ); Initializes a new instance of the System.Data.SyntaxErrorException class.
Description

Initializes a new instance of the System.Data.SyntaxErrorException class.

Initializes a new instance of the System.Data.SyntaxErrorException class with the System.Runtime.Serialization.SerializationInfo and the System.Runtime.Serialization.StreamingContext. The data needed to serialize or deserialize an object. The source and destination of a given serialized stream.

HelpLink

HResult

InnerException

Message

Source

StackTrace

TargetSite

TypedDataSetGenerator class (System.Data)

ToString

Description

Used to create a strongly-typed System.Data.DataSet.

The System.Data.TypedDataSetGenerator class is not intended for use as a stand alone component, but as a class from which other classes derive standard functionality.

The System.Data.TypedDataSetGenerator class is not intended for use as a stand alone component, but as a class from which other classes derive standard functionality. The source System.Data.DataSet that specifies the metadata for the typed System.Data.DataSet. The CodeNamespace that provides the target Namespace for the typed System.Data.DataSet. The CodeGenerator used to create the typed System.Data.DataSet.

The System.Data.TypedDataSetGenerator class is not intended for use as a stand alone component, but as a class from which other classes derive standard functionality. The source name to transform into a valid typed System.Data.DataSet name. The CodeGenerator used to perform the conversion.

TypedDataSetGeneratorException class (System.Data)

ToString

Description

The exception that is thrown when a name conflict occurs while generating a strongly-typed System.Data.DataSet.

The System.Data.TypedDataSetGeneratorException class is not intended for use as a stand alone component, but as a class from which other classes derive standard functionality.

TypedDataSetGeneratorException

Example Syntax:

ToString

[C#] public TypedDataSetGeneratorException( );

[C++] public: TypedDataSetGeneratorException( );

[VB] Public Sub New( )

[JScript] public function TypedDataSetGeneratorException( ); Initializes a new instance of the System.Data.TypedDataSetGeneratorException class.
Description

Initializes a new instance of the System.Data.TypedDataSetGeneratorException class.

The System.Data.TypedDataSetGeneratorException class is not intended for use as a stand alone component, but as a class from which other classes derive standard functionality.

Initializes a new instance of the System.Data.TypedDataSetGeneratorException class.

The System.Data.TypedDataSetGeneratorException class is not intended for use as a stand alone component, but as a class from which other classes derive standard functionality. A dynamic list of exceptions.

Initializes a new instance of the System.Data.UniqueConstraint with the specified name and array of System.Data.DataColumn objects. The name of the constraint. The array of System.Data.DataColumn objects to constrain.

Initializes a new instance of the System.Data.UniqueConstraint with the specified name, an array of System.Data.DataColumn objects, and a value specifying whether the constraint is a primary key. The name of the constraint. An array containing names of System.Data.DataColumn objects to constrain.

_DataSet

Columns

ToString

Description.

Gets the array of columns that this constraint affects.

ConstraintName

ExtendedProperties

IsPrimaryKey

ToString

Description

Gets a value indicating whether or not the constraint is on a primary key.

A table usually includes a primary key that ensures every row is unique. In some tables, the primary key may be made up of more than one column. For example, a primary key for a table containing names might be made up of both the first and last names as well. To create a primary key with more than one column, set the Columns property to an array of DataColumn objects.

Table

ToString

[C#] public override DataTable Table {get;}

[C++] public: _property virtual DataTable* get_Table( );

[VB] Overrides Public ReadOnly Property Table As DataTable

[JScript] public function get Table( ): DataTable;
Description

Gets the table to which this constraint belongs.

Equals

[C#] public override bool Equals(object key2);

[C++] public: bool Equals(Object* key2);

[VB] Overrides Public Function Equals(ByVal key2 As Object) As Boolean

[JScript] public function VersionNotFoundException(info SerializationInfo, context: StreamingContext); Initializes a new instance of the System.Data.VersionNotFoundException class.
Description

Initializes a new instance of the System.Data.VersionNotFoundException class with serialization information. The data necessary to serialize or deserialize an object. Description of the source and destination of the specified serialized stream.

HelpLink

HResult

InnerException

Message

Source

StackTrace

TargetSite

XmlReadMode enumeration (System.Data)

ToString

Description

Specifies how to read XML data and a relational schema into a System.Data.DataSet.

Use the members of this enumeration when setting the ReadMode parameter of the System.Data.DataSet.ReadXml(System.Xml.XmlReader) method.

ToString

[C#] public const XmlReadMode Auto;

[C++] public: const XmlReadMode Auto;

[VB] Public Const Auto As XmlReadMode

[JScript] public var Auto: XmlReadMode;
Description

Default. Performs the most appropriate of these actions: If the data is a DiffGram, sets XmlReadMode to DiffGram.

ToString

[C#] public const XmlReadMode DiffGram;

[C++] public: const XmlReadMode DiffGram;

[VB] Public Const DiffGram As XmlReadMode

[JScript] public var DiffGram: XmlReadMode;
Description

Reads a DiffGram, applying changes from the DiffGram to the System.Data.DataSet. The semantics are identical to those of a System.Data.DataSet.Merge(System.Data.DataSet) operation. As with the System.Data.DataSet.Merge(System.Data.DataSet) operation, System.Data.DataRow.RowState values are preserved. Input to System.Data.DataSet.ReadXml(System.XmlXmlReader) with DiffGrams should only be obtained using the outputfrom System.Data.DataSet.WriteXml(System.IO.Stream) as a DiffGram.

ToString

[C#] public const XmlReadMode Fragment;

[C++] public: const XmlReadMode Fragment;

[VB] Public Const Fragment As XmlReadMode

[JScript] public var Fragment: XmlReadMode;
Description

Reads XML documents containing inline XDR schema fragments, such as those generated by executing FOR XML schemas that include inline XDR schemaagainst an instance of SQL Server. When System.Data.XmlReadMode is set to SqlXml, the default namespace is read as the inline schema.

ToString

[C#] public const XmlReadMode IgnoreSchema;

[C++] public: const XmlReadMode IgnoreSchema;

[VB] Public Const IgnoreSchema As XmlReadMode

[JScript] public var IgnoreSchema: XmlReadMode;
Description

Ignores any inline schema and reads data into the existing System.Data.DataSet schema. If any data does not match the existing schema, it is discarded (including data from differing namespaces defined for the System.Data.DataSet). If the data is a DiffGram, IgnoreSchema has the same functionality as DiffGram.

ToString

[C#] public const XmlReadMode InferSchema;

[C++] public: const XmIReadMode InferSchema;

[VB] Public Const InferSchema As XmlReadMode

[JScript] public var InferSchema: XmlReadMode;
Description

Ignores any inline schema, infering schema from the data, and loads the data. If the System.Data.DataSet already contains a schema, the current schema is extended by adding columns to existing tables, where they exist, and new tables where existing tables don't exist. An exception is thrown if a column already exists but has an incompatible mapping type property.

ToString

[C#] public constXmlReadModeReadSchema;

[C++] public: constXmlReadMode ReadSchema;

[VB] Public Const ReadSchema As XmlReadMode

[JScript] public var ReadSchema: XmlReadMode;
Description

Reads any inline schema and loads the data. If the System.Data.DataSet already contains schema, new tables may be added to the schema, but an exception is thrown if any tables in the inline schema already exist in the System.Data.DataSet.

XmlWriteMode enumeration (System.Data)

ToString

Description

Specifies how to write XML data and a relational schema from a System.Data.DataSet.

Use the members of this enumeration when setting the WriteMode parameter of the System.Data.DataSet.WriteXml(System.IO.Stream) method.

ToString

[C#] public constXmlWriteMode DiffGram;

[C++] public: const XmlWriteMode DiffGram;

[VB]) Public Const DiffGram As XmlWriteMode

[JScript] public var DifGram: XmlWriteMode;
Description

Writes the entire System.Data.DataSet as a DiffGram, including original and current values. To generate a DiffGram containing only changed values, call System.Data.DataSet.GetChanges, and then call System.Data.DataSet.WriteXml(System.IO.Stream) as a DiffGram on the returned System.Data.DataSet.

ToString

[C#] public const XmlWriteMode IgnoreSchema;

[C++] public: const XmlWriteMode IgnoreSchema;

[VB] Public Const IgnoreSchema As XmlWriteMode

[JScript] public var IgnoreSchema: XmlWriteMode;
Description

Writes the current contents of the System.Data.DataSet as XML data, without an XSD schema. If no data is loaded into the System.Data.DataSet,

Represents a set of data commands and a database connection that are used to fill the System.Data.DataSet and update the data source.

The System.Data.Common.DataAdapter serves as a bridge between a System.Data.DataSet and a data source for retrieving and saving data. The System.Data.Common.DataAdapter provides this bridge by mapping System.Data.Common.DataAdapter.Fill(System.Data.DataSet), which changes the data in the System.Data.DataSet to match the data in the data source, and System.Data.IDataAdapter.Update(System.Data.DataSet), which changes the data in the data source to match the data in the System.Data.DataSet.

Constructors:

DataAdapter

Example Syntax:

[C#] protected DataAdapter( );

[C++] protected: DataAdapter( );

[VB] Protected Sub New( )

[JScript] protected function DataAdapter( );
Description

Initializes a new instance of the System.Data.Common.DataAdapter class.

When an instance of System.Data.Common.DataAdapter is created, the following read/write properties are set to the following initial values.

Determines the action to take when existing System.Data.DataSet schema does not match incoming data.

Site

TableMappings

Description

Gets a collection that provides the master mapping between a source table and a System.Data.DataTable.

When reconciling changes, the System.Data.Common.DataAdapter uses the System.Data.Common.DataTableMappingCollection collection to associate the column names used by the data source with the column names used by the System.Data.DataSet.

All the commands, the System.Data.Common.DataAdapter.TableMappings, The System.Data.Common.DataAdapter.MissingSchemaAction, and the System.Data.Common.DataAdapter.MissingMappingAction are cloned. However, the connections for the commands are not copied, but shared. Thus, the cloned System.Data.Common.DataAdapter can be used against the same connection as the original.

Adds or refreshes rows in the System.Data.DataSet to match those in the data source using the System.Data.DataSet name, and creates a System.Data.DataTable named “Table”.

Return Value: The number of rows successfully added to or refreshed in the System.Data.DataSet. This does not include rows affected by statements that do not return rows.

The System.Data.Common.DataAdapter.Fill(System.Data.DataSet) method retrieves rows from the data source using the SELECT statement specified by an associated System.Data.IDbDataAdapter.SelectCommand property. The connection object associated with the SELECT statement must be valid, but it does not need to be open. If the connection is closed before System.Data.Common.DataAdapter.Fill(System.Data.DataSet) is called, it is opened to retrieve data, then closed. If the connection is open before System.Data.Common.DataAdapter.Fill(System.Data.DataSet) is called, it remains open. A System.Data.DataSet to fill with records and, if necessary, schema.

Adds a System.Data.DataTable named “Table” to the specified System.Data.DataSet and configures the schema to match that in the data source based on the specified System.Data.SchemaType

Return Value: An array of System.Data.DataTable objects that contain schema information returned from the data source.

The System.Data.Common.DataAdapter.FillSchema(System.Data.DataSet,System.Data.SchemaType) method retrieves the schema from the data source using the System.Data.IDbDataAdapter.SelectCommand. The connection object associated with the System.Data.IDbDataAdapter.SelectCommand must be valid, but it does not need to be open. If the connection is closed before System.Data.Common.DataAdapter.FillSchema(System.Data.DataSet,System.Data.SchemaType) is called, it is opened to retrieve data, then closed. If the connection is open before System.Data.Common.DataAdapter.FillSchema(System.Data.DataSet,System.Data.SchemaType) is called, it remains open. The System.Data.DataSet to be filled with the schema from the data source. One of the System.Data.SchemaType values.

Calls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the specified System.Data.DataSet from a System.Data.DataTable named “Table”.

Return Value: The number of rows successfully updated from the System.Data.DataSet.

When an application calls the System.Data.Common.DataAdapter.Update(System.Data.DataSet) method, the System.Data.Common.DataAdapter examines the System.Data.DataRow.RowState property, and executes the required INSERT, UPDATE, or DELETE statements based on the order of the indexes configured in the System.Data.DataSet. For example, System.Data.Common.DataAdapter.Update(System.Data.DataSet) might execute a DELETE statement, followed by an INSERT statement, and then another DELETE statement, due to the ordering of the rows in the System.Data.DataTable. An application can call the System.Data.DataSet.GetChanges method in situations where you must control the sequence of statement types (for example, INSERTs before UPDATEs). For more information, see. The System.Data.DataSet used to update the data source.

DataColumnMapping class (System.Data.Common)

Update

Description

Contains a generic column mapping for an object that inherits from System.Data.Common.DataAdapter. This class cannot be inherited.

A System.Data.Common.DataColumnMapping enables you to use column names in a System.Data.DataTable that are different from those in the data source. The DataAdapter uses the mapping to match the columns when the tables in the System.Data.DataSet or data source are updated. For more information, see.

DataColumnMapping

Example Syntax:

Update

[C#] public DataColumnMapping( );

[C++] public: DataColumnMapping( );

[VB] Public Sub New( )

[JScript] public function DataColumnMapping( ); Initializes a new instance of the System.Data.Common.DataColumnMapping class.
Description

Initializes a new instance of the System.Data.Common.DataColumnMapping class.

Initializes a new instance of the System.Data.Common.DataColumnMapping class when given a source column name and a System.Data.DataSet column name to map to. The case-sensitive column name from a data source. The column name, which is not case sensitive, from a System.Data.DataSet to map to.

Gets a System.Data.DataColumn from the given System.Data.DataTable using the System.Data.MissingSchemaAction and the System.Data.Common.DataColumnMapping.DataSetColumn property.

Return Value: A System.Data.DataColumn.

If the given dataType is not convertible to the System.Type of the System.Data.DataColumn, an exception is generated. The System.Data.DataTable to get the column from. The System.Type of the data column. One of the System.Data.MissingSchemaAction values.

ICloneable.Clone

[C#] object ICloneable.Clone( );

[C++] Object* ICloneable::Clone( );

[VB] Function Clone( ) As Object Implements ICloneable.Clone

[JScript] function ICloneable.Clone( ): Object;

ToString

[C#] public override string ToString( );

[C++] public: String* ToString( );

[VB] Overrides Public Function ToString( ) As String

[JScript] public override function ToString( ): String;
Description

Converts the current System.Data.Common.DataColumnMapping.SourceColumn name to a string.

Return Value: The current System.Data.Common.DataColumnMapping.SourceColumn name as a string.

DataColumnMappingCollection class (System.Data.Common)

ToString

Description

Contains a collection of System.Data.Common.DataColumnMapping objects. This class cannot be inherited.

Adds a column mapping to the collection when given a source column name and a System.Data.DataSet column name.

Return Value: The System.Data.Common.DataColumnMapping object added to the collection. The case-sensitive name of the source column to map to. The name, which is not case sensitive, of the System.Data.DataSet column to map to.

Gets a value indicating whether a System.Data.Common.DataColumnMapping object with the given value exists in the collection.

Return Value: true if collection contains a System.Data.Common.DataColumnMapping object with this source column name; otherwise, false. The case-sensitive source column name of the System.Data.Common.DataColumnMapping object.

Copies the elements of the System.Data.Common.DataColumnMappingCollection to the specified array. An System.Array to which to copy System.Data.Common.DataColumnMappingCollection elements. The starting index of the array.

GetByDataSetColumn

[C#] public DataColumnMapping GetByDataSetColumn(string value);

[C++] public: DataColumnMapping* GetByDataSetColumn(String* value);

[VB] Public Function GetByDataSetColumn(ByVal value As String) As DataColumnMapping

Gets a System.Data.Common.DataColumnMapping for the specified System.Data.Common.DataColumnMappingCollection, source column name, and System.Data.MissingMappingAction.

Return Value: A System.Data.Common.DataColumnMapping object.

If the System.Data.Common.DataColumnMapping exists in the collection, it is returned. the System.Data.Common.DataColumnMappingCollection. The case-sensitive source column name to find. One of the System.Data.MissingMappingAction values.

GetEnumerator

[C#] public IEnumerator GetEnumerator( );

[C++] public: _sealed IEnumerator* GetEnumerator( );

[VB] NotOverridable Public Function GetEnumerator( ) As IEnumerator

[JScript] public function GetEnumerator( ): IEnumerator;
Description

IndexOf

[C#] public int IndexOf(object value);

[C++] public: _sealed int IndexOf(Object* value);

[VB] NotOverridable Public Function IndexOf(ByVal value As Object) As Integer

[JScript] public function IndexOf(value: Object): int; Gets the location of the specified System.Data.Common.DataColumnMapping within the collection.
Description

Gets the location of the specified System.Object that is a System.Data.Common.DataColumnMapping within the collection.

Return Value: The location of the specified System.Object that is a System.Data.Common.DataColumnMapping within the collection. An System.Object that is the System.Data.Common.DataColumnMapping to find.

IndexOf

[C#] public int IndexOf(string sourceColumn);

[C++] public: _sealed int IndexOf(String* sourceColumnn);

[VB] NotOverridable Public Function IndexOf(ByVal sourceColumn As String) As Integer

Gets the location of the specified System.Data.Common.DataColumnMapping with the given System.Data.DataSet column name.

Return Value: The location of the specified System.Data.Common.DataColumnMapping with the given data set column name, or −1 if the System.Data.Common.DataColumnMapping object does not exist in the collection. The name, which is not case-sensitive, of the data set column to find.

Contains a description of a mapped relationship between a source table and a System.Data.DataTable. This class is used by a System.Data.Common.DataAdapter when populating a System.Data.DataSet.

A System.Data.Common.DataTableMapping provides a master mapping between the data returned from a query against a data source, and a System.Data.DataTable. The System.Data.Common.DataTableMapping name can be passed in place of the System.Data.DataTable name to the Fill method of the DataAdapter. For more information, see.

DataTableMapping

Example Syntax:

ToString

[C#] public DataTableMapping( );

[C++] public: DataTableMapping( );

[VB] Public Sub New( )

[JScript] public function DataTableMapping( ); Initializes a new instance of the System.Data.Common.DataTableMapping class.
Description

Initializes a new instance of the System.Data.Common.DataTableMapping class.

Initializes a new instance of the System.Data.Common.DataTableMapping class with a source when given a source table name and a System.Data.DataTable name. The case-sensitive source table name from a data source. The table name from a System.Data.DataSet to map to.

Initializes a new instance of the System.Data.Common.DataTableMapping class when given a source table name, a System.Data.DataTable name, and an array of System.Data.Common.DataColumnMapping objects. The case-sensitive source table name from a data source. The table name from a System.Data.DataSet to map to. An array of System.Data.Common.DataColumnMapping objects.

Gets the current System.Data.DataTable for the specified System.Data.DataSet using the specified System.Data.MissingSchemaAction value.

Return Value: A System.Data.DataTable.

If the System.Data.DataTable does not exist, the specified System.Data.MissingSchemaAction is taken. The System.Data.DataSet from which to get the System.Data.DataTable. One of the System.Data.MissingSchemaAction values.

ICloneable.Clone

[C#] object ICloneable.Clone( );

[C++] Object* ICloneable::Clone( );

[VB] Function Clone( ) As Object Implements ICloneable.Clone

[JScript] function ICloneable.Clone( ): Object;

ToString

[C#] public override string ToString( );

[C++] public: String* ToString( );

[VB] Overrides Public Function ToString( ) As String

[JScript] public override function ToString( ): String;
Description

Converts the current System.Data.Common.DataTableMapping.SourceTable name to a string.

Return Value: The current System.Data.Common.DataTableMapping.SourceTable name, as a string.

DataTableMappingCollection class (System.Data.Common)

ToString

Description

A collection of System.Data.Common.DataTableMapping objects. This class cannot be inherited.

Adds a table mapping to the collection when given a source table name and a System.Data.DataSet table name.

Return Value: The System.Data.Common.DataTableMapping object that was added to the collection. The case-sensitive name of the source table to map to. The name, which is not case-sensitive, of the System.Data.DataSet table to map to.

Copies the elements of the System.Data.Common.DataTableMappingCollection to the specified array. An System.Array to which to copy System.Data.Common.DataTableMappingCollection elements. The starting index of the array.

Gets a System.Data.Common.DataColumnMapping object with the given source table name and System.Data.DataSet table name, using the given System.Data.MissingMappingAction

Return Value: A System.Data.Common.DataTableMapping.

If the System.Data.Common.DataTableMapping exists in the collection, it is returned. The System.Data.Common.DataTableMappingCollection collection to search. The case-sensitive name of the source table to find. The name, which is not case-sensitive, to assign to the System.Data.DataSet table. One of the System.Data.MissingMappingAction values.

IndexOf

[C#] public int IndexOf(object value);

[C++] public: _sealed int IndexOf(Object* value);

[VB] NotOverridable Public Function IndexOf(ByVal value As Object) As Integer

[JScript] public function IndexOf(value: Object): int; Gets the location of the specified System.Data.Common.DataTableMapping object within the collection.
Description

Gets the location of the specified System.Object that is a System.Data.Common.DataTableMapping object within the collection.

Return Value: The location of the specified System.Object that is a System.Data.Common.DataTableMapping object within the collection. An System.Object that is the System.Data.Common.DataTableMapping object to find.

IndexOf

[C#] public int IndexOf(string sourceTable);

[C++] public: _sealed int IndexOf(String* sourceTable);

[VB] NotOverridable Public Function IndexOf(ByVal sourceTable As String) As Integer

Gets the location of the System.Data.Common.DataTableMapping object with the specified System.Data.DataSet table name.

Return Value: The location of the System.Data.Common.DataTableMapping object with the given System.Data.DataSet table name, or −1 if the System.Data.Common.DataTableMapping object does not exist in the collection. The name, which is not case-sensitive, of the data set table to find.

Aids implementation of the System.Data.IDbDataAdapter interface. Inheritors of System.Data.Common.DbDataAdapter implement a set of functions to provide strong typing, but inherit most of the functionality needed to fully implement a DataAdapter.

The System.Data.Common.DbDataAdapter class inherits from the System.Data.Common.DataAdapter class and helps a class implement a DataAdapter designed for use with a relational database.

ToString

[C#] public const string DefaultSourceTableName;

[C++] public: const String* DefaultSourceTableName;

[VB] Public Const DefaultSourceTableName As String

[JScript] public var DefaultSourceTableName: String;
Description

The default name used by the System.Data.Common.DataAdapter object for table mappings.

System.Data.Common.DbDataAdapter.DefaultSourceTableName is when an application adds a table mapping to be used with System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable), but does not specify a System.Data.DataTable name.

DbDataAdapter

Example Syntax:

ToString

[C#] protected DbDataAdapter( );

[C++] protected: DbDataAdapter( );

[VB] Protected Sub New( )

[JScript] protected function DbDataAdapter( );
Description

Initializes a new instance of the System.Data.Common.DbDataAdapter class.

When you create an instance of System.Data.Common.DbDataAdapter, the following read/write properties are set to the following initial values.

AcceptChangesDuringFill

Container

DesignMode

Events

MissingMappingAction

MissingSchemaAction

Site

TableMappings

ToString

Description

Returned when an error occurs during a fill operation.

The System.Data.Common.DbDataAdapter.FillError event allows a user to determine whether or not the fill operation should continue after the error occurs. Examples of when the System.Data.Common.DbDataAdapter.FillError event might occur are: The data being added to a System.Data.DataSet cannot be converted to a common language runtime type without losing precision.

Initializes a new instance of the System.Data.Common.RowUpdatedEventArgs class.

Return Value: A new instance of the System.Data.Common.RowUpdatedEventArgs class.

When overridding System.Data.Common.DbDataAdapter.CreateRowUpdatedEvent(System.Data.DataRow,System.Data.IDbCommand,System.Data.StatementType,System. Data.Common.DataTableMapping) in a derived class, be sure to call the base class's System.Data.Common.DbDataAdapter.CreateRowUpdatedEvent(System.Data.DataRow,System.Data.IDbCommand,System.Data.StatementType,System. Data.Common.DataTableMapping) method. The System.Data.DataRow used to update the data source. The System.Data.IDbCommand executed during the System.Data.IDataAdapter.Update(System.Data.DataSet). Whether the command is an UPDATE, INSERT, DELETE, or SELECT statement. A System.Data.Common.DataTableMapping object.

Initializes a new instance of the System.Data.Common.RowUpdatingEventArgs class.

Return Value: A new instance of the System.Data.Common.RowUpdatingEventArgs class.

When overridding System.Data.Common.DbDataAdapter.CreateRowUpdatingEvent(System.Data.DataRow,System.Data.lDbCommand,System.Data.StatementType,System. Data.Common.DataTableMapping) in a derived class, be sure to call the base class's System.Data.Common.DbDataAdapter.CreateRowUpdatingEvent(System.Data.DataRow,System.Data.IDbCommand,System.Data.StatementType,System. Data.Common.DataTableMapping) method. The System.Data.DataRow that updates the data source. The System.Data.IDbCommand to execute during the System.Data.IDataAdapter.Update(System.Data.DataSet). Whether the command is an UPDATE, INSERT, DELETE, or SELECT statement. A System.Data.Common.DataTableMapping object.

Fill

[C#] public override int Fill(DataSet dataSet);

[C++] public: int Fill(DataSet* dataSet);

[VB] Overrides Public Function Fill(ByVal dataSet As DataSet) As Integer

Adds or refreshes rows in the System.Data.DataSet to match those in the data source using the System.Data.DataSet name, and creates a System.Data.DataTable named “Table”.

Return Value: The number of rows successfully added to or refreshed in the System.Data.DataSet. This does not include rows affected by statements that do not return rows.

The System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) method retrieves the data from the data source using a SELECT statement. The System.Data.IDbConnection object associated with the select command must be valid, but it does not need to be open. If the System.Data.IDbConnection is closed before System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) is called, it is opened to retrieve data, then closed. If the connection is open before System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) is called, it remains open. A System.Data.DataSet to fill with records and, if necessary, schema.

Fill

[C#] public int Fill(DataTable dataTable);

[C++] public: int Fill(DataTable* dataTable);

[VB] Public Function Fill(ByVal dataTable As DataTable) As Integer

[JScript] public function Fill(dataTable: DataTable): int; Adds or refreshes rows in the System.Data.DataSet to match those in the data source.
Description

Adds or refreshes rows in a System.Data.DataTable to match those in the data source using the System.Data.DataTable name.

Return Value: The number of rows successfully added to or refreshed in the System.Data.DataTable. This does not include rows affected by statements that do not return rows.

The System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) method retrieves rows from the data source using the SELECT statement specified by an associated System.Data.IDbDataAdapter.SelectCommand property. The connection object associated with the SELECT statement must be valid, but it does not need to be open. If the connection is closed before System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) is called, it is opened to retrieve data, then closed. If the connection is open before System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) is called, it remains open. A System.Data.DataTable to fill with records and, if necessary, schema.

Fill

[C#] public int Fill(DataSet dataSet, string srcTable);

[C++] public: int Fill(DataSet* dataSet, String* srcTable);

[VB] Public Function Fill(ByVal dataSet As DataSet, ByVal srcTable As String) As Integer

Adds or refreshes rows in the System.Data.DataSet to match those in the data source using the System.Data.DataSet and System.Data.DataTable names.

Return Value: The number of rows successfully added to or refreshed in the System.Data.DataSet. This does not include rows affected by statements that do not return rows.

The System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) method retrieves the data from the data source using a SELECT statement. The System.Data.IDbConnection object associated with the select command must be valid, but it does not need to be open. If the System.Data.IDbConnection is closed before System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) is called, it is opened to retrieve data, then closed. If the connection is open before System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) is called, it remains open. A System.Data.DataSet to fill with records and, if necessary, schema. The name of the source table to use for table mapping.

Adds or refreshes rows in a System.Data.DataTable to match those in the data source using the specified System.Data.DataTable and System.Data.IDataReader names.

Return Value: The number of rows successfully added to or refreshed in the System.Data.DataTable. This does not include rows affected by statements that do not return rows.

The System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) method retrieves rows from the data source using the SELECT statement specified by an associated System.Data.IDbDataAdapter.SelectCommand property. The connection object associated with the SELECT statement must be valid, but it does not need to be open. If the connection is closed before System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) is called, it is opened to retrieve data, then closed. If the connection is open before System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) is called, it remains open. A System.Data.DataTable to fill with records and, if necessary, schema. The name of the System.Data.IDataReader.

Adds or refreshes rows in a System.Data.DataTable to match those in the data source using the System.Data.DataTable name, the specified SQL SELECT statement, and System.Data.CommandBehavior

Return Value: The number of rows successfully added to or refreshed in the System.Data.DataTable. This does not include rows affected by statements that do not return rows.

The System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) method retrieves rows from the data source using the SELECT statement specified by an associated System.Data.IDbDataAdapter.SelectCommand property. The connection object associated with the SELECT statement must be valid, but it does not need to be open. If the connection is closed before System.Data.Common.DbDataAdapter.Fill(System.Data.DataTabtle) is called, it is opened to retrieve data, then closed. If the connection is open before System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) is called, it remains open. A System.Data.DataTable to fill with records and, if necessary, schema. The SQL SELECT statement used to retrieve rows from the data source. One of the the System.Data.CommandBehavior values.

Adds or refreshes rows in a specified range in the System.Data.DataSet to match those in the data source using the System.Data.DataSet and System.Data.DataTable names.

Return Value: The number of rows successfully added to or refreshed in the System.Data.DataSet. This does not include rows affected by statements that do not return rows.

A maxRecords value of 0 gets all records found after the start record. If maxRecords is greater than the number of remaining rows, only the remaining rows are returned and no error is issued. A System.Data.DataSet to fill with records and, if necessary, schema. The zero-based record number to start with. The maximum number of records to retrieve. The name of the source table to use for table mapping.

Adds or refreshes rows in a specified range in the System.Data.DataSet to match those in the data source using the System.Data.DataSet, System.Data.DataTable, and System.Data.IDataReader names.

Return Value: The number of rows successfully added to or refreshed in the System.Data.DataSet. This does not include rows affected by statements that do not return rows.

The System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) method retrieves rows from the data source using the SELECT statement specified by an associated System.Data.IDbDataAdapter.SelectCommand property. The connection object associated with the SELECT statement must be valid, but it does not need to be open. If the connection is closed before System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) is called, it is opened to retrieve data, then closed. If the connection is open before System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) is called, it remains open. A System.Data.DataSet to fill with records and, if necessary, schema. The name of the System.Data.DataTable to use for table mapping. The name of the System.Data.IDataReader. The zero-based record number to start with. The maximum number of records to retrieve.

Adds or refreshes rows in a specified range in the System.Data.DataSet to match those in the data source using the System.Data.DataSet and source table names, command string and command behavior.

Return Value: The number of rows successfully added to or refreshed in the System.Data.DataSet. This does not include rows affected by statements that do not return rows.

The System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) method retrieves rows from the data source using the SELECT statement specified by an associated System.Data.IDbDataAdapter.SelectCommand property. The connection object associated with the SELECT statement must be valid, but it does not need to be open. If the connection is closed before Systemi.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) is called, it is opened to retrieve data, then closed. If the connection is open before System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) is called, it remains open. A System.Data.DataSet to fill with records and, if necessary, iischema. The zero-based record number to start with. The maximum number of records to retrieve. The name of the source table to use for table mapping. The SQL SELECT statement used to retrieve rows from the data source. One of the the System.Data.CommandBehavior values.

Adds a System.Data.DataTable named “Table” to the specified System.Data.DataSet and configures the schema to match that in the data source based on the specified System.Data.SchemaType.

Return Value: A reference to a collection of System.Data.DataTable objects that were added to the System.Data.DataSet.

This method retrieves the schema information from the data source using the System.Data.IDbDataAdapter.SelectCommand. A System.Data.DataSet to insert the schema in. One of the System.Data.SchemaType values that specify how to insert the schema.

[VB] Public Function FillSchema(ByVal dataTable As DataTable, ByVal schemaType As SchemaType) As DataTable

[JScript] public function FillSchema(dataTable: DataTable, schemaType: SchemaType): DataTable; Adds a System.Data.DataTable to a System.Data.DataSet and configures the schema to match that in the data source.
Description

Configures the schema of the specified System.Data.DataTable based on the specified System.Data.SchemaType.

Return Value: A System.Data.DataTable that contains schema information returned from the data source.

The System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType) method retrieves the schema from the data source using the System.Data.IDbDataAdapter.SelectCommand. The connection object associated with the System.Data.IDbDataAdapter.SelectCommand must be valid, but it does not need to be open. If the connection is closed before System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType) is called, it is opened to retrieve data, then closed. If the connection is open before System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType) is called, it remains open. The System.Data.DataTable to be filled with the schema from the data source. One of theSystem.Data.SchemaType values.

Adds a System.Data.DataTable to the specified System.Data.DataSet and configures the schema to match that in the data source based upon the specified System.Data.SchemaType and System.Data.DataTable.

Return Value: A reference to a collection of System.Data.DataTable objects that were added to the System.Data.DataSet.

This method retrieves the schema information from the data source using the System.Data.IDbDataAdapter.SelectCommand. A System.Data.DataSet to insert the schema in. One of the System.Data.SchemaType values that specify how to insert the schema. The name of the source table to use for table mapping.

Adds a System.Data.DataTable to a System.Data.DataSet and configures the schema to match that in the data source based on the specified System.Data.SchemaType.

Return Value: An array of System.Data.DataTable objects that contain schema information returned from the data source.

The System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType) method retrieves the schema from the data source using the System.Data.IDbDataAdapter.SelectCommand. The connection object associated with the System.Data.IDbDataAdapter.SelectCommand must be valid, but it does not need to be open. If the connection is closed before System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType) is called, it is opened to retrieve data, then closed. If the connection is open before System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType) is called, it remains open. The System.Data.DataTable to be filled with the schema from the data source. One of theSystem.Data.SchemaType values. The SQL SELECT statement used to retrieve rows from the data source. One of the the System.Data.CommandBehavior values.

Adds a System.Data.DataTable to the specified System.Data.DataSet and configures the schema to match that in the data source based on the specified System.Data.SchemaType.

Return Value: An array of System.Data.DataTable objects that contain schema information returned from the data source.

The System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType) method retrieves the schema from the data source using the System.Data.IDbDataAdapter.SelectCommand. The connection object associated with the System.Data.IDbDataAdapter.SelectCommand must be valid, but it does not need to be open. If the connection is closed before System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType) is called, it is opened to retrieve data, then closed. If the connection is open before System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType) is called, it remains open. The System.Data.DataSet to be filled with the schema from the data source. One of theSystem.Data.SchemaType values. The SQL SELECT statement used to retrieve rows from the data source. The name of the source table to use for table mapping. One of the the System.Data.CommandBehavior values.

Calls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the specified array of System.Data.DataRow objects.

Return Value: The number of rows successfully updated from the System.Data.DataSet.

When an application calls the System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) method, the System.Data.Common.DbDataAdapter examines the System.Data.DataRow.RowState property, and executes the required INSERT, UPDATE, or DELETE statements based on the order of the indexes configured in the System.Data.DataSet. For example, System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) might execute a DELETE statement, followed by an INSERT statement, and then it another DELETE statement, due to the ordering of the rows in the System.Data.DataTable. An application can call the System.Data.DataSet.GetChanges method in situations where you must control the sequence of statement types (for example, INSERTs before UPDATEs). For more information, see. An array of System.Data.DataRow objects used to update the data source.

Update

[C#] public override int Update(DataSet dataset);

[C++] public: int Update(DataSet* dataset);

[VB] Overrides Public Function Update(ByVal dataSet As DataSet) As Integer

[JScript] public override function Update(dataSet: DataSet): int; Calls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the System.Data.DataSet from a System.Data.DataTable named “Table”.
Description

Calls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the specified System.Data.DataSet.

Return Value: The number of rows successfully updated from the System.Data.DataSet.

When an application calls the System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) method, the System.Data.Common.DbDataAdapter examines the System.Data.DataRow.RowState property, and executes the required INSERT, UPDATE, or DELETE statements based on the order of the indexes configured in the System.Data.DataSet. For example, System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) might execute a DELETE statement, followed by an INSERT statement, and then another DELETE statement, due to the ordering of the rows in the System.Data.DataTable. An application can call the System.Data.DataSet.GetChanges method in situations where you must control the sequence of statement types (for example, INSERTs before UPDATEs). For more information, see. The System.Data.DataSet used to update the data source.

Calls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the specified System.Data.DataTable.

Return Value: The number of rows successfully updated from the System.Data.DataSet.

When an application calls the System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) method, the System.Data.Common.DbDataAdapter examines the System.Data.DataRow.RowState property, and executes the required INSERT, UPDATE, or DELETE statements based on the order of the indexes configured in the System.Data.DataSet. For example, System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) might execute a DELETE statement, followed by an INSERT statement, and then another DELETE statement, due to the ordering of the rows in the System.Data.DataTable An application can call the System.Data.DataSet.GetChanges method in situations where you must control the sequence of statement types (for example, INSERTs before UPDATEs). For more information, see. The System.Data.DataTable used to update the data source.

Calls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the specified array of System.Data.DataRow objects.

Return Value: The number of rows successfully updated from the System.Data.DataSet.

When an application calls the System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) method, the System.Data.Common.DbDataAdapter examines the System.Data.DataRow.RowState property, and executes the required INSERT, UPDATE, or DELETE statements based on the order of the indexes configured in the System.Data.DataSet. For example, System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) might execute a DELETE statement, followed by an INSERT statement, and then another DELETE statement, due to the ordering of the rows in the System.Data.DataTable. An application can call the System.Data.DataSet.GetChanges method in situations where you must control the sequence of statement types (for example, INSERTs before UPDATEs). For more information, see. An array of System.Data.DataRow objects used to update the data source. The System.Data.IDataAdapter.TableMappings collection to use.

Update

[C#] public int Update(DataSet dataSet, string srcTable);

[C++] public: int Update(DataSet* dataSet, String* srcTable);

[VB] Public Function Update(ByVal dataSet As DataSet, ByVal srcTable As String) As Integer

Calls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the System.Data.DataSet with the specified System.Data.DataTable name.

Return Value: The number of rows successfully updated from the System.Data.DataSet.

When an application calls the System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) method, the System.Data.Common.DbDataAdapter examines the System.Data.DataRow.RowState property, and executes the required INSERT, UPDATE, or DELETE statements based on the order of the indexes configured in the System.Data.DataSet. For example, System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) might execute a DELETE statement, followed by an INSERT statement, and then another DELETE statement, due to the ordering of the rows in the System.Data.DataTable. An application can call the System.Data.DataSet.GetChanges method in situations where you must control the sequence of statement types (for example, INSERTs before UPDATEs). For more information, see. The System.Data.DataSet to use to update the data source. The name of the source table to use for table mapping.

DBDataPermission class (System.Data.Common)

Update

Description

Provides the capability for a .NET data provider to ensure that a user has a security level adequate for accessing data.

Returns a new permission object representing the intersection of the current permission object and the specified permission object.

Return Value: A new permission object that represents the intersection of the current permission object and the specified permission object. This new permission object is a null reference (Nothing in Visual Basic) if the intersection is empty The target parameter is not a null reference (Nothing in Visual Basic) and is not an instance of the same class as the current permission object.

The intersection of two permissions is a permission that describes the set of operations they both describe in common. Only a demand that passes both original permissions will pass the intersection. A permission object to intersect with the current permission object. It must be of the same type as the current permission object.

IsSubsetOf

[C#] public override bool IsSubsetOf(IPermission target);

[C++] public: bool IsSubsetOf(IPermission* target);

[VB] Overrides Public Function IsSubsetOf(ByVal target As IPermission) As Boolean

Returns a value indicating whether the current permission object is a subset of the specified permission object.

Return Value: True if the current permission object is a subset of the specified permission object; otherwise false.

The current permission object is a subset of the specified permission object if the current permission object specifies a set of operations that is wholly contained by the specified permission object. For example, a permission that represents access to C:example.txt is a subset of a permission that represents access to C:. If this method returns true, the current permission object represents no more access to the protected resource than does the specified permission object. A permission object that is to be tested for the subset relationship. This object must be of the same type as the current permission object.

IsUnrestricted

[C#] public bool IsUnrestricted( );

[C++] public: _sealed bool IsUnrestricted( );

[VB] NotOverridable Public Function IsUnrestricted( ) As Boolean

[JScript] public function IsUnrestricted( ): Boolean;
Description

Returns a value indicating whether the permission can be represented as unrestricted without any knowledge of the permission semantics.

Return Value: True if the permission can be represented as unrestricted.

This is a binary permission; therefore the implementation always returns true.

Return Value: An XML encoding of the security object, including any state information.

Custom code that extends security objects needs to implement the System.Data.Common.DBDataPermission.ToXml and System.Data.Common.DBDataPermission.FromXml(System.Security.SecurityElement) methods to make the objects security-encodable.

Union

[C#] public override IPermission Union(IPermission target);

[C++] public: IPermission* Union(IPermission* target);

[VB] Overrides Public Function Union(ByVal target As IPermission) As IPermission

Returns a new permission object that is the union of the current and specified permission objects.

Return Value: A new permission object that represents the union of the current permission object and the specified permission object.

The result of a call to System.Data.Common.DBDataPermission.Union(System.Security.Permission) is a permission that represents all of the operations represented by both the current permission object and the specified permission object. Any demand that passes either permission passes their union. A permission object to combine with the current permission object. It must be of the same type as the current permission object.

Initializes a new instance of the System.Data.Common.DBDataPermissionAttribute class.

Return Value: A System.Data.Common.DBDataPermissionAttribute object. One of the the System.Security.Permissions.SecurityAction values representing an action that can be performed using declarative security.

Action

AllowBlankPassword

Union

Description

Gets a value indicating whether a blank password is allowed.

TypeId

Unrestricted

DbDataRecord class (System.Data.Common)

ToString

Description

FieldCount

ToString

[C#] public int FieldCount {get;}

[C++] public: _property int get_FieldCount( );

[VB] Public ReadOnly Property FieldCount As Integer

[JScript] public function get FieldCount( ): int;
Description

Indicates the number of fields within the current record. This property is read-only.

Item

ToString

[C#] public object this[string name] {get;}

[C++] public: _property Object* get_Item(String* name);

[VB] Public Default ReadOnly Property Item(ByVal name As String) As Object

[JScript] returnValue=DbDataRecordObject.Item(name);
Description

Indicates the value at the specified column in its native format given the column name. This property is read-only. The column name.

Item

ToString

[C#] public object this[int i] {get;}

[C++] public: _property Object* get_Item(int i);

[VB] Public Default ReadOnly Property Item(ByVal i As Integer) As Object

[JScript] returnValue=DbDataRecordObject.Item(i); Indicates that value from a column in its native format. This property is read-only.
Description

Indicates the value at the specified column in its native format given the column ordinal. This property is read-only. The column ordinal.

GetBoolean

[C#] public bool GetBoolean(int i);

[C++] public: _sealed bool GetBooleanl(int i);

[VB] NotOverridable Public Function GetBoolean(ByVal i As Integer) As Boolean

[JScript] public function GetBoolean(i: int): Boolean;
Description

Returns the value of the specified column as a boolean.

Return Value: true if the boolean is true; otherwise, false.

No conversions are performed, therefore the data retrieved must already be a boolean. The column ordinal.

GetByte

[C#] public byte GetByte(int i);

[C++] public: _sealed unsigned char GetByte(int i);

[VB] NotOverridable Public Function GetByte(ByVal i As Integer) As Byte

[JScript] public function GetByte(i: int): Byte;
Description

Returns the value of the specified column as a byte.

Return Value: The value of the specified column.

No conversions are performed, therefore the data retrieved must already be a byte. The column ordinal.

No conversions are performed, therefore the data retrieved must already be a byte array. column ordinal. point to start from within the source data. buffer to copy data into. point to start from within the buffer. max length to copy into the buffer.

GetChar

[C#] public char GetChar(int i);

[C++] public: _sealed _wchar_t GetChar(int i);

[VB] NotOverridable Public Function GetChar(ByVal i As Integer) As Char

[JScript] public function GetChar(i: int): Char;
Description

Returns the value of the specified column as a character.

Return Value: The value of the specified column.

No conversions are performed, therefore the data retrieved must already be a character. The column ordinal.

No conversions are performed, therefore the data retrieved must already be a character array. column ordinal. point to start from within the source data. buffer to copy data into. point to start from within the buffer. max length to copy into the buffer.

GetData

[C#] public IDataReader GetData(int i);

[C++] public: _sealed IDataReader* GetData(int i);

[VB] NotOverridable Public Function GetData(ByVal i As Integer) As IDataReader

[JScript] public function GetData(i: int): IDataReader;
Description

Not currently supported.

GetDataTypeName

[C#] public string GetDataTypeName(int i);

[C++] public: _sealed String* GetDataTypeName(int i);

[VB] NotOverridable Public Function GetDataTypeName(ByVal i As Integer) As String

Initializes a new instance of the System.Data.Common.RowUpdatedEventArgs class. The System.Data.DataRow sent through an System.Data.Common.DbDataAdapter.Update(System.Data.DataSet). The System.Data.IDbCommand executed when System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) is called. The type of SQL statement executed. The System.Data.Common.DataTableMapping sent through an System.Data.Common.DbDataAdapter.Update(System.Data.DataSet).

Command

ToString

[C#] public IDbCommand Command {get;}

[C++] public: _property IDbCommand* get_Command( );

[VB] Public ReadOnly Property Command As IDbCommand

[JScript] public function get Command( ): IDbCommand;
Description

Gets the System.Data.IDbCommand executed when System.Data.Common.DbDataAdapter.Update(System.Data.DataiSet) is called.

Initializes a new instance of the System.Data.Common.RowUpdatingEventArgs class. The System.Data.DataRow to System.Data.Common.DbDataAdapter.Update(System.Data.DataSet). The System.Data.IDbCommand to execute when System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) is called. The type of SQL statement to execute. The System.Data.Common.DataTableMapping to send through an System.Data.Common.DbDataAdapter.Update(System.Data.DataSet).

Represents a SQL statement or stored procedure to execute at a data source.

When an instance of System.Data.OleDb.OleDbCommand is created, the read/write properties are set to their initial values. For a list of these values, see the System.Data.OleDb.OleDbCommand constructor.

Constructors:

OleDbCommand

Example Syntax:

[C#] public OleDbCommand( );

[C++] public: OleDbCommand( );

[VB] Public Sub New( )

[JScript] public function OleDbCommand( ); Initializes a new instance of the System.Data.OleDb.OleDbCommand class.
Description

Initializes a new instance of the System.Data.OleDb.OleDbCommand class.

The following table shows initial property values for an instance of System.Data.OleDb.OleDbCommand.

OleDbCommand

Example Syntax:

[C#] public OleDbCommand(string cmdText);

[C++] public: OleDbCommand(String* cmdText);

[VB] Public Sub New(ByVal cmdText As String)

[JScript] public function OleDbCommand(cmdText: String);
Description

Initializes a new instance of the System.Data.OleDb.OleDbCommand class with the text of the query.

The following table shows initial property values for an instance of System.Data.OleDb.OleDbCommand. The text of the query.

Initializes a new instance of the System.Data.OleDb.OleDbCommand class with the text of the query and an System.Data.OleDb.OleDbConnection.

The following table shows initial property values for an instance of System.Data.OleDb.OleDbCommand. The text of the query. An System.Data.OleDb.OleDbConnection that represents the connection to a data source.

Initializes a new instance of the System.Data.OleDb.OleDbCommand class with the text of the query, an System.Data.OleDb.OleDbConnection, and the System.Data.OleDb.OleDbCommand.Transaction.

The following table shows initial property values for an instance of System.Data.OleDb.OleDbCommand. The text of the query. An System.Data.OleDb.OleDbConnection that represents the connection to a data source. The transaction in which the System.Data.OleDb.OleDbCommand executes.

Gets or sets the SQL statement or stored procedure to execute at the data source.

When the System.Data.IDbCommand.CommandType property is set to StoredProcedure, the System.Data.OleDb.OleDbCommand.CommnandText property should be set to the name of the stored procedure. The command executes this stored procedure when you call one of the Execute methods.

Gets or sets a value indicating how the System.Data.OleDb.OleDbCommand.CommandText property is interpreted.

When you set the System.Data.OleDb.OleDbCommand.CommandType property to StoredProcedure, you should set the System.Data.OleDb.OleDbCommand.CommandText property to the name of the stored procedure. The command executes this stored procedure when you call one of the Execute methods.

Gets or sets the System.Data.OleDb.OleDbConnection used by this instance of the System.Data.OleDb.OleDbCommand.

You cannot set the System.Data.OleDb.OleDbCommand.Connection, System.Data.OleDb.OleDbCommand.CommandType and System.Data.OleDb.OleDbCommand.CommandText properties if the current connection is performing an execute or fetch operation.

Container

DesignMode

DesignTimeVisible

Description

Gets or sets a value indicating whether the command object should be visible in a customized Windows Forms Designer control.

Events

Parameters

Description

Gets the System.Data.OleDb.OleDbParameterCollection

The OLE DB .NET Provider does not support named parameters for passing parameters to a SQL Statement or a stored procedure called by an System.Data.OleDb.OleDbCommand when System.Data.OleDb.OleDbCommand.CommandType is set to Text. In this case, the question mark (?) placeholder must be used. For example: SELECT* FROM Customers WHERE CustomerID=? As a result, the order in which System.Data.OleDb.OleDbParameter objects are added to the System.Data.OleDb.OleDbParameterCollection must directly correspond to the position of the question mark placeholder for the parameter.

Site

Transaction

Description

Gets or sets the transaction in which the System.Data.OleDb.OleDbCommand executes.

Releases the unmanaged resources used by the System.Data.OleDb.OleDbCommand and optionally releases the managed resources.

This method is called by the public method and the System.Object.Finalize method. true to release both managed and unmanaged resources; false to release only unmanaged resources.

ExecuteNonQuery

[C#] public int ExecuteNonQuery( );

[C++] public: _sealed int ExecuteNonQuery( );

[VB] NotOverridable Public Function ExecuteNonQuery( ) As Integer

[JScript] public function ExecuteNonQuery( ): int;
Description

Executes a SQL statement against the System.Data.OleDb.OleDbCommand.Connection and returns the number of rows affected.

Return Value: The number of rows affected.

You can use the System.Data.SqlClient.SqlCommand.ExecuteNonQuery to perform catalog operations (for example, querying the structure of a database or creating database objects such as tables), or to change the data in a database without using a System.Data.DataSet by executing UPDATE, INSERT, or DELETE statements.

ExecuteReader

[C#] public OleDbDataReader ExecuteReader( );

[C++] public: OleDbDataReader* ExecuteReader( );

[VB] Public Function ExecuteReader( ) As OleDbDataReader

[JScript] public function ExecuteReader( ): OleDbDataReader; Sends the System.Data.OleDb.OleDbCommand.CommandText to the System.Data.OleDb.OleDbCommand.Connection and builds an System.Data.OleDb.OleDbDataReader.
Description

Sends the System.Data.OleDb.OleDbCommand.CommandText to the System.Data.OleDb.OleDbCommand.Connection and builds an System.Data.OleDb.OleDbDataReader.

Return Value: An System.Data.OleDb.OleDbDataReader object.

When the System.Data.IDbCommand.CommandType property is set to StoredProcedure, the System.Data.OleDb.OleDbCommand.CommandText property should be set to the name of the stored procedure. The command executes this stored procedure when you call System.Data.OleDb.OleDbCommand.ExecuteReader.

Sends the System.Data.OleDb.OleDbCommand.CommandText to the System.Data.OleDb.OleDbCommand.Connection, and builds an System.Data.OleDb.OleDbDataReader using one of the System.Data.CommandBehavior values.

Return Value: An System.Data.OleDb.OleDbDataReader object.

When you specify System.Data.CommandBehavior.SingleRow with the System.Data.OleDb.OleDbCommand.ExecuteReader method of the System.Data.OleDb.OleDbCommand object, the OLE DB .NET Data Provider performs binding using the OLE DB IRow interface if it is available. Otherwise, it uses the IRowset interface. If your SQL statement is expected to return only a single row, specifying System.Data.CommandBehavior.SingleRow can also improve application performance. One of the System.Data.CommandBehaviorvalues.

ExecuteScalar

[C#] public object ExecuteScalar( );

[C++] public: _sealed Object* ExecuteScalar( );

[VB] NotOverridable Public Function ExecuteScalar( ) As Object

[JScript] public function ExecuteScalar( ): Object;
Description

Executes the query, and returns the first column of the first row in the resultset returned by the query. Extra columns or rows are ignored.

Return Value: The first column of the first row in the resultset.

Use the System.Data.OleDb.OleDbCommand.ExecuteScalar method to retrieve a single value (for example, an aggregate value) from a data source. This requires less code than using the System.Data.OleDb.OleDbCommand.ExecuteReader method, and then performing the operations necessary to generate the single value using the data returned by an System.Data.OleDb.OleDbDataReader.

Prepare

[C#] public void Prepare( );

[C++] public: _sealed void Prepare( );

[VB] NotOverridable Public Sub Prepare( )

[JScript] public function Prepare( );
Description

Creates a prepared (or compiled) version of the command on the data source.

If the System.Data.OleDb.OleDbCommand.CommandType property is set to TableDirect, System.Data.OleDb.OleDbCommand.Prepare does nothing. If System.Data.OleDb.OleDbCommand.CommandType is set to StoredProcedure, the call to System.Data.OleDb.OleDbCommand.Prepare should succeed, although it may result in a no-op.

ResetCommandTimeout

[C#] public void ResetCommandTimeout( );

[C++] public: void ResetCommandTimeout( );

[VB] Public Sub ResetCommandTimeout( )

[JScript] public function ResetCommandTimeout( );
Description

Resets the System.Data.OleDb.OleDbCommand.CommandTimeout property to the default value.

The default value of the System.Data.OleDb.OleDbCommand.CommandTimeout is 30 seconds.

Provides a means of automatically generating single-table commands used to reconcile changes made to a System.Data.DataSet with the associated database. This class cannot be inherited.

The System.Data.OleDb.OleDbDataAdapter does not automatically generate the SQL statements required to reconcile changes made to a System.Data.DataSet with the associated data source. However, you can create an System.Data.OleDb.OleDbCommandBuilder object to automatically generate SQL statements for single-table updates if you set the System.Data.OleDb.OleDbDataAdapter.SelectCommand property of the System.Data.OleDb.OleDbDataAdapter. Then, any additional SQL statements that you do not set are generated by the System.Data.OleDb.OleDbCommandBuilder.

OleDbCommandBuilder

Example Syntax:

ToString

[C#] public OleDbCommandBuilder( );

[C++] public: OleDbCommandBuilder( );

[VB] Public Sub New( )

[JScript] public function OleDbCommandBuilder( ); Initializes a new instance of the System.Data.OleDb.OleDbCommandBuilder class.
Description

Initializes a new instance of the System.Data.OleDb.OleDbCommandBuilder class.

Initializes a new instance of the System.Data.OleDb.OleDbCommandBuilder class with the associated System.Data.OleDb.OleDbDataAdapter object. An System.Data.OleDb.OleDbDataAdapter.

Container

DataAdapter

ToString

Description

Gets or sets an System.Data.OleDb.OleDbDataAdapter object for which SQL statements are automatically generated.

The System.Data.OleDb.OleDbCommandBuilder registers itself as a listener for System.Data.OleDb.OleDbDataAdapter.RowUpdating events generated by the System.Data.OleDb.OleDbDataAdapter.

DesignMode

Events

QuotePrefix

ToString

Description

Gets or sets the beginning character or characters to use when specifying database object names, (for example, tables or columns), that contain characters such as spaces.

Some data sources may have objects that can contain characters such as spaces, commas, and semicolons. To accommodate this capability, use the System.Data.OleDb.OleDbCommandBuilder.QuotePrefix and System.Data.OleDb.OleDbCommandBuilder.QuoteSuffix properties to specify delimiters such as a left bracket and a right bracket to encapsulate the object name.

Gets or sets the ending character or characters to use when specifying database object names, (for example, tables or columns), that contain characters such as spaces.

Some data sources may have objects that can contain characters such as spaces, commas, and semicolons. To accommodate this capability, use the System.Data.OleDb.OleDbCommandBuilder.QuotePrefix and System.Data.OleDb.OleDbCommandBuilder.QuoteSuffix properties to specify delimiters such as a left bracket and a right bracket to encapsulate the object name.

Gets the automatically generated SQL statement required to perform deletions at the data source when an application calls System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) on the System.Data.OleDb.OleDbDataAdapter.

Return Value: The text of the SQL statement to be executed.

An application can use the System.Data.OleDb.OleDbCommandBuilder.GetDeleteCommand method for informational or troubleshooting purposes because it returns the text of the statement to be executed.

Gets the automatically generated SQL statement required to perform inserts at the data source when an application calls System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) on the System.Data.OleDb.OleDbDataAdapter.

Return Value: The text of the SQL statement to be executed.

An application can use the System.Data.OleDb.OleDbCommandBuilder.GetInsertCommand method for informational or troubleshooting purposes because it returns the text of the statement to be executed.

Gets the automatically generated SQL statement required to perform updates at the data source when an application calls System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) on the System.Data.OleDb.OleDbDataAdapter.

Return Value: The text of the SQL statement to be executed.

An application can use the System.Data.OleDb.OleDbCommandBuilder.GetUpdateCommand method for informational or troubleshooting purposes because it returns the text of the statement to be executed.

RefreshSchema

[C#] public void RefreshSchema( );

[C++] public: void RefreshSchema( );

[VB] Public Sub RefreshSchema( )

[JScript] public function RefreshSchema( );
Description

Refreshes the database schema information used to generate INSERT, UPDATE, or DELETE statements.

An application should call System.Data.OleDb.OleDbCommandBuilder.RefreshSchema whenever the SELECT statement associated with the System.Data.OleDb.OleDbCommandBuilder changes.

OleDbConnection class (System.Data.OleDb)

ToString

Description

Represents an open connection to a data source.

An System.Data.OleDb.OleDbConnection object represents a unique connection to a data source. In the case of a client/server database system, it is equivalent to a network connection to the server. Depending on the functionality supported by the native OLE DB provider, some collections, methods, or properties of an System.Data.OleDb.OleDbConnection object may not be available.

OleDbConnection

Example Syntax:

ToString

[C#] public OleDbConnection( );

[C++] public: OleDbConnection( );

[VB] Public Sub New( )

[JScript] public function OleDbConnection( ); Initializes a new instance of the System.Data.OleDb.OleDbConnection class.
Description

Initializes a new instance of the System.Data.OleDb.OleDbConnection class.

When a new instance of System.Data.OleDb.OleDbConnection is created, the read/write properties are set to the following initial values unless they are specifically set using their associated keywords in the System.Data.SqlClient.SqlConnection.ConnectionString property.

Initializes a new instance of the System.Data.OleDb.OleDbConnection class with the specified connection string.

When a new instance of System.Data.OleDb.OleDbConnection is created, the read/write properties are set to the following initial values unless they are specifically set using their associated keywords in the System.Data.SqlClient.SqlConnection.ConnectionString property. The connection used to open the database.

The System.Data.OleDb.OleDbConnection.ConnectionString is designed to match OLE DB connection string format as closely as possble with the following exceptions: The “Provider=value” clause is required. However, you cannot use “Provider=MSDASQL” because the OLE DB .NET Data Provider does not support the OLE DB Provider for ODBC (MSDASQL).

ConnectionTimeout

ToString

[C#] public int ConnectionTimeout {get;}

[C++] public: _property int get_ConnectionTimeout( );

[VB] Public ReadOnly Property ConnectionTimeout As Integer

[JScript] public function get ConnectionTimeout( ): int;
Description

Gets the time to wait while trying to establish a connection before terminating the attempt and generating an error.

A value of 0 indicates no limit, and should be avoided in a System.Data.OleDb.OleDbConnection.ConnectionString because an attempt to connect will wait indefinitely.

Container

Database

ToString

Description

Gets the name of the current database or the database to be used once a connection is open.

The System.Data.OleDb.OleDbConnection.Database property updates dynamically. If you change the current database using a SQL statement or the System.Data.OleDb.OleDbConnection.ChangeDatabase(System.String) method, an informational message is sent and the property is updated automatically.

DataSource

ToString

[C#] public string DataSource {get;}

[C++] public: _property String* get_DataSource( );

[VB] Public ReadOnly Property DataSource As String

[JScript] public function get DataSource( ): String;
Description

Gets the location and file name of the data source.

DesignMode

Events

Provider

ToString

Description

Gets the name of the OLE DB provider.

ServerVersion

ToString

[C#] public string ServerVersion {get;}

[C++] public: _property String* get_ServerVersion( );

[VB] Public ReadOnly Property ServerVersion As String

[JScript] public function get ServerVersion( ): String;
Description

Gets a string containing the version of the of the server to which the client is connected.

The System.Data.OleDb.OleDbConnection.ServerVersion property maps to the OLE DB DBPROP_DBMSVER property. If System.Data.OleDb.OleDbConnection.ServerVersion is not supported by the underlying OLE DB provider, an empty string is returned.

Site

State

ToString

Description

Gets the current state of the connection.

The allowed state changes are: From Closed to Open, using the Open method of the connnection object.

ToString

Description

Occurs when the provider sends a warning or an informational message.

Clients that want to process warnings or informational messages sent by the server should create an System.Data.OleDb.OleDbInfoMessageEventHandler delegate to listen to this event.

ToString

[C#] public event StateChangeEventHandler StateChange;

[C++] public: _event StateChangEventHandler* StateChange;

[VB] Public Event StateChange As StateChangeEventHandler
Description

Occurs when the state of the connection changes.

The System.Data.OleDb.OleDbConnection.StateChange event fires whenever the System.Data.OleDb.OleDbConnection.State changes from closed to opened, or from opened to closed.

You must explicity commit or roll back the transaction using the System.Data.OleDb.OleDbTransaction.Commit or System.Data.OleDb.OleDbTransaction.Rollback method. To ensure that the OLE DB .NET Data Provider transaction management model performs correctly, avoid using other transaction management models, such as those provided by the data source.

Begins a database transaction with the current System.Data.IsolationLevel value.

Return Value: An object representing the new transaction.

You must explicity commit or roll back the transaction using the System.Data.OleDb.OleDbTransaction.Commit or System.Data.OleDb.OleDbTransaction.Rollback method. To ensure that the OLE DB .NET Data Provider transaction management model performs correctly, avoid using other transaction management models, such as those provided by the data source. The transaction isolation level for this connection.

ChangeDatabase

[C#] public void ChangeDatabase(string value);

[C++] public: _sealed void ChangeDatabase(String* value);

[VB] NotOverridable Public Sub ChangeDatabase(ByVal value As String)

[JScript] public function ChangeDatabase(value: String);
Description

Changes the current database for an open System.Data.OleDb.OleDbConnection.

The value supplied in the database parameter must be a valid database name. The database parameter cannot contain a null value, be empty, or contain a string with only blank characters. The database name.

Close

[C#] public void Close( );

[C++] public: _sealed void Close( );

[VB] NotOverridable Public Sub Close( )

[JScript] public function Close( );
Description

Closes the connection to the data source. This is the preferred method of closing any open connection.

The System.Data.OleDb.OleDbConnection.Close method rolls back any pending transactions. It then releases the connection to the connection pool, or closes the connection if connection pooling is disabled. If System.Data.OleDb.OleDbConnection.Close is called while handling a System.Data.OleDb.OleDbConnection.StateChange event, no additional System.Data.OleDb.OleDbConnection.StateChange events are fired.

CreateCommand

[C#] public OleDbCommand CreateCommand( );

[C++] public: OleDbCommand* CreateCommand( );

[VB] Public Function CreateCommand( ) As OleDbCommand

[JScript] public function CreateCommand( ): OleDbCommand;
Description

Creates and returns an System.Data.OleDb.OleDbCommand object associated with the System.Data.OleDb.OleDbConnection.

Returns the schema table and associated restriction columns of the specified schema.

Return Value: A System.Data.DataTable containing a list of schema restrictions.

The schema table is returned as a System.Data.DataTable that has the same format as the OLE DB schema rowset specified by the the schema parameter. Use the restrictions parameter to filter the rows to be returned in the System.Data.DataTable (for example, by specifying restrictions for tablename, type, owner, or schema). When you pass values in the array, include empty strings for array elements that do not contain values. If you pass an empty array to restrictions, all rows (one for each table) are returned in default order. Values in the array correspond to the order of the columns in the source table and System.Data.DataTable. One of the System.Data.OleDb.OleDbSchemaGuid values that specifies the schema table to return. An array of objects that are filter values, each of which corresponds to a System.Data.DataColumn in the resulting System.Data.DataTable.

Open

[C#] public void Open( );

[C++] public: _sealed void Open( );

[VB] NotOverridable Public Sub Open( )

[JScript] public function Open( );
Description

Opens a database connection with the property settings specified by the System.Data.OleDb.OleDbConnection.ConnectionString.

The System.Data.OleDb.OleDbConnection draws an open connection from the connection pool if one is available. Otherwise, it establishes a new connection to the data source.

ReleaseObjectPool

[C#] public static void ReleaseObjectPool( );

[C++] public: static void ReleaseObjectPool( );

[VB] Public Shared Sub ReleaseObjectPool( )

[JScript] public static function ReleaseObjectPool( );
Description

Indicates that the System.Data.OleDb.OleDbConnection object pooling can be cleared when the last underlying OLE DB Provider is released.

The object pool is cached whenever one of the underlying OLE DB providers is created. This method should be called when the user is done using any System.Data.OleDb.OleDbConnection objects.

Represents a set of data commands and a database connection which are used to fill the System.Data.DataSet and update the data source.

The System.Data.OleDb.OleDbDataAdapter serves as a bridge between a System.Data.DataSet and data source for retrieving and saving data. The System.Data.OleDb.OleDbDataAdapter provides this bridge by using System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable) to load data from the data source into the System.Data.DataSet, and using System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) to send changes made in the System.Data.DataSet back to the data source.

OleDbDataAdapter

Example Syntax:

ToString

[C#] public OleDbDataAdapter( );

[C++] public: OleDbDataAdapter( );

[VB] Public Sub New( )

[JScript] public function OleDbDataAdapter( ); Initializes a new instance of the System.Data.OleDb.OleDbDataAdapter class.
Description

Initializes a new instance of the System.Data.OleDb.OleDbDataAdapter class.

When you create an instance of System.Data.OleDb.OleDbDataAdapter, the following read/write properties are set to the following initial values.

Initializes a new instance of the System.Data.OleDb.OleDbDataAdapter class with the specified SQL SELECT statement.

When you create an instance of System.Data.OleDb.OleDbDataAdapter, the following read/write properties are set to the following initial values. An System.Data.OleDb.OleDbCommand that is a SQL SELECT statement.

Inintializes a new instance of the System.Data.OleDb.OleDbDataAdapter class with a System.Data.OleDb.OleDbDataAdapter.SelectCommand.

This implementation of the System.Data.OleDb.OleDbDataAdapter opens and closes a System.Data.OleDb.OleDbConnection if it is not already open. This can be useful in a an application that must call the System.Data.Common.DbDataAdapter.Fill(System.Data.DataTablle) method for two or more System.Data.OleDb.OleDbDataAdapter objects. If the System.Data.OleDb.OleDbConnection is already open, you must explicitly call System.Data.OleDb.OleDbConnection.Close or System.Data.OleDb.OleDbConnection.Dispose(System.Boolean) to close it. The System.Data.OleDb.OleDbDataAdapter.SelectCommand. An System.Data.OleDb.OleDbConnection that represents the connection.

Initializes a new instance of the System.Data.OleDb.OleDbDataAdapter class with a System.Data.OleDb.OleDbDataAdapter.SelectCommand.

When you create an instance of System.Data.OleDb.OleDbDataAdapter, the following read/write properties are set to the following initial values. The System.Data.OleDb.OleDbDataAdapter.SelectCommand. The connection string.

AcceptChangesDuringFill

Container

DeleteCommand

ToString

Description

Gets or sets an SQL statement or stored procedure for deleting records from the data set.

During System.Data.Common.DbDataAdapter.Update(System.Data.DataSet), if this property is not set and primary key information is present in the System.Data.DataSet, the System.Data.OleDb.OleDbDataAdapter.DeleteCommand can be generated automatically if you set the System.Data.OleDb.OleDbDataAdapter.SelectCommand property and use the System.Data.OleDb.OleDbCommandBuilder. Then, any additional commands that you do not set are generated by the System.Data.OleDb.OleDbCommandBuilder. This generation logic requires key column information to be present in the System.Data.DataSet. For more information see.

DesignMode

Events

InsertCommand

ToString

Description

Gets or sets an SQL statement or stored procedure used to insert new records into the data source.

During System.Data.Common.DbDataAdapter.Update(System.Data.DataSet), if this property is not set and primary key information is present in the System.Data.DataSet, the System.Data.OleDb.OleDbDataAdapter.InsertCommand can be generated automatically if you set the System.Data.OleDb.OleDbDataAdapter.SelectCommand property and use the System.Data.OleDb.OleDbCommandBuilder. Then, any additional commands that you do not set are generated by the System.Data.OleDb.OleDbCommandBuilder. This generation logic requires key column information to be present in the System.Data.DataSet. For more information see.

MissingMappingAction

MissingSchemaAction

SelectCommand

ToString

Description

Gets or sets an SQL statement or stored procedure used to select records in the data source.

When System.Data.OleDb.OleDbDataAdapter.SelectCommand is assigned to a previously created System.Data.OleDb.OleDbCommand, the System.Data.OleDb.OleDbCommand is not cloned. The System.Data.OleDb.OleDbDataAdapter.SelectCommand maintains a reference to the previously created System.Data.OleDb.OleDbCommand object.

site

TableMappings

UpdateCommand

ToString

Description

Gets or sets an SQL statement or stored procedure used to update records in the data source.

During System.Data.Common.DbDataAdapter.Update(System.Data.DataSet), if this property is not set and primary key information is present in the System.Data.DataSet, the System.Data.OleDb.OleDbDataAdapter.UpdateCommand can be generated automatically if you set the System.Data.OleDb.OleDbDataAdapter.SelectCommand property and use the System.Data.OleDb.OleDbCommandBuilder. Then, any additional commands that you do not set are generated by the System.Data.OleDb.OleDbCommandBuilder. This generation logic requires key column information to be present in the System.Data.DataSet. For more information see

ToString

Description

Occurs during System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) after a command is executed against the data source. The attempt to update is made, so the event fires.

When using System.Data.Common.DbDataAdapter.Update(System.Data.DataSet), there are two events that occur per data row updated. The order of execution is as follows: The values in the System.Data.DataRow are moved to the parameter values.

Occurs during System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) before a command is executed against the data source. The attempt to update is made, so the event fires.

When using System.Data.Common.DbDataAdapter.Update(System.Data.DataSet), there are two events that occur per data row updated. The order of execution is as follows: The values in the System.Data.DataRow are moved to the parameter values.

Releases the unmanaged resources used by the System.Data.OleDb.OleDbDataAdapter and optionally releases the managed resources.

This method is called by the public method and the System.Object.Finalize method. true to release both managed and unmanaged resources; false to release only unmanaged resources.

Fill

[C#] public it Fill(DataTable dataTable, object adodb);

[C++] public: int Fill(DataTable* dataTable, Object* adodb);

[VB] Public Function Fill(ByVal dataTable As DataTable, ByVal adodb As Object) As Integer

[JScript] public function Fill(dataTable: DataTable, adodb: Object): int; Adds or refreshes rows in the System.Data.DataSet to match those in an ADO Recordset or Record object.
Description

Adds or refreshes rows in a System.Data.DataTable to match those in an ADO Recordset or Record object using the specified System.Data.DataTable and ADO objects.

Return Value: The number of rows successfully refreshed to the System.Data.DataTable. This does not include rows affected by statements that do not return rows.

The link between ActiveX Data Objects (ADO) and ADO.NET is a one-way operation in that you can copy data from ADO to the System.Data.DataSet, but any updates to the data must be handled by ADO.NET. For more information, see. A System.Data.DataTable to fill with records and, if necessary, schema. An ADO Recordset or Record object.

Adds or refreshes rows in the System.Data.DataSet to match those in an ADO Recordset or Record object using the specified System.Data.DataSet, ADO object, and source table name.

Return Value: The number of rows successfully added to or refreshed in the System.Data.DataSet. This does not include rows affected by statements that do not return rows.

The link between ActiveX Data Objects (ADO) and ADO.NET is a one-way operation in that you can copy data from ADO to the System.Data.DataSet, but any updates to the data must be handled by ADO.NET. For more information, see. A System.Data.DataSet to fill with records and, if necessary, schema. An ADO Recordset or Record object. The source table used for the table mappings.

Raises the System.Data.OleDb.OleDbDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs) event using a System.Data.Common.RowUpdatingEventArgs object.

Raising an event invokes the event handler through a delegate. For an overview, see. A System.Data.Common.RowUpdatingEventArgs that contains the event data.

ICloneable.Clone

[C#] object ICloneable.Clone( );

[C++] Object* ICloneable::Clone( );

[VB] Function Clone( ) As Object Implements ICloneable.Clone

[JScript] function ICloneable.Clone( ): Object;

OleDbDataReader class (System.Data.OleDb)

Update

Description

Provides a way of reading a forward-only stream of data rows from a data source. This class cannot be inherited.

To create an System.Data.OleDb.OleDbDataReader, you must call the System.Data.OleDb.OleDbCommand.ExecuteReader method of the System.Data.OleDb.OleDbCommand object, rather than directly using a constructor.

Depth

Update

[C#] public int Depth {get;}

[C++] public: _property int get_Depth( );

[VB] Public ReadOnly Property Depth As Integer

[JScript] public function get Depth( ): int;
Description

Gets a value indicating the depth of nesting for the current row.

The outermost table has a depth of zero.

FieldCount

Update

[C#] public int FieldCount {get;}

[C++] public: _property int get_FieldCount( );

[VB] Public ReadOnly Property FieldCount As Integer

[JScript] public function get FieldCount( ): int;
Description

Gets the number of columns in the current row.

After executing a query that does not return rows (for example, using the System.Data.OleDb.OleDbCommand.ExecuteNonQuery method), System.Data.OleDb.OleDbDataReader.FieldCount returns −1.

IsClosed

Update

[C#] public bool IsClosed {get;}

[C++] public: _property bool get_IsClosed( );

[VB] Public ReadOnly Property IsClosed As Boolean

[JScript] public function get IsClosed( ): Boolean;
Description

Indicates whether the data reader is closed.

System.Data.OleDb.OleDbDataReader.IsClosed and System.Data.OleDb.OleDbDataReader.RecordsAffected are the only properties that you can call after the System.Data.OleDb.OleDbDataReader is closed.

Item

Update

[C#] public object this[string name] {get;}

[C++] public: _property Object* get_Item(String* name);

[VB] Public Default ReadOnly Property Item(ByVal name As String) As Object

[JScript] returnValue=OleDbDataReaderObject.Item(name);
Description

Gets the value of the specified column in its native format given the column name. The column name.

[JScript] returnValue=OleDbDataReaderObject.Item(index); Gets the value of a column in its native format.
Description

Gets the value of the specified column in its native format given the column ordinal. The column ordinal.

RecordsAffected

Update

[C#] public int RecordsAffected {get;}

[C++] public: _property int get_RecordsAffected( );

[VB] Public ReadOnly Property RecordsAffected As Integer

[JScript] public function get RecordsAffected( ): int;
Description

Gets the number of rows changed, inserted, or deleted by execution of the SQL statement.

The System.Data.OleDb.OleDbDataReader.RecordsAffected property is not set until all rows are read and you close the System.Data.OleDb.OleDbDataReader.

Close

[C#] public void Close( );

[C++] public: _sealed void Close( );

[VB] NotOverridable Public Sub Close( )

[JScript] public function Close( );
Description

Closes the System.Data.OleDb.OleDbDataReader object.

You must explicitly call the System.Data.OleDb.OleDbDataReader.Close method when you are through using the System.Data.OleDb.OleDbDataReader to use the associated System.Data.OleDb.OleDbConnection for any other purpose.

Finalize

[C#]˜OleDbDataReader( );

[C++]˜OleDbDataReader( );

[VB] Overrides Protected Sub Finalize( )

[JScript] protected override function Finalize( );
Description

Frees resources before the System.Data.OleDb.OleDbDataReader is reclaimed by the Garbage Collector.

GetBoolean

[C#] public bool GetBoolean(int ordinal);

[C++] public: _sealed bool GetBoolean(int ordinal);

[VB] NotOverridable Public Function GetBoolean(ByVal ordinal As Integer) As Boolean

Reads a stream of bytes from the offset specified column offset into the buffer as an array starting at the given buffer offset.

Return Value: The actual number of bytes read.

The actual number of bytes read can be less than the requested length, if the end of the row is reached. If you pass a buffer that is null, System.Data.OleDb.OleDbDataReader.GetBytes(System.Int32,System.Int64, System.Byte[ ],System.Int32,System.Int32) returns the length of the row in bytes. The zero-based column ordinal. The index within the field from which to begin the read operation. The buffer into which to read the stream of bytes. The index for buffer to begin the read operation. The number of bytes to read.

GetChar

[C#] public char GetChar(int ordinal);

[C++] public: _sealed _wchar_t GetChar(int ordinal);

[VB] NotOverridable Public Function GetChar(ByVal ordinal As Integer) As Char

[JScript] public function GetChar(ordinal: int): Char;
Description

Gets the value of the specified column as a character.

Return Value: The value of the specified column.

No conversions are performed, therefore the data retrieved must already be a character. The zero-based column ordinal.

Reads a stream of characters from the specified column offset into the buffer as an array starting at the given buffer offset.

Return Value: The actual number of characters read.

The actual number of characters read can be less than the requested length, if the end of the field is reached. If you pass a buffer that is null, System.Data.OleDb.OleDbDataReader.GetChars(System.Int32,System.Int64, System.Char[ ],System.Int32,System.Int32) returns the length of the field in characters. The zero-based column ordinal. The index within the row from which to begin the read operation. The buffer into which to copy data. The index for buffer to begin the read operation. The number of characters to read.

GetData

[C#] public OleDbDataReader GetData(int ordinal);

[C++] public: OleDbDataReader* GetData(int ordinal);

[VB] Public Function GetData(ByVal ordinal As Integer) As OleDbDataReader

Gets the value of the specified column as a double-precision floating point number.

Return Value: The value of the specified column.

No conversions are performed, therefore the data retrieved must already be a double-precision floating point number. The zero-based column ordinal.

GetFieldType

[C#] public Type GetFieldType(int index);

[C++] public: _sealed Type* GetFieldType(int index);

[VB] NotOverridable Public Function GetFieldType(ByVal index As Integer) As Type

[JScript] public function GetFieldType(index: int): Type;
Description

Gets the System.Type that is the data type of the object.

Return Value: The System.Type that is the data type of the object. The zero-based column ordinal.

GetFloat

[C#] public float GetFloat(int ordinal);

[C++] public: _sealed float GetFloat(int ordinal);

[VB] NotOverridable Public Function GetFloat(ByVal ordinal As Integer) As Single

[JScript] public function GetFloat(ordinal: int): float;
Description

Gets the value of the specified column as a single-precision floating point number.

Return Value: The value of the specified column.

No conversions are performed, therefore the data retrieved must already be a single-precision floating point number. The zero-based column ordinal.

GetGuid

[C#] public Guid GetGuid(int ordinal);

[C++] public: _sealed Guid GetGuid(int ordinal);

[VB] NotOverridable Public Function GetGuid(ByVal ordinal As Integer) As Guid

[JScript] public function GetGuid(ordinal: int): Guid;
Description

Gets the value of the specified column as a globally-unique identifier (GUID).

Return Value: The value of the specified column.

No conversions are performed, therefore the data retrieved must already be a globally-unique identifier. The zero-based column ordinal.

GetInt16

[C#] public short GetInt16 (int ordinal);

[C++] public: _sealed short GetInt16(int ordinal);

[VB] NotOverridable Public Function GetInt16(ByVal ordinal As Integer) As Short

[JScript] public function GetInt16(ordinal: int): Int16;
Description

Gets the value of the specified column as a 16-bit signed integer.

Return Value: The value of the specified column.

No conversions are performed, therefore the data retrieved must already be a 16-bit signed integer. The zero-based column ordinal.

GetInt32

[C#] public int GetInt32(int ordinal);

[C++] public: _sealed int GetInt32(int ordinal);

[VB] NotOverridable Public Function GetInt32(ByVal ordinal As Integer) As Integer

[JScript] public function GetInt32(ordinal: int): int;
Description

Gets the value of the specified column as a 32-bit signed integer.

Return Value: The value of the specified column.

No conversions are performed, therefore the data retrieved must already be a 32-bit signed integer. The zero-based column ordinal.

GetInt64

[C#] public long GetInt64(int ordinal);

[C++] public: _sealed _int64 GetInt64(int ordinal);

[VB] NotOverridable Public Function GetInt64(ByVal ordinal As Integer) As Long

[JScript] public function GetInt64(ordinal: int): long;
Description

Gets the value of the specified column as a 64-bit signed integer.

Return Value: The value of the specified column.

No conversions are performed, therefore the data retrieved must already be a 64-bit signed integer. The zero-based column ordinal.

GetName

[C#] public string GetName(int index);

[C++] public: _sealed String* GetName(int index);

[VB] NotOverridable Public Function GetName(ByVal index As Integer) As String

[JScript] public function GetName(index: int): String;
Description

Gets the name of the specified column.

Return Value: The name of the specified column. The zero-based column ordinal.

GetOrdinal

[C#] public int GetOrdinal(string name);

[C++] public: _sealed int GetOrdinal(String* name);

[VB] NotOverridable Public Function GetOrdinal(ByVal name As String) As Integer

[JScript] public function GetOrdinal(name: String): int;
Description

Gets the column ordinal, given the name of the column.

Return Value: The zero-based column ordinal. The name of the column.

GetSchemaTable

[C#] public DataTable GetSchemaTable( );

[C++] public: _sealed DataTable* GetSchemaTable( );

[VB] NotOverridable Public Function GetSchemaTable( ) As DataTable

[JScript] public function GetSchemaTable( ): DataTable;
Description

Returns a System.Data.DataTable that describes the column metadata of the System.Data.OleDb.OleDbDataReader.

Return Value: A System.Data.DataTable that describes the column metadata.

The System.Data.OleDb.OleDbDataReader.GetSchemaTable method maps to the OLE DB IColumnsRowset::GetColumnsRowset method, and returns metadata about each column in the following order: DataReader Column OLE DB Column ID Description ColumnName DBCOLUMN_NAME The name of the column; this might not be unique. If this cannot be determined, a null value is returned. This name always reflects the most recent renaming of the column in the current view or command text.

GetString

[C#] public string GetString(int ordinal);

[C++] public: _sealed String* GetString(int ordinal);

[VB] NotOverridable Public Function GetString(ByVal ordinal As Integer) As String

For most applications, the System.Data.OleDb.OleDbDataReader.GetValues(System.Object[ ]) method provides an efficient means for retrieving all columns, rather than retrieving each column individually. An array of System.Object into which to copy the attribute columns.

IsDBNull

[C#] public bool IsDBNull(int ordinal);

[C++] public: _sealed bool IsDBNull(int ordinal);

[VB] NotOverridable Public Function IsDBNull(ByVal ordinal As Integer) As Boolean

Collects information relevant to a warning or error returned by the data source. This class cannot be inherited.

This class is created by the OleDb data adapter when an error occurs. An instance of System.Data.OleDb.OleDbError is created and managed by the System.Data.OleDb.OleDbErrorCollection class, which in turn is created by the System.Data.OleDb.OleDbException class.

Message

ToString

[C#] public string Message {get;}

[C++] public: _property String* get_Message( );

[VB] Public ReadOnly Property Message As String

[JScript] public function get Message( ): String;
Description

Gets a short description of the error.

NativeError

ToString

[C#] public int NativeError {get;}

[C++] public: _property int get_NativeError( );

[VB] Public ReadOnly Property NativeError As Integer

[JScript] public function get NativeError( ): int;.
Description

Gets the database-specific error information.

Source

ToString

[C#] public string Source {get;}

[C++] public: _property String* get_Source( );

[VB] Public ReadOnly Property Source As String

[JScript] public function get Source( ): String;
Description

Gets the name of the provider that generated the error.

SQLState

ToString

[C#] public string SQLState {get;}

[C++] public: _property String* get_SQLState( );

[VB] Public ReadOnly Property SQLState As String

[JScript] public function get SQLState( ): String;
Description

Gets the five-character error code following the ANSI SQL standard for the database.

ToString

[C#] public override string ToString( );

[C++] public: String* ToString( );

[VB] Overrides Public Function ToString( ) As String

[JScript] public override function ToString( ): String;
Description

Gets the complete text of the error message.

Return Value: The complete text of the error.

The string is in the form “OleDbError:”, followed by the System.Data.OleDb.OleDbError.Message, and the stack trace. For example: OleDbError:UserId or Password not valid. The following example displays each System.Data.OleDb.OleDbError within the System.Data.OleDb.OleDbErrorCollection collection.

OleDbErrorCollection class (System.Data.OleDb)

ToString

Description

Collects all errors generated by the adapter. This class cannot be inherited.

This class is created by System.Data.OleDb.OleDbException to collect instances of the System.Data.OleDb.OleDbError class.

Copies the elements of the System.Data.OleDb.OleDbErrorCollection into an System.Array, starting at the given index within the System.Array. The System.Array into which to copy the elements. The starting index of the array.

GetEnumerator

[C#] public IEnumerator GetEnumerator( );

[C++] public: _sealed IEnumerator* GetEnumerator( );

[VB] NotOverridable Public Function GetEnumerator( ) As IEnumerator

[JScript] public function GetEnumerator( ): IEnumerator;
Description

OleDbException class (System.Data.OleDb)

ToString

Description

The exception that is thrown when a warning or error is returned by an OLE DB data source. This class cannot be inherited.

This class is created whenever the OleDb adapter encounters a situation that it cannot handle. It always contains at least one instance of System.Data.OleDb.OleDbError.

Represents the method that will handle the System.Data.OleDb.OleDbConnection.InfoMessage event of an System.Data.OleDb.OleDbConnection. The source of the event. An System.Data.OleDb.OleDbInfoMessageEventArgs object that contains the event data.

When you create an System.Data.OleDb.OleDbInfoMessageEventArgs delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see.

OleDbLiteral enumeration (System.Data.OleDb)

ToString

Description

Returns information about literals used in text commands, data values, and database objects.

The System.Data.OleDb.OleDbLiteral enumeration returns the following categories of literal information.

ToString

[C#] public const OleDbLiteral Binary_Literal;

[C++] public: const OleDbLiteral Binary_Literal;

[VB] Public Const Binary_Literal As OleDbLiteral

[JScript] public var Binary_Literal: OleDbLiteral;
Description

A binary literal in a text command.

ToString

[C#] public const OleDbLiteral Catalog_Name;

[C++] public: const OleDbLiteral Catalog_Name;

[VB] Public Const Catalog_Name As OleDbLiteral

[JScript] public var Catalog_Name: OleDbLiteral;
Description

A catalog name in a text command.

ToString

[C#] public const OleDbLiteral Catalog_Separator;

[C++] public: const OleDbLiteral Catalog_Separator;

[VB] Public Const Catalog_Separator As OleDbLiteral

[JScript] public var Catalog_Separator: OleDbLiteral;
Description

The character that separates the catalog name from the rest of the identifier in a text command.

ToString

[C#] public const OleDbLiteral Char_Literal;

[C++] public: const OleDbLiteral Char_Literal;

[VB] Public Const Char_Literal As OleDbLiteral

[JScript] public var Char_Literal: OleDbLiteral;
Description

A character literal in a text command.

ToString

[C#] public const OleDbLiteral Column_Alias;

[C++] public: const OleDbLiteral Column_Alias;

[VB] Public Const Column_Alias As OleDbLiteral

[JScript] public var Column_Alias: OleDbLiteral;
Description

A column alias in a text command.

ToString

[C#] public const OleDbLiteral Column_Name;

[C++] public: const OleDbLiteral Column_Name;

[VB] Public Const Column_Name As OleDbLiteral

[JScript] public var Column_Name: OleDbLiteral;
Description

A column name used in a text command or in a data-definition interface.

ToString

[C#] public const OleDbLiteral Correlation_Name;

[C++] public: const OleDbLiteral Correlation_Name;

[VB] Public Const Correlation_Name As OleDbLiteral

[JScript] public var Correlation_Name: OleDbLiteral;
Description

A correlation name (table alias) in a text command.

ToString

[C#] public const OleDbLiteral Cube_Name;

[C++] public: const OleDbLiteral Cube_Name;

[VB] Public Const Cube_Name As OleDbLiteral

[JScript] public var Cube_Name: OleDbLiteral;
Description

The name of a cube in a schema (or the catalog if the provider does not support schemas).

ToString

[C#] public const OleDbLiteral Cursor_Name;

[C++] public: const OleDbLiteral Cursor_Name;

[VB] Public Const Cursor_Name As OleDbLiteral

[JScript] public var Cursor_Name: OleDbLiteral;
Description

A cursor name in a text command.

ToString

[C#] public const OleDbLiteral Dimension_Name;

[C++] public: const OleDbLiteral Dimension_Name;

[VB] Public Const Dimension_Name As OleDbLiteral

[JScript] public var Dimension_Name: OleDbLiteral;
Description

The name of the dimension. If a dimension is part of more than one cube, there is one row for each cube/dimension combination.

ToString

[C#] public const OleDbLiteral Escape_Percent_Prefix;

[C++] public: const OleDbLiteral Escape_Percent_Prefix;

[VB] Public Const Escape_Percent_Prefix As OleDbLiteral

[JScript] public var Escape_Percent_Prefix: OleDbLiteral;
Description

The character used in a LIKE clause to escape the character returned for the DBLITERAL_LIKE_PERCENT literal. For example, if a percent sign (%) is used to match zero or more characters and this is a backslash (\), the characters “abc\%%” match all character values that start with “abc%”. Some SQL dialects support a clause (the ESCAPE clause) that can be used to override this value.

ToString

[C#] public const OleDbLiteral Escape_Percent_Suffix;

[C++] public: const OleDbLiteral Escape_Percent_Suffix;

[VB] Public Const Escape_Percent_Suffix As OleDbLiteral

[JScript] public var Escape_Percent_Suffix: OleDbLiteral;
Description

The escape character, if any, used to suffix the character returned for the DBLITERAL_LIKE_PERCENT literal. For example, if a percent sign (%) is used to match zero or more characters and percent signs are escaped by enclosing in open and close square brackets, DBLITERAL_ESCAPE_PERCENT_PREFIX is “[”, DBLITERAL_ESCAPE_PERCENT_SUFFIX is “]”, and the characters “abc[%]%” match all character values that start with “abc%”. Providers that do not use a suffix character to escape the DBLITERAL_ESCAPE_PERCENT character do not return this literal value and can set the It member of the DBLITERAL structure to DBLITERAL_INVALID if requested.

The character used in a LIKE clause to escape the character returned for the DBLITERAL_LIKE_UNDERSCORE literal. For example, if an underscore (_) is used to match exactly one character and this is a backslash (\), the characters “abc\__” match all character values that are five characters long and start with “abc_”. Some SQL dialects support a clause (the ESCAPE clause) that can be used to override this value.

The character used in a LIKE clause to escape the character returned for the DBLITERAL_LIKE_UNDERSCORE literal. For example, if an underscore (_) is used to match exactly one character and this is a backslash (\), the characters “abc\__” match all character values that are five characters long and start with “abc_”. Some SQL dialects support a clause (the ESCAPE clause) that can be used to override this value.

ToString

[C#] public const OleDbLiteral Hierarchy_Name;

[C++] public: const OleDbLiteral Hierarchy_Name;

[VB] Public Const Hierarchy_Name As OleDbLiteral

[JScript] public var Hierarchy_Name: OleDbLiteral;
Description

The name of the hierarchy. If the dimension does not contain a hierarchy or has only one hierarchy, the current column contains a null value.

ToString

[C#] public co.st OleDbLiteral Index_Name;

[C++] public: const OleDbLiteral Index_Name;

[VB] Public Const Index_Name As OleDbLiteral

[JScript] public var Index_Name: OleDbLiteral;
Description

An index name used in a text command or in a data-definition interface.

ToString

[C#] public const OleDbLiteral Invalid;

[C++] public: const OleDbLiteral Invalid;

[VB] Public Const Invalid As OleDbLiteral

[JScript] public var Invalid: OleDbLiteral;
Description

An invalid value.

ToString

[C#] public const OleDbLiteral Level_Name;

[C++] public: const OleDbLiteral Level_Name;

[VB] Public Const Level_Name As OleDbLiteral

[JScript] public var Level_Name: OleDbLiteral;
Description

Name of the cube to which the current level belongs.

ToString

[C#] public const OleDbLiteral Like_Percent;

[C++] public: const OleDbLiteral Like_Percent;

[VB] Public Const Like_Percent As OleDbLiteral

[JScript] public var Like_Percent: OleDbLiteral;
Description

The character used in a LIKE clause to match zero or more characters. For example, if this is a percent sign (%), the characters “abc %” match all character values that start with “abc”.

ToString

[C#] public const OleDbLiteral Like_Underscore;

[C++] public: const OleDbLiteral Like_Underscore;

[VB] Public Const Like_Underscore As OleDbLiteral

[JScript] public var Like_Underscore: OleDbLiteral;
Description

The character used in a LIKE clause to match exactly one character. For example, if this is an underscore (_) the characters “abc_” match all character values that are four characters long and start with “abc”.

ToString

[C#] public const OleDbLiteral Member_Name;

[C++] public: const OleDbLiteral Member_Name;

[VB] Public Const_Member Name As OleDbLiteral

[JScript] public var Member_Name: OleDbLiteral;
Description

The name of the member.

ToString

[C#] public const OleDbLiteral Procedure_Name;

[C++] public: const OleDbLiteral Procedure_Name;

[VB] Public Const Procedure_Name As OleDbLiteral

[JScript] public var Procedure_Name: OleDbLiteral;
Description

A procedure name in a text command.

ToString

[C#] public const OleDbLiteral Property_Name;

[C++] public: const OleDbLiteral Property_Name;

[VB] public const Property_Name As OleDbLiteral

[JScript] public var Property_Name: OleDbLiteral;
Description

The name of the property.

ToString

[C#] public const OleDbLiteral Quote_Prefix;

[C++] public: const OleDbLiteral Quote_Prefix;

[VB] Public Const Quote_Prefix As OleDbLiteral

[JScript] public var Quote_Prefix: OleDbLiteral;
Description

The character used in a text command as the opening quote for quoting identifiers that contain special characters.

ToString

[C#] public const OleDbLiteral Quote_Suffix;

[C++] public: const OleDbLiteral Quote_Suffix;

[VB] Public Const Quote_Suffix As OleDbLiteral

[JScript] public var Quote_Suffix: OleDbLiteral;
Description

The character used in a text command as the closing quote for quoting identifiers that contain special characters. 1.x providers that use the same character as the prefix and suffix may not return this literal value and can set the It member of the DBLITERAL structure to DBLITERAL_INVALID if requested.

ToString

[C#] public const OleDbLiteral Schema_Name;

[C++] public: const OleDbLiteral Schema_Name;

[VB] Public Const Schema_Name As OleDbLiteral

[JScript] public var Schema_Name: OleDbLiteral;
Description

A schema name in a text command.

ToString

[C#] public const OleDbLiteral Schema_Separator;

[C++] public: const OleDbLiteral Schema_Separator;

[VB] Public Const Schema_Separator As OleDbLiteral

[JScript] public var Schema_Separator: OleDbLiteral;
Description

The character that separates the schema name from the rest of the identifier in a text command.

ToString

[C#] public const OleDbLiteral Table_Name;

[C++] public: const OleDbLiteral Table_Name;

[VB] Public Const Table_Name As OleDbLiteral

[JScript] public var Table_Name: OleDbLiteral;
Description

A table name used in a text command or in a data-definition interface.

ToString

[C#] public const OleDbLiteral Text_Command;

[C++] public: const OleDbLiteral Text_Command;

[VB] Public Const Text_Command As OleDbLiteral

[JScript] public var Text_Command: OleDbLiteral;
Description

A text command, such as an SQL statement.

ToString

[C#] public const OleDbLiteral User_Name;

[C++] public: const OleDbLiteral User_Name;

[VB] Public Const User_Name As OleDbLiteral

[JScript] public var User_Name: OleDbLiteral;
Description

A user name in a text command.

ToString

[C#] public const OleDbLiteral View_Name;

[C++] public: const OleDbLiteral View_Name;

[VB] Public Const View_Name As OleDbLiteral

[JScript] public var View_Name: OleDbLiteral;
Description

A view name in a text command.

OleDbParameter class (System.Data.OleDb)

ToString

Description

Represents a parameter to an System.Data.OleDb.OleDbCommand and optionally, its mapping to a System.Data.DataSet column.

Parameter names are not case sensitive.

OleDbParameter

Example Syntax:

ToString

[C#] public OleDbParameter( );

[C++] public: OleDbParameter( );

[VB] Public Sub New( )

[JScript] public function OleDbParameter( ); Initializes a new instance of the System.Data.OleDb.OleDbParameter class.
Description

Initializes a new instance of the System.Data.OleDb.OleDbParameter class.

Initializes a new instance of the System.Data.OleDb.OleDbParameter class with the parameter name and an System.Data.OleDb.OleDbParameter object. The name of the parameter to map. An System.Data.OleDb.OleDbParameter object.

OleDbParameter

Example Syntax:

ToString

[C#] public OleDbParameter(string name, OleDbType dataType);

[C++] public: OleDbParameter(String* name, OleDbType dataType);

[VB] Public Sub New(ByVal name As String, ByVal dataType As OleDbType)

Initializes a new instance of the System.Data.OleDb.OleDbParameter class with the parameter name and data type.

The data type, and if appropriate, System.Data.OleDb.OleDbParameter.Size and System.Data.OleDb.OleDbParameter.Precision are inferred from the value of the dataType parameter. The name of the parameter to map. One of the System.Data.OleDb.OleDbType values.

Initializes a new instance of the System.Data.OleDb.OleDbParameter class with the parameter name, data type, and width.

The System.Data.OleDb.OleDbParameter.Size is inferred from the value of the dataType parameter if it is not explicity set in the size parameter. The name of the parameter to map. One of the System.Data.OleDb.OleDbType values. The width of the parameter.

Initializes a new instance of the System.Data.OleDb.OleDbParameter class with the parameter name, data type, width, and source column name.

The System.Data.OleDb.OleDbParameter.Size is inferred from the value of the dataType parameter if it is not explicitly set in the size parameter. The name of the parameter to map. One of the System.Data.OleDb.OleDbType values. The width of the parameter. The name of the source column.

Initializes a new instance of the System.Data.OleDb.OleDbParameter class with the parameter name, data type, width, source column name, parameter direction, numeric precision, and other properties.

The System.Data.OleDb.OleDbParameter.Size and System.Data.OleDb.OleDbParameter.Precision are inferred from the value of the datatype parameter if they are not explicity set in the size and precision parameters. The name of the parameter. One of the System.Data.OleDb.OleDbType values. The width of the parameter. One of the System.Data.ParameterDirection values. true if the value of the field can be null; otherwise, false. The total number of digits to the left and right of the decimal point to which System.Data.OleDb.OleDbParameter.Value is resolved. The total number of decimal places to which System.Data.OleDb.OleDbParameter.Value is resolved. The name of the source column. One of the System.Data.DataRowVersion values. An System.Object that is the value of the System.Data.OleDb.OleDbParameter.

The System.Data.OleDb.OleDbParameter.OleDbType and System.Data.OleDb.OleDbParameter.DbType are linked. Therefore, setting the System.Data.OleDb.OleDbParameter.DbType changes the System.Data.OleDb.OleDbParameter.OleDbType to a supporting System.Data.OleDb.OleDbParameter.OleDbType.

The System.Data.OleDb.OleDbParameter.OleDbType and System.Data.OleDb.OleDbParameter.DbType are linked. Therefore, setting the System.Data.OleDb.OleDbParameter.DbType changes the System.Data.OleDb.OleDbParameter.OleDbType to a supporting System.Data.OleDb.OleDbType.

Gets or sets the System.Data.DataRowVersion to use when loading System.Data.OleDb.OleDbParameter.Value.

Used by System.Data.OleDb.OleDbDataAdapter.UpdateCommand during an System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) operation to determine whether the parameter value is set to Current or Original. This allows primary keys to be updated. This property is ignored by System.Data.OleDb.OleDbDataAdapter.InsertCommand and System.Data.OleDb.OleDbDataAdapter.DeleteCommand. This property is set to the version of the System.Data.DataRow used by the System.Data.DataRow.Item(System.Int32) property, or the System.Data.DataRow.GetChildRows(System.String) method of the System.Data.DataRow object.

For input parameters, the value is bound to the System.Data.OleDb.OleDbCommand that is sent to the server. For output and return value parameters, the value is set on completion of the System.Data.OleDb.OleDbCommand and after the System.Data.OleDb.OleDbDataReader is closed.

ICloneable.Clone

[C#] object ICloneable.Clone( );

[C++] Object* ICloneable::Clone( );

[VB] Function Clone( ) As Object Implements ICloneable.Clone

[JScript] function ICloneable.Clone( ): Object;

ToString

[C#] public override string ToString( );

[C++] public: String* ToString( );

[VB] Overrides Public Function ToString( ) As String

[JScript] public override function ToString( ): String;
Description

Gets a string containing the System.Data.OleDb.OleDbParameter.ParameterName.

Adds an System.Data.OleDb.OleDbParameter to the System.Data.OleDb.OleDbCommand given the parameter name and value.

Return Value: A reference to the new System.Data.OleDb.OleDbParameter object.

When you specify System.DBNull.Value in the value parameter, you should also explicitly set the System.Data.OleDb.OleDbType as demonstrated in this C# example: OleDbCommand rComm=new OleDbCommand(null, rConn); rComm.CommandText=“insert into mytable values (?)”; rComm.Parameters.Add(“@p1”, DBNull.Value); rComm.Parameters[“@p1”].OleDbType=OleDbType.Integer;x The System.Data.OleDb.OleDbParameter.Value of the System.Data.OleDb.OleDbParameter to add to the collection.

Copies System.Data.OleDb.OleDbParameter objects from the System.Data.OleDb.OleDbParameterCollection to the specified array. The System.Array into which to copy the System.Data.OleDb.OleDbParameter objects. The starting index of the array.

GetEnumerator

[C#] public IEnumerator GetEnumerator( );

[C++] public: _sealed IEnumerator* GetEnumerator( );

[VB] NotOverridable Public Function GetEnumerator( ) As IEnumerator

[JScript] public function GetEnumerator( ): IEnumerator;
Description

IndexOf

[C#] public int IndexOf(object value);

[C++] public: _sealed int IndexOf(Object* value);

[VB] NotOverridable Public Function IndexOf(ByVal value As Object) As Integer

[JScript] public function IndexOf(value: Object): int;
Description

Gets the location of the System.Data.OleDb.OleDbParameter object in the collection.

Return Value: The location of the System.Data.OleDb.OleDbParameter in the collection. The System.Data.OleDb.OleDbParameter object to locate.

IndexOf

[C#] public int IndexOf(string parameterName);

[C++] public: _sealed int IndexOf(String* parameterName);

[VB] NotOverridable Public Function IndexOf(ByVal parameterName As String) As Integer

[JScript] public function IndexOf(parameterName: String): int; Gets the location of the System.Data.OleDb.OleDbParameter in the collection.
Description

Gets the location of the System.Data.OleDb.OleDbParameter in the collection with the specified parameter name.

Return Value: The location of the System.Data.OleDb.OleDbParameter in the collection.

Inserts an System.Data.OleDb.OleDbParameter in the collection at the specified index. The zero-based index where the parameter is to be inserted within the collection. The System.Data.OleDb.OleDbParameter to add to the collection.

Remove

[C#] public void Remove(object value);

[C++] public: _sealed void Remove(Object* value);

[VB] NotOverridable Public Sub Remove(ByVal value As Object)

[JScript] public function Remove(value: Object);
Description

Removes the specified System.Data.OleDb.OleDbParameter from the collection. The System.Data.OleDb.OleDbParameter object to remove from the collection.

RemoveAt

[C#] public void RemoveAt(int index);

[C++] public: _sealed void RemoveAt(int index);

[VB] NotOverridable Public Sub RemoveAt(ByVal index As Integer)

[JScript] public function RemoveAt(index: int); Removes the specified System.Data.OleDb.OleDbParameter from the collection.
Description

Removes the System.Data.OleDb.OleDbParameter at the specified index from the collection. The zero-based index of the parameter to remove.

Initializes a new instance of the System.Data.OleDb.OleDbPermissionAttribute class.

Return Value: An System.Data.OleDb.OleDbPermissionAttribute object. One of the the System.Security.Permissions.SecurityAction values representing an action that can be performed using declarative security.

Action

AllowBlankPassword

Provider

Union

Description

Gets or sets a comma-delimited string containing a list of supported providers.

Initializes a new instance of the System.Data.OleDb.OleDbRowUpdatedEventArgs class. The System.Data.DataRow sent through an System.Data.Common.DbDataAdapter.Update(System.Data.DataSet). The System.Data.IDbCommand executed when System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) is called. One of the System.Data.StatementType values that specifies the type of query executed. The System.Data.Common.DataTableMapping sent through an System.Data.Common.Db