E 17726

Oracle Provider for OLE DB
Developers Guide
11g Release 2 (11.2) for Microsoft Windows
E17726-03
July 2013
Oracle Provider for OLE DB Developer's Guide, 11g Release 2 (11.2) for Microsoft Windows
E17726-03
Copyright 1999, 2013, Oracle and/or its affiliates. All rights reserved.
Contributors: Janis Greenberg, Eric Belden, Riaz Ahmed, Kiminari Akiyama, Neeraj Gupta, Sinclair Hsu,
Gopal Kirsur, Sunil Mushran, Rajendra Pingte, Helen Slattery, Valarie Moore, Vikhram Shetty, Sujith
Somanathan, Alex Keh, Christian Shay
This software and related documentation are provided under a license agreement containing restrictions on
use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your
license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,
transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse
engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is
prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If
you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it
on behalf of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software,
any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users
are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and
agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and
adaptation of the programs, including any operating system, integrated software, any programs installed on
the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to
the programs. No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management
applications. It is not developed or intended for use in any inherently dangerous applications, including
applications that may create a risk of personal injury. If you use this software or hardware in dangerous
applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other
measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages
caused by use of this software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of
their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks
are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD,
Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced
Micro Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information on content, products,
and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly
disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle
Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your
access to or use of third-party content, products, or services.
Contents
Preface ................................................................................................................................................................ vii
Audience...................................................................................................................................................... vii
Documentation Accessibility .................................................................................................................... vii
Related Documents ................................................................................................................................... viii
Conventions ............................................................................................................................................... viii
What's New in OraOLEDB? ................................................................................................................... ix

New Features in Oracle Provider for OLE DB for Release 11.1.0.7.20 ................................................ ix
New Features in Oracle Provider for OLE DB for Release 11.1............................................................ ix
1 Introduction to Oracle Provider for OLE DB

Overview of OLE DB...............................................................................................................................
OLE DB Design...................................................................................................................................
Overview of OraOLEDB .........................................................................................................................
System Requirements..............................................................................................................................
OraOLEDB Installation...........................................................................................................................
Component Certifications .....................................................................................................................
1-1
1-1
1-2
1-3
1-3
1-4
Features of OraOLEDB
OraOLEDB Provider Specific Features ................................................................................................ 2-1
Data Types........................................................................................................................................... 2-1
Binary Data Types....................................................................................................................... 2-2
TIMESTAMP Data Types .......................................................................................................... 2-2
INTERVAL Data Types.............................................................................................................. 2-4
Data Source ......................................................................................................................................... 2-5
Compatibility with OLE DB Services....................................................................................... 2-5
Connecting to an Oracle Database ........................................................................................... 2-6
OraOLEDB-Specific Connection String Attributes ................................................................ 2-7
Default Attribute Values............................................................................................................ 2-8
Distributed Transactions............................................................................................................ 2-8
Enhanced Failover Capability ................................................................................................... 2-8
Operating System Authentication ............................................................................................ 2-9
Password Expiration .................................................................................................................. 2-9
VCharNull................................................................................................................................. 2-10
SPPrmDefVal ............................................................................................................................ 2-10
iii
OraOLEDB Sessions........................................................................................................................
Transactions ..............................................................................................................................
Commands .......................................................................................................................................
Stored Procedures ....................................................................................................................
Preparing Commands .............................................................................................................
Command Parameters.............................................................................................................
OraOLEDB Custom Properties for Commands ..................................................................
Stored Procedures and Functions Returning Rowsets .......................................................
Multiple Rowsets .....................................................................................................................
Statement Caching ...................................................................................................................
Metadata Caching ....................................................................................................................
Command Timeout and Cancel Method ..............................................................................
Rowsets.............................................................................................................................................
To Create Rowsets ...................................................................................................................
Updatability ..............................................................................................................................
Server Data on Insert Property ..............................................................................................
To Search for Rows with IRowsetFind::FindNext...............................................................
OraOLEDB-Specific Connection String Attributes for Rowsets .......................................
Tips for ADO Programmers ...................................................................................................
Schema Rowsets .......................................................................................................................
Date Formats.............................................................................................................................
Case of Object Names..............................................................................................................
LOB Support ....................................................................................................................................
Unicode Support .............................................................................................................................
Types of Unicode Encoding ...................................................................................................
How Oracle Unicode Support Works ...................................................................................
Unicode Support Setup ...........................................................................................................
Errors.................................................................................................................................................
OLEDB.NET Data Provider Compatibility .................................................................................
Using the OLEDB.NET Attribute in a Connection String..................................................
Using OraOLEDB Custom Properties...................................................................................
Updating Oracle with DataTable Changes ..........................................................................
Using OraOLEDB with Visual Basic .................................................................................................
Setting Up the Oracle Database ....................................................................................................
Setting Up the Visual Basic Project...............................................................................................
Provider-Specific Information
Data Type Mappings in Rowsets and Parameters ............................................................................
Properties Supported..............................................................................................................................
Data Source Properties .....................................................................................................................
DataSourceInfo Properties ...............................................................................................................
Initialization and Authorization Properties ..................................................................................
Session Properties .............................................................................................................................
Rowset Properties .............................................................................................................................
Rowset Property Implications..................................................................................................
Interfaces Supported...............................................................................................................................
Data Source ........................................................................................................................................
iv
2-10
2-11
2-11
2-11
2-12
2-12
2-12
2-15
2-15
2-18
2-18
2-19
2-19
2-19
2-20
2-21
2-21
2-21
2-22
2-22
2-23
2-24
2-24
2-24
2-24
2-25
2-25
2-25
2-26
2-26
2-26
2-27
2-27
2-28
2-28
A-1
A-2
A-2
A-2
A-4
A-5
A-5
A-8
A-8
A-9
Session.................................................................................................................................................
Command...........................................................................................................................................
Rowset.................................................................................................................................................
Multiple Results ..............................................................................................................................
Transaction Options........................................................................................................................
Custom Error Object .......................................................................................................................
MetaData Columns Supported ...........................................................................................................
OraOLEDB Tracing ...............................................................................................................................
Registry Setting for Tracing Calls ................................................................................................
A-9
A-9
A-9
A-10
A-10
A-10
A-10
A-11
A-11
Glossary
Index
vi
Preface
Based on an open standard, Oracle Provider for OLE DB (OraOLEDB) allows access to
Oracle Databases. This documentation describes OraOLEDB's provider-specific
features and properties.
This document describes the features of Oracle Database for Windows that apply to
the Windows 2000, Windows XP, and Windows Server 2003 operating systems.
This Preface contains these topics:
Audience
Documentation Accessibility
Related Documents
Conventions
Audience
Oracle Provider for OLE DB Developer's Guide is intended for programmers developing
applications to access an Oracle Database using Oracle Provider for OLE DB. This
documentation is also valuable to systems analysts, project managers, and others
interested in the development of database applications.
To use this document, you must be familiar with OLE DB and have a working
knowledge of application programming using Microsoft C/C++, Visual Basic, or
ActiveX Data Objects (ADO). Knowledge of Component Object Model (COM)
concepts are also useful.
Readers should also be familiar with the use of Structured Query Language (SQL) to
access information in relational database systems.
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle
Accessibility Program website at
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.
Access to Oracle Support
Oracle customers have access to electronic support through My Oracle Support. For
information, visit
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are
hearing impaired.
vii
Related Documents
For more information, see these Oracle resources:
Oracle Database Installation Guide for Windows
Oracle Database Release Notes for Windows
Oracle Database Platform Guide for Windows
Oracle Database Concepts
Oracle Services for Microsoft Transaction Server Developer's Guide
Oracle Net Services Administrator's Guide
Oracle Database New Features
Oracle Database Reference
Oracle Database Globalization Support Guide
For information about Oracle error messages, see Oracle Database Error Messages.
Oracle error message documentation is available only in HTML. If you only have
access to the Oracle Documentation CD, you can browse the error messages by range.
Once you find the specific range, use your browser's "find in page" feature to locate the
specific message. When connected to the Internet, you can search for a specific error
message using the error message search feature of the Oracle online documentation.
Many of the examples in this book use the sample schemas of the seed database, which
is installed by default when you install Oracle. Refer to Oracle Database Sample Schemas
for information on how these schemas were created and how you can use them
yourself.
To download free release notes, installation documentation, white papers, or other
collateral, please visit the Oracle Technology Network (OTN). You must register
online before using OTN; registration is free and can be done at
http://www.oracle.com/technetwork/index.html
If you already have a username and password for OTN, then you can go directly to the
documentation section of the OTN Web site at
http://www.oracle.com/technetwork/documentation/index.html
For additional information, see:

http://www.microsoft.com
Conventions
The following text conventions are used in this document:
viii
Convention
Meaning
boldface
Boldface type indicates graphical user interface elements associated

with an action, or terms defined in text or the glossary.
italic
Italic type indicates book titles, emphasis, or placeholder variables for

which you supply particular values.
monospace
Monospace type indicates commands within a paragraph, URLs, code

in examples, text that appears on the screen, or text that you enter.
What's New in OraOLEDB?

The following sections describe the new features in Oracle Provider for OLE DB
(OraOLEDB):
New Features in Oracle Provider for OLE DB for Release 11.1.0.7.20
New Features in Oracle Provider for OLE DB for Release 11.1
New Features in Oracle Provider for OLE DB for Release 11.1.0.7.20

Oracle Provider for OLE DB release 11.1.0.7.20 includes the following:
Command Timeout and Command Cancel

The CommandTimeout property determines how long OraOLEDB waits before it
attempts to terminate the executed command. The Cancel command cancels the
OraOLEDB command currently being executed.
A new registry value, EnableCmdTimeout, allows developers to enable or
disable the CommandTimeout property value.
"Command Timeout and Cancel Method" on page 2-19
and "Enabling CommandTimeout Through the Registry" on page 2-19
See Also:
New Features in Oracle Provider for OLE DB for Release 11.1

Oracle Provider for OLE DB release 11.1 includes the following:
Improved Statement and Metadata Caching

This release enhances the existing caching infrastructure to cache OraOLEDB data
buffers and metadata information. This enhancement is independent of Database
version and is available for all supported Database versions. This feature provides
significant performance improvement for the applications that execute the same
statement repeatedly.
See Also:
"Statement Caching" on page 2-18
"Metadata Caching" on page 2-18
Enhanced Failover Capability

Oracle Provider for OLE DB introduced new connection string attributes and
registry entries to enhance failover capability.
ix
See Also:
"Enhanced Failover Capability" on page 2-8
Support of ADO Disconnected Recordsets

Oracle Provider for OLE DB introduced a new connection string attribute and
registry entry to support ADO disconnected recordsets.
See Also: DeferUpdChk under "OraOLEDB-Specific Connection
String Attributes for Rowsets" on page 2-21
1
Introduction to Oracle Provider for OLE DB
This chapter introduces Oracle Provider for OLE DB (OraOLEDB).

This chapter contains these topics:
Overview of OLE DB
Overview of OraOLEDB
System Requirements
OraOLEDB Installation
Component Certifications
Overview of OLE DB
OLE DB is an open standard data access methodology which utilizes a set of
Component Object Model (COM) interfaces for accessing and manipulating different
types of data. These interfaces are available from various database providers.
OLE DB Design
The design of OLE DB centers around the concept of a consumer and a provider.
Figure 11 is an illustration of the OLE DB system. The consumer represents the
traditional client. The provider places data into a tabular format and returns it to the
consumer.
1-1
Figure 11 OLE DB Flow
OLE DB Data Providers

OLE DB data providers are a set of COM components that transfer data from a data
source to a consumer. An OLE DB Provider places that data in a tabular format in
response to calls from a consumer. Providers can be simple or complex. A provider
may return a table, it may allow the consumer to determine the format of that table,
and it may perform operations on the data.
Each provider implements a standard set of COM interfaces to handle requests from
the consumer. A provider may implement optional COM interfaces to provide
additional functionality.
With the standard interfaces, any OLE DB consumer can access data from any
provider. Because of COM components, consumers can access them in any
programming language that supports COM, such as C++, Visual Basic, and Java.
OLE DB Data Consumers
The OLE DB data consumer is any application or tool that utilizes OLE DB interfaces
of a provider to access a broad range of data.
Oracle Provider for OLE DB (OraOLEDB) is an OLE DB data provider that offers high
performance and efficient access to Oracle data by OLE DB consumers.
In general, this developer's guide assumes that you are using OraOLEDB through OLE
DB or ADO.
1-2 Oracle Provider for OLE DB Developer's Guide
With the advent of the .NET framework, support has been provided for using the
OLEDB.NET Data Provider with OraOLEDB. With the proper connection attribute
setting, an OLEDB.NET Data Provider can utilize OraOLEDB to access Oracle
Database.
"OLEDB.NET Data Provider Compatibility" on
page 2-26 for further information on support for OLEDB.NET Data
Provider
See Also:
System Requirements
The following items are required on a system to use Oracle Provider for OLE DB:
Windows Operating System:
32-bit: Windows 7 (Professional, Enterprise, and Ultimate Editions), Windows

Vista (Business, Enterprise, and Ultimate Editions), Windows Server 2008
(Standard, Enterprise, Datacenter, Web, and Foundation Editions), Windows
Server 2003 R2 (all editions), Windows Server 2003 (all editions), or Windows
XP Professional Edition.
Oracle supports 32-bit Oracle Provider for OLE DB on x86, AMD64, and Intel
EM64T processors on these operating systems.
x64: Windows 7 x64 (Professional, Enterprise, and Ultimate Editions),

Windows Vista x64 (Business, Enterprise, and Ultimate Editions), Windows
Server 2008 R2 x64 (Standard, Enterprise, Datacenter, Web, and Foundation
Editions), Windows Server 2008 x64 (Standard, Enterprise, Datacenter, Web,
and Foundation Editions), Windows Server 2003 x64 (all editions), Windows
Server 2003 R2 x64 (all editions), or Windows XP x64.
Oracle supports 32-bit Oracle Provider for OLE DB and 64-bit Oracle Provider
for OLE DB for Windows x64 on these operating systems.
Access to an Oracle Database (Oracle 9.2 or later)

Oracle Client and Oracle Net Services (included with Oracle Provider for OLE DB
installation).
Redistributable files provided with Microsoft Data Access Components (MDAC)
2.1 or higher are required by the provider. These files are available at the Microsoft
Web site:
http://msdn.microsoft.com/en-us/data/aa937730.aspx
Oracle Services for Microsoft Transaction Server release 11.2 or higher. This is
required for consumers using Microsoft Transaction Server (MTS) or COM+.
Oracle Provider for OLE DB is included as part of your Oracle installation. It contains
the features and demos that illustrate how to use this product to solve real-world
problems.
See Also: The Oracle Database Installation Guide for Windows for
installation instructions
During the installation process, the files listed in Table 11 are installed on the system.
Some files have ver in their name to indicate the release version.
1-3
Table 11
Oracle Provider for OLE DB Files
File
Description
Location
OraOLEDBver.dll
ORACLE_BASE\ORACLE_HOME\bin
OraOLEDBrfcver.dll
Oracle rowset file cache manager
OraOLEDBrmcver.dll
Oracle rowset memory cache manager
OraOLEDBrstver.dll
Oracle rowset
OraOLEDBgmrver.dll
Oracle ODBC SQL parser
OraOLEDBlangver.dll
Language-specific resource DLL
OraOLEDBpusver.dll
Property descriptions
OraOLEDButlver.dll
OraOLEDB utility DLL
OraOLEDBver.tlb
OraOLEDB type library
OraOLEDB.h
OraOLEDB header file
ORACLE_BASE\ORACLE_
HOME\oledb\include
OraOLEDBver.lib
OraOLEDB library file
ORACLE_BASE\ORACLE_
HOME\oledb\lib
OraOLEDBlang.msb
Language-specific message file
ORACLE_BASE\ORACLE_
HOME\oledb\mesg
readme and
documentation files
Release notes and online documentation
ORACLE_BASE\ORACLE_
HOME\oledb\directory
sample files
Sample code
ORACLE_BASE\ORACLE_
HOME\oledb\samples
where lang is the

required language
where lang is the

required language
Oracle provides support information for components on various platforms, lists
compatible client and database versions, and identifies patches and workaround
information.
Find the latest certification information at My Oracle Support (formerly
OracleMetaLink):
http://metalink.oracle.com/
You must register online before using My Oracle Support. After logging into My
Oracle Support, select Product Lifecycle from the left column. From the Products
Lifecycle page, click Certifications. Other Product Lifecycle options include Product
Availability, Desupport Notices, and Alerts.
2
2
Features of OraOLEDB
This chapter describes components of Oracle Provider for OLE DB (OraOLEDB) and
how to use the components to develop OLE DB consumer applications.
This chapter contains these topics:
OraOLEDB Provider Specific Features
Using OraOLEDB with Visual Basic

The following sections describe provider-specific features of OraOLEDB:
Data Types
Data Source
OraOLEDB Sessions
Commands
Rowsets
LOB Support
Unicode Support
Errors
OLEDB.NET Data Provider Compatibility
Additional provider-specific information is provided in Appendix A,

"Provider-Specific Information".
Data Types
The data types that OraOLEDB supports are listed in Table A1 with Unicode and
NonUnicode mappings.
OraOLEDB supports the Oracle data types described in the following sections.
Data Types introduced in Oracle Database 10g:
BINARY_FLOAT
BINARY_DOUBLE
Data Types introduced in Oracle9i:
TIMESTAMP
Features of OraOLEDB 2-1
TIMESTAMP WITH TIME ZONE
TIMESTAMP WITH LOCAL TIME ZONE
INTERVAL YEAR TO MONTH
INTERVAL DAY TO SECOND

See Also: For details about these and other data types, and time
zones, see Oracle Database SQL Language Reference
Binary Data Types

BINARY_FLOAT is a single-precision floating point data type (4 bytes), which is
mapped to OLE DB DBTYPE_R4.
BINARY_DOUBLE is a double-precision floating point data type (8 bytes), which is
mapped to OLE DB DBTYPE_R8.
TIMESTAMP Data Types

This section discusses the Timestamp data types and then provides the following:
Sample data illustrating insertion and retrieval operations using each of the
Timestamp data types.
A Visual Basic code example using the Timestamp data types.
Timestamp data types are mapped to the OLE DB DBTYPE_DBTIMESTAMP. The OLE
DB DBTYPE_DBTIMESTAMP data type does not have TIME ZONE information.
The Timestamp data types include:
TIMESTAMP
TIMESTAMP WITH TIME ZONE
TIMESTAMP WITH LOCAL TIME ZONE
Data Insertion
For data insertion into a TIMESTAMP WITH TIME ZONE or TIMESTAMP WITH LOCAL
TIME ZONE column, the time zone setting of the client is used.
OLE DB Timestamp data type cannot provide the time zone information. For insert
operations, the default time zone from the client session is added to the TIMESTAMP
WITH TIME ZONE column data.
Data Retrieval
For data retrieval, TIME ZONE is dropped for TIMESTAMP WITH TIME ZONE columns,
but TIME ZONE is used for TIMESTAMP WITH LOCAL TIME ZONE columns.
The OLE DB Timestamp data type cannot store time zone information.
Fractional Second
Fractional second is not supported for TIMESTAMP data types binding with Command
objects.
Note that using ALTER SESSION to change time zone information does not change the
time zone information in the new and existing Recordsets, which use the client time
zone setting from the Regional options of the operating system. The maximum
fractional_seconds_precision of TIMESTAMP is 9 and the default precision is
6.
ADO Consumers
For the Timestamp data types, ADO consumers must specify the value of
CursorLocation as adUseServer and use Recordset for DML operations.
Examples of Timestamp Insert and Retrieval

The following scenarios assume that the default precision of 6 is used.
TIMESTAMP Column
Insert Data: 4/16/2003 11:19:19 AM
(No time zone)
Data in DB: 4/16/2003 11.19.19.000000 AM

Data Retrieval: 4/16/2003 11:19:19 AM
TIMESTAMP WITH TIME ZONE Column
Insert Data: 4/16/2003 11:19:19 AM (Time zone of the Client session is used)
Data in DB: 4/16/2003 11.19.19.000000 AM -07:00
Data Retrieval: 4/16/2003 11:19:19 AM
(Time zone is dropped)
See Also:
"Data Insertion" on page 2-2
"Data Retrieval" on page 2-2
TIMESTAMP WITH LOCAL TIME ZONE Column

The following scenario assumes that the time zone of the client session is -04:00,
currently on US EDT (Eastern daylight time). For an insert operation, the data in the
TIMESTAMP WITH LOCAL TIME ZONE column does not include time zone
displacement, but its TIMESTAMP data is normalized to the database time zone -07:00,
which is the same as US PDT (Pacific daylight time).
For a query, data is returned in the time zone of the client session. The time zone
displacement is the difference (in hours and minutes) between the local time and the
Coordinated Universal Time (UTC).
Insert Data: 4/16/2003 4:30:23 PM
(Client time zone is -04:00)
Data in DB: 4/16/2003 01.30.23.000000 PM
(Database time zone -07:00)
Data Retrieval: 4/16/2003 4:30:23 PM
Visual Basic Example

...
Dim DT As Date
DT = Now()
con.ConnectionString = "Provider=OraOLEDB.Oracle.1;User ID=user_name;" & _
"Password=pwd;Data Source=Oracle;"
con.Open
'Must use adUseServer
rec.CursorLocation = adUseServer
rec.ActiveConnection = con
rec.Open "select timestamp_column from test_table", con, adOpenDynamic,_
adLockOptimistic
rec.AddNew Array("timestamp_column"), Array(DT)
update data
rec.Update Array("timestamp_column"), Array("07/07/07 07:17:17 AM")
...
INTERVAL Data Types

The INTERVAL data types are mapped to OLE DB DBTYPE_STR data type. The
INTERVAL data types include:
For the INTERVAL YEAR TO MONTH column, the maximum year_precision is 9 and
the default is 2. For INTERVAL DAY TO SECOND column, the maximum day_
precision is 9 and the default is 2 and the maximum fractional_seconds_
precision is 9, the default is 6.
Note:
If the sign is not specified, then the default is +.

Usage: (sign) years-months
Examples:
2-3
2 years and 3 months
+2-3
2 years and 3 months
-2-3
negative 2 years and 3 months

Usage: (sign) days hours:minutes:seconds.second_fraction
Examples:
7 10:20:30.123456
7 days, 10 hours, 20 minutes, and 30.123456 seconds
+7 10:20:30.123456
7 days, 10 hours, 20 minutes, and 30.123456 seconds
-7 10:20:30.123456
negative 7 days, 10 hours, 20 minutes, and 30.123456 seconds
Visual Basic Example

...
con.ConnectionString = "Provider=OraOLEDB.Oracle.1;User ID=user_name;"& _
"Password=pwd;Data Source=Oracle;"
con.Open
'no restriction on using adUseServer or adUseClient
rec.CursorLocation = adUseServer
rec.ActiveConnection = con
rec.Open "select * from test_table2", con, adOpenDynamic, adLockOptimistic
rec.AddNew Array("year_to_month_column", "day_to_second_column"), _
Array("8-1", "3 20:30:10.12")
'update data
rec.Update Array("year_to_month_column", "day_to_second_column"), _
Array("2-3", "7 10:20:30.123456")
...
Data Source
A data source object in OraOLEDB is responsible for establishing the first connection
to the Oracle Database. To establish the initial connection, the consumer must use the
CoCreateInstance function to create an instance of the data source object. This
function requires important information about the provider: class ID of the provider
and executable context. The class ID of OraOLEDB is CLSID_OraOLEDB.
OraOLEDB is an in-process server. When calling CoCreateInstance, use the
CLSCTX_INPROC_SERVER macro. For example:
// create an instance of OraOLEDB data source object and
// obtain the IDBInitialize interface
hr = CoCreateInstance(CLSID_OraOLEDB, NULL,
CLSCTX_INPROC_SERVER, IID_IDBInitialize,
(void**)&pIDBInitialize);
The code snippet above does not enable OLEDB Services when instantiating the Data
Source object. To enable OLEDB services, see "Compatibility with OLE DB Services"
on page 2-5 below.
Note:
OraOLEDB does not support persistent data source objects.
After the successful creation of an instance of a data source object, the consumer
application can initialize the data source and create sessions.
OraOLEDB supports connections to Oracle Databases release 8i and higher. To
connect to a specific database, the consumer is required to set the following properties
of the DBPROPSET_DBINIT property set:
DBPROP_AUTH_USERNAME with the user ID, such as scott
DBPROP_AUTH_PASSWORD with the password, such as tiger
DBPROP_INIT_DATASOURCE with the net service name, such as myOraDb
The consumer could also populate DBPROP_INIT_PROMPT with DBPROMPT_PROMPT

which causes the provider to display a logon box for the user to enter the connect
information.
Using DBPROMPT_NOPROMPT disables display of the logon box. In this case,
incomplete logon information causes the provider to return a logon error. However, if
this property is set to DBPROMPT_COMPLETE or DBPROMPT_COMPLETEREQUIRED, the
logon box will be displayed only if the logon information is incomplete.
Compatibility with OLE DB Services

OraOLEDB is compatible with OLE DB Services that are available in OLE DB version
2.0 and later. OLE DB Services contains useful services such as automatic transaction
enlistment, Client Cursor Engine (CCE), connection and session pooling, which can
enhance application performance, and others.
OLE DB Services can be used with OraOLEDB through C++/COM or ADO.
By default, the OLEDB_SERVICES registry entry for OraOLEDB is set, under the
CLSID of OraOLEDB, to 0xffffffff (that is, -1), which enables all services. Certain
OLE DB Services can also be disabled or enabled programmatically through the
DBPROP_INIT_OLEDBSERVICES property setting.
See Also:
http://msdn.microsoft.com/en-us/library/ms724518(VS.
85).aspx for more information on OLE DB Services and how to
enable or disable specific services
ADO Applications with OLE DB Services ADO automatically enables OLE DB Services.
Thus, ADO applications do not need any special code to use OLEDB Services.
C++/COM Applications with OLE DB Services For C++/COM applications, some additional
steps are needed to use OLE DB Services.
The following code snippet shows one way that C++/COM applications can enable
OLE DB Services. The code shows the OLE DB consumer creating an instance of the
CLSID_MSDAINITIALIZE class through CoCreateInstance(), obtaining the
IDataInitialize interface from that object, and then creating an OLE DB data
source object through that interface.
// Instantiate the CLSID_MSDAINITIALIZE class and request for the
// IID_IDataInitialize interface from it
hr = CoCreateInstance(CLSID_MSDAINITIALIZE, NULL, CLSCTX_INPROC_SERVER,
IID_IDataInitialize, (void**)&pIDataInitialize);
// Set properties, datasource name, userid, and password, etc.
...
// Create an OLEDB data source object using the interface obtained from the
// CLSID_MSDAINITIALIZE class.
hr = pIDataInitialize->CreateDBInstance(CLSID_OraOLEDB, NULL,
CLSCTX_INPROC_SERVER, NULL,IID_IDBInitialize,(IUnknown**)&pIDBInitialize);
...
// If connection/session pooling was enabled, pIDBInitialize->Release()
// releases the connection/session back to the pool.
// pIDataInitialize->Release() should not be called until the application no
// longer need to use connection/session pooling and the rest of
// the OLE DB Services that were enabled for the application.
//
pIDBInitialize->Release();
Connecting to an Oracle Database

To connect to an Oracle Database using OraOLEDB, the OLE DB connection string
must be as follows:
"Provider=OraOLEDB.Oracle;User ID=user;Password=pwd;Data Source=constr;"
When connecting to a remote database, Data Source must be set to the correct net
service name which is the alias in the tnsnames.ora file. For more information, refer
to Oracle Net Services Administrator's Guide.
OraOLEDB-Specific Connection String Attributes

OraOLEDB offers provider-specific connection string attributes, which are set in the
same way as the Provider and User ID are set. The provider-specific connection string
attributes are:
CacheType - specifies the type of cache used to store the rowset data on the client.
See "OraOLEDB-Specific Connection String Attributes for Rowsets" on page 2-21.
ChunkSize - specifies the size of LONG or LONG RAW column data stored in the
provider's cache. See "OraOLEDB-Specific Connection String Attributes for
Rowsets" on page 2-21.
DistribTX - enables or disables distributed transaction enlistment capability. See
"Distributed Transactions" on page 2-8.
FetchSize - specifies the size of the fetch array in rows. See "OraOLEDB-Specific
Connection String Attributes for Rowsets" on page 2-21.
OLEDB.NET - enables or disables compatibility with OLEDB.NET Data Provider.
See "OLEDB.NET Data Provider Compatibility" on page 2-26.
OSAuthent - specifies whether operating system authentication will be used
when connecting to an Oracle Database. See "Operating System Authentication"
on page 2-9.
PLSQLRSet - enables or disables the return of a rowset from PL/SQL stored
procedures. See "OraOLEDB Custom Properties for Commands" on page 2-12.
PwdChgDlg - enables or disables displaying the password change dialog box
when the password expires. See "Password Expiration" on page 2-9.
UseSessionFormat - specifies whether to use the default NLS session formats or
let OraOLEDB override some of these formats for the duration of the session.
Valid values are 0 (FALSE) and 1 (TRUE). The default is FALSE which lets
OraOLEDB override some of the default NLS session formats. If the value is TRUE,
OraOLEDB uses the default NLS session formats.
Note that this connection attribute does not appear under the \\HKEY_LOCAL_
MACHINE\SOFTWARE\ORACLE\KEY_HOMENAME\OLEDB registry key.
VCharNull - enables or disables the NULL termination of VARCHAR2 OUT

parameters from stored procedures.
SPPrmDefVal - specifies whether to use the default value or a NULL value if the
application has not specified a stored procedure parameter value.
NDataType - specifies whether any of the parameters bound to the command are
of N data types, which include NCHAR, NVARCHAR, or NCLOB. See "NDatatype" on
page 2-13.
SPPrmsLOB - specifies whether one or more parameters bound to the stored

procedures are of LOB data type, which include CLOB, BLOB, or NCLOB. See
"SPPrmsLOB" on page 2-14.
StmtCacheSize specifies the maximum number of statements that can be

cached. See "Statement Caching" on page 2-18.
MetaDataCacheSize - specifies the maximum number of SELECT statements for

which the metadata can be cached. See "Metadata Caching" on page 2-18.
DeferUpdChk - specifies whether or not to defer the updateability check to
support updating read-only disconnected rowsets. See DeferUpdChk under
"OraOLEDB-Specific Connection String Attributes for Rowsets" on page 2-21.
DBNotifications - specifies whether or not to subscribe to the high availability
events. See "Enhanced Failover Capability" on page 2-8.
DBNotificationPort - specifies the port number, which is opened to listen to
the Database notifications. See "Enhanced Failover Capability" on page 2-8.
Default Attribute Values

The default values for these attributes are located under the \\HKEY_LOCAL_
MACHINE\SOFTWARE\ORACLE\KEY_HOMENAME\OLEDB registry key, where KEY_
HOMENAME is the Oracle home.
The registry default values are read by OraOLEDB from the registry when the
provider is loaded into memory. If Oracle-specific connection string attributes are not
provided at connection time, then the default registry values are used. However, if the
attributes are provided, then these new values override the default registry values.
These attributes can be set by setting the DBPROP_INIT_PROVIDERSTRING property,
provided in the DBPROPSET_DBINIT property set. For example:
"FetchSize=100;CacheType=Memory;OSAuthent=0;PLSQLRSet=1;StmtCacheSize=10;"
Distributed Transactions
The DistribTX attribute specifies whether sessions are enabled to enlist in
distributed transactions. Valid values are 0 (disabled) and 1 (enabled). The default is 1
which indicates that sessions are enabled for distributed transaction enlistments.
Applications using Microsoft Transaction Server must have DistribTX set to 1, the
default.
Enhanced Failover Capability

This feature enhances failover capability.
These connection string attributes support enhanced failover capability.
DBNotifications
The DBNotifications attribute specifies whether or not to subscribe to high
availability events. Valid values are 0 (FALSE) and 1 (TRUE). The default is FALSE,
which indicates that OraOLEDB does not subscribe to high availability events. If
this attribute is not provided at the connection time, then the default registry value
is used.
DBNotificationPort
The DBNotificationPort attribute specifies the port number, which is used to
listen to the database notifications. The valid value is an unsigned integer.
DBNotificationPort is effective only if the DBNotifications attribute is set
to TRUE, either through the connection string attribute or by registry entry. The
default for the DBNotificationPort attribute is 0, which implies that
OraOLEDB opens a valid port randomly. OraOLEDB does not validate the port
number, so it is the responsibility of the application to specify a valid port number.
Enabling Failover Capability Through Registry Entry
DBNotifications
The DBNotifications registry entry specifies whether or not to subscribe to
high availability events. Valid values are 0 (FALSE) and 1 (TRUE). The default
value is FALSE, OraOLEDB does not subscribe. This registry entry value is used
when the DBNotifications connection string attribute is not set. It is located
under the \\HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\KEY_
HOMENAME\OLEDB registry key.
Operating System Authentication

The OSAuthent attribute specifies whether operating system authentication will be
used when connecting to an Oracle Database. Valid values are 0 (disabled) and
1(enabled). The default is 0, which indicates that operating system authentication is
not used.
Operating system authentication is the feature by which Oracle uses the security
mechanisms of the operating system to authorize users. For more information on this
subject and how to set it up on Windows clients, refer to the information on
authenticating database users on Windows in Oracle Database Platform Guide for
Windows
After the Windows client has been set up properly for operating system
authentication, this feature may be enabled by OraOLEDB clients by setting any of the
following:
DBPROP_AUTH_USERNAME to /
DBPROP_INIT_PROVIDERSTRING to OSAuthent=1;
OSAuthent in the registry to 1
Password Expiration
Oracle9i provides a Password Expiration feature which allows database
administrators to force users to change their passwords regularly. The PwdChgDlg
attribute enables or disables the displaying of the password change dialog box,
whenever a logon fails due to an expired password. When enabled, the provider
displays the dialog box to change the password. When disabled, the logon fails with
an error message. The valid values are 0 (disabled) and 1 (enabled). The default is 1
(enabled). For more information on the Password Expiration feature, see Oracle
Database Administrator's Guide.
Example: Connecting to an Oracle Database Using ADO

The following examples illustrate how to connect to an Oracle Database using
OraOLEDB and ADO.
If Data Source, User ID, and Password are provided
with the Open method, then ADO ignores those
ConnectionString attributes.
Note:
Connect Using ConnectionString

Dim con As New ADODB.Connection
con.ConnectionString = "Provider=OraOLEDB.Oracle;Data Source=MyOraDb;" & _
"User ID=scott;Password=tiger;"
con.Open
Connect Without Using ConnectionString

con.Provider = "OraOLEDB.Oracle"
con.Open "MyOraDb", "scott", "tiger"
Connect and Set Provider-specific Attributes

con.ConnectionString = "FetchSize=200;CacheType=Memory;" & _
"OSAuthent=0;PLSQLRSet=1;Data Source=MyOraDb;" & _
con.Open
Operating System-Authenticated Connect Setting User ID to /

con.Open "MyOraDb", "/", ""
Operating System-Authenticated Connect Using OSAuthent

con.ConnectionString = "Data Source=MyOraDb;OSAuthent=1;"
con.Open
VCharNull
The VCharNull attribute enables or disables the NULL termination of VARCHAR2
OUT parameters from stored procedures. Valid values are 0 (disabled) and 1 (enabled).
The default is 1, which indicates that VARCHAR2 OUT parameters are NULL
terminated. A value of 0 indicates that VARCHAR2 OUT parameters are padded with
spaces.
The default value for this attribute is located under the \\HKEY_LOCAL_
MACHINE\SOFTWARE\ORACLE\KEY_HOMENAME\OLEDB registry key, where
HOMENAME is the Oracle home. If this attribute is not provided at the connection time,
then the default registry value is used.
Note that with this connection attribute enabled, applications need to pad the stored
procedure IN and IN OUT CHAR parameters with spaces explicitly, if the parameter is
to be used in a WHERE clause.
SPPrmDefVal
The SPPrmDefVal attribute specifies whether to use the default value or a NULL
value if the application has not specified a stored procedure parameter value. Valid
values are 0 (FALSE) and 1 (TRUE). The default is FALSE, which enables OraOLEDB
to pass a NULL value. If the value is TRUE, then OraOLEDB uses the default value.
The default value for this attribute is located under the \\HKEY_LOCAL_
MACHINE\SOFTWARE\ORACLE\KEY_HOMENAME\OLEDB registry key. If this attribute
is not provided at connection time, then the default registry value is used.
OraOLEDB Sessions
An OraOLEDB session object represents a single connection to an Oracle Database.
The session object exposes the interfaces that allow data access and manipulation.
The first session created on the initialized data source inherits the initial connection
established by IDBInitialize::Initialize(). Subsequent sessions that are
created establish their own independent connections to the particular Oracle Database
specified by the data source properties.
Each session object also defines a transaction space for a data source. All command
and rowset objects created from a particular session object are part of the transaction
of that session.
After all references to the session object are released, the session object is removed
from memory and the connection is dropped.
Transactions
OraOLEDB supports local and distributed transactions, which provide explicit commit
and abort transactional operations.
OraOLEDB does not support nested transactions. In addition, a local transaction
cannot be started if the session is currently enlisted in a distributed transaction. This
also applies to distributed transactions if the session is currently enlisted in a local
transaction.
Local Transactions OraOLEDB supports the ITransactionLocal interface for explicit
transactions. By default, OraOLEDB is in an autocommit mode, meaning that each
unit of work done on the database is automatically or implicitly committed. With the
use of the ITransactionLocal interface, consumers may explicitly start a
transaction for a particular session, allowing a unit of work to be explicitly committed
or aborted by the consumer.
OraOLEDB supports the Read Committed (Cursor Stability) isolation level. In this
level, the changes made by other transactions are not visible until those transactions
are committed.
Distributed Transactions OraOLEDB consumers must install Oracle Services for
Microsoft Transaction Server (MTS) release 10.2 or higher to be able to participate in
Microsoft Transaction Server (or COM+) transactions or to enlist in a distributed
transaction coordinated by Microsoft Distributed Transaction Coordinator (MS DTC).
For setup and configuration information on Oracle Services for MTS, see Oracle
Services for Microsoft Transaction Server Developer's Guide.
OraOLEDB ignores IsoLevel, IsoFlags, and pOtherOptions parameters when
ITransactionJoin::JoinTransaction() is called. These options must be
provided when the consumer acquires a transaction object from MS DTC with the
ITransactionDispenser::BeginTransaction() method call.
However, if IsoFlags is nonzero, then XACT_E_NOISORETAIN is returned.
Commands
OraOLEDB supports ANSI SQL as supported by Oracle Database and the ODBC SQL
syntax.
Stored Procedures
When executing an Oracle PL/SQL stored procedure using a command, use Oracle
native syntax or the ODBC procedure call escape sequence in the command text:
Oracle native syntax: BEGIN credit_account(123, 40); END;
ODBC syntax: {CALL credit_account(123, 40)}
Preparing Commands
OraOLEDB validates and fetches the metadata only for SELECT SQL statements.
Command Parameters
When using Oracle ANSI SQL, parameters in the command text are preceded by a
colon. In ODBC SQL, parameters are indicated by a question mark (?).
OraOLEDB supports input, output, and input and output parameters for PL/SQL
stored procedures and stored functions. OraOLEDB supports input parameters for
SQL statements.
Note:
OraOLEDB supports only positional binding.
OraOLEDB Custom Properties for Commands

OraOLEDB custom properties for commands are grouped under the custom property
set ORAPROPSET_COMMANDS. It provides these properties:
Table 21
Custom Properties for Commands
For Visual Basic Users
For C++ Users
PLSQLRSet
ORAPROP_PLSQLRSet
NDatatype
ORAPROP_NDatatype
SPPrmsLOB
ORAPROP_SPPrmsLOB
AddToStmtCache
ORAPROP_AddToStmtCache
PLSQLRSet
This property is similar to the PLSQLRSet connection string attribute.
The property specifies whether OraOLEDB must return a rowset from the PL/SQL
stored procedure. If the stored procedure, provided by the consumer, returns a rowset,
PLSQLRSet must be set to TRUE (enabled). This property should be set to FALSE after
the command has been run. By default, the property is set to FALSE (disabled).
Consumers should use the property over the attribute, as the property can be set at the
command object rather than at the session. By setting it at the command object, the
consumer is able to set the property only for the command object executing stored
procedures which are returning rowsets. With the attribute, the consumer needed to
set it even if only one of many stored procedures being executed by the ADO
application returned a rowset. The use of this property should provide a performance
boost to applications making use of the attribute previously.
Example: Setting the Custom Property PLSQLRSet
Dim objRes As NEW ADODB.Recordset
Dim objCon As NEW ADODB.Connection
Dim objCmd As NEW ADODB.Command
....
objCmd.ActiveConnection = objCon
objCmd.CommandType = adCmdText
' Enabling the PLSQLRSet property indicates to the provider
' that the command returns one or more rowsets
objCmd.Properties("PLSQLRSet") = TRUE
' Assume Employees.GetEmpRecords() has a REF CURSOR as

' one of the arguments
objCmd.CommandText = "{ CALL Employees.GetEmpRecords(?,?) }"
' Execute the SQL
set objRes = objCmd.Execute
' It is a good idea to disable the property after execute as the
' same command object may be used for a different SQL statement
objCmd.Properties("PLSQLRSet") = FALSE
NDatatype
This property allows the consumers to specify whether any of the parameters bound
to the command are of Oracle's N data types (NCHAR, NVARCHAR or NCLOB). This
information is required by OraOLEDB to detect and bind the parameters. This
property should not be set for commands executing SELECT statements. However,
this property must be set for all other SQL statements, such as INSERT, UPDATE, and
DELETE.
The use of this property should be limited to SQL statements containing parameters of
N data type as setting it incurs a processing overhead of at least one round-trip to the
database. By default, this property is set to FALSE.
Note: OraOLEDB does not support parameters of N data types in
the WHERE clause of SQL statements.
Consumers are required to use the ODBC procedure call

escape sequence to call stored procedures or functions having N
data type parameters.
Note:
Example: Setting the Custom Property NDatatype

Dim prEmpno As NEW ADODB.Parameter
Dim prEname As NEW ADODB.Parameter
...
' Create and append the parameters to the command object
Set prEmpno = objCmd.CreateParameter("prEmpno", adSmallInt, adParamInput, ,8521)
' prEname is bound to a NVARCHAR column in the EMP table
Set prEname = objCmd.CreateParameter("prEname", adBSTR, adParamInput, , "Joe")
objCmd.Parameters.Append prEmpno
objCmd.Parameters.Append prEname
' Enabling the NDatatype property indicates to the provider
' that one or more of the bound parameters is of N datatype
objCmd.Properties("NDatatype") = TRUE
' Assume column ENAME in table EMP is of NVARCHAR type
objCmd.CommandText = "INSERT INTO EMP (EMPNO, ENAME) VALUES (?, ?)"
' Execute the SQL
objCmd.Execute
' It is a good idea to disable the property after execute as the same command
' object may be used for a different SQL statement
objCmd.Properties("NDatatype") = FALSE
SPPrmsLOB
This property allows the consumer to specify whether one or more of the parameters
bound to the stored procedures are of Oracle's LOB data type (CLOB, BLOB, or NCLOB).
OraOLEDB requires this property to be set to TRUE, to fetch the parameter list of the
stored procedure prior to execution. The use of this property limits the processing
overhead to stored procedures having one or more LOB data type parameters. This
property should be set to FALSE after the command has been executed. By default, the
property is set to FALSE.
Consumers are required to use the ODBC procedure call
escape sequence to call stored procedures or functions having LOB
data type parameters.
Note:
Example: Setting the Custom Property SPPrmsLOB

Dim prCLOB As NEW ADODB.Parameter
...
' Create and append the parameters to the command object
Set prCLOB = objCmd.CreateParameter("prCLOB", adLongVarchar, adParamOutput, _
10000)
objCmd.Parameters.Append prCLOB
' Enabling the SPPrmsLOB property indicates to the provider
' that one or more of the bound parameters is of LOB data type
objCmd.Properties("SPPrmsLOB") = TRUE
' Assume the Stored Procedure requires a CLOB parameter
objCmd.CommandText = "{ call storedproc(?) }"
'Execute the SQL
objCmd.Execute
' It is a good idea to disable the property after execute as the
' same command object may be used for a different SQL statement
objCmd.Properties("SPPrmsLOB") = FALSE
AddToStmtCache
This property allows the consumer to cache the executed statements when the
property is set to TRUE and statement caching is enabled. If the statement caching is
disabled or if this property is set to FALSE, then the executed statement is not cached.
This property is ignored if statement caching is disabled. Statement caching can be
enabled by setting the StmtCacheSize connection string attribute to a value greater
than zero. This property provides a way to selectively add statements to the cache
when statement caching is enabled. By default, the property is set to TRUE.
Example: Setting the Custom Property AddToStmtCache

...
' Statement caching is enabled by setting the 'StmtCacheSize'
' connection string attribute to a value greater than zero
objCon.ConnectionString = "StmtCacheSize=10;Data Source=MyOraDb;" & _
objCon.Open
objCmd.CommandText = "SELECT * FROM EMP"
' "SELECT * FROM EMP" statement would be added to the statement cache because
' StmtCacheSize connection string attribute value is greater than 0 and
' AddToStmtCache property value is TRUE by default.
objCmd.Execute
' Do not add "SELECT * FROM DEPT" to the statement cache
objCmd.CommandText = "SELECT * FROM DEPT"
objCmd.Properties("AddToStmtCache") = FALSE
' "SELECT * FROM DEPT" statement would not be added to the statement cache
objCmd.Execute
Stored Procedures and Functions Returning Rowsets

Oracle Provider for OLE DB allows consumers to execute a PL/SQL stored procedure
with an argument of REF CURSOR type or a stored function returning a REF CURSOR
value.
OraOLEDB returns a rowset for the REF CURSOR bind variable. Because there is no
predefined data type for REF CURSOR in the OLE DB specification, the consumer must
not bind this parameter.
If the PL/SQL stored procedure has one or more arguments of REF CURSOR type,
OraOLEDB binds these arguments and returns a rowset for each argument of REF
CURSOR type.
If the PL/SQL stored function returns a REF CURSOR or has an argument of REF
CURSOR type, OraOLEDB binds these and returns a rowset for each REF CURSOR type.
To use this feature, stored procedures or functions must be called in the ODBC
procedure call escape sequence.
The stored procedure or function being called could be either standalone or packaged.
However, the REF CURSOR being returned must be explicitly defined in a package in
the database.
Multiple Rowsets
OraOLEDB supports returning more than one rowset from a stored procedure.
Consumers can use this feature to access all the REF CURSORs being returned by a
stored procedure.
Example: Stored Procedure Returning Multiple Rowsets

PL/SQL Package
CREATE OR REPLACE PACKAGE Employees AS
TYPE empcur IS REF CURSOR;
PROCEDURE GetEmpRecords(p_cursor OUT empcur,
q_cursor OUT empcur,
indeptno IN NUMBER,
p_errorcode OUT NUMBER);
FUNCTION GetDept(inempno IN NUMBER,
p_errorcode OUT NUMBER)
RETURN empcur;
END Employees;
CREATE OR REPLACE PACKAGE BODY Employees AS
PROCEDURE GetEmpRecords(p_cursor OUT empcur,
q_cursor OUT empcur,
indeptno IN NUMBER,
p_errorcode OUT NUMBER) IS
BEGIN
p_errorcode := 0;
OPEN p_cursor FOR
SELECT *
FROM emp
WHERE deptno = indeptno
ORDER BY empno;
OPEN q_cursor FOR
SELECT empno
FROM emp
WHERE deptno = indeptno
ORDER BY empno;
EXCEPTION
WHEN OTHERS THEN
p_errorcode:= SQLCODE;
END GetEmpRecords;
FUNCTION GetDept(inempno IN NUMBER,
p_errorcode OUT NUMBER)
RETURN empcur IS
p_cursor empcur;
BEGIN
p_errorcode := 0;
OPEN p_cursor FOR
SELECT deptno
FROM emp
WHERE empno = inempno;
RETURN (p_cursor);
EXCEPTION
WHEN OTHERS THEN
p_errorcode:= SQLCODE;
END GetDept;
END Employees;
ADO Program
Dim
Dim
Dim
Dim
Dim
Dim
Dim
Con
Rst1
Rst2
Rst3
Cmd
Prm1
Prm2
As
As
As
As
As
As
As
New
New
New
New
New
New
New
ADODB.Connection
ADODB.Recordset
ADODB.Recordset
ADODB.Recordset
ADODB.Command
ADODB.Parameter
ADODB.Parameter
Con.Provider = "OraOLEDB.Oracle"
Con.ConnectionString = "Data Source=MyOraDb;" & _
Con.Open
Cmd.ActiveConnection = Con
' Although Employees.GetEmpRecords() takes four parameters, only
' two need to be bound because Ref cursor parameters are automatically
' bound by the provider.
Set Prm1 = Cmd.CreateParameter("Prm1", adSmallInt, adParamInput, , 30)
Cmd.Parameters.Append Prm1
Set Prm2 = Cmd.CreateParameter("Prm2", adSmallInt, adParamOutput)
Cmd.Parameters.Append Prm2
' Enable PLSQLRSet property
Cmd.Properties ("PLSQLRSet") = TRUE
' Stored Procedures returning resultsets must be called using the
' ODBC escape sequence for calling stored procedures.
Cmd.CommandText = "{CALL Employees.GetEmpRecords(?, ?)}"
' Get the first recordset
Set Rst1 = Cmd.Execute
' Disable PLSQLRSet property
Cmd.Properties("PLSQLRSet") = FALSE
' Get the second recordset
Set Rst2 = Rst1.NextRecordset
' Just as in a stored procedure, the REF CURSOR return value must
' not be bound in a stored function.
Prm1.Value = 7839
Prm2.Value = 0
Cmd.Properties("PLSQLRSet") = TRUE
' Stored Functions returning resultsets must be called using the
' ODBC escape sequence for calling stored functions.
Cmd.CommandText = "{CALL Employees.GetDept(?, ?)}"
' Get the rowset
Set Rst3 = Cmd.Execute
' Disable PLSQLRSet
Cmd.Properties ("PLSQLRSet") = FALSE
' Clean up
Rst1.Close
Rst2.Close
Rst3.Close
Statement Caching
Statement caching eliminates the need to parse each SQL or PL/SQL statement before
execution, by caching server cursors created during the initial statement execution.
Subsequent executions of the same statement can reuse the parsed information from
the cursor, and then execute the statement without reparsing, for better performance.
To see performance gains from statement caching, Oracle recommends caching only
those statements that will be repeatedly executed. Furthermore, SQL or PL/SQL
statements should use parameters rather than literal values. This will enable you to
take full advantage of statement caching. This is because parsed information from
parameterized statements can be reused, even if the parameter values change in
subsequent executions. However, if the literal values in the statements are different,
the parsed information cannot be reused unless the subsequent statements also have
the same literal values.
StmtCacheSize Connection String Attribute
This attribute enables or disables OraOLEDB statement caching. By default, this
attribute is set to 10 (enabled). If it is set to a value greater than 0, OraOLEDB
statement caching is enabled and the value specifies the maximum number of
statements that can be cached for a connection.
After a connection has been cached to the specified maximum cache size, the cursor
least recently used is freed to make room to cache the newly-created cursor. This value
should not be greater than the value of the OPEN_CURSORS parameter set in the
init.ora database configuration file.
AddToStmtCache Command Property
This property is relevant only when statement caching is enabled. If statement caching
is enabled and this property is set to true (default), then statements are added to the
cache when they are executed. If statement caching is disabled or if this property is set
to false, then the executed statement is not cached.
Enabling Statement Caching Through the Registry
To enable statement caching by default for all OraOLEDB applications running in a
system without changing the application, set the registry key of \\HKEY_LOCAL_
MACHINE\SOFTWARE\ORACLE\KEY_HOMENAME\OLEDB\StmtCacheSize to a value
greater than 0. Here, HOMENAME refers to the appropriate Oracle home. This value
specifies the number of cursors that are to be cached on the server. By default, it is set
to 10.
Connections and Statement Caching
Statement caching is managed separately for each connection. Therefore, for running
the same statement on different connections, you need to parse once for each
connection and cache a separate cursor for each connection.
Metadata Caching
This feature minimizes the retrieval of metadata for SELECT statements by caching the
metadata during the initial statement execution. Subsequent executions of the same
statement can reuse the cached metadata information for better performance. To see
performance gains from metadata caching, Oracle recommends caching only those
statements that are executed repeatedly.
Metadata caching is managed separately for each connection.
Therefore, to run the same statement on different connections, the
metadata must be cached once for each connection.
Note:
Enabling Metadata Caching Through the Connection String Attribute The

MetaDataCacheSize attribute enables or disables OraOLEDB metadata caching. If it
is set to a value greater than 0, OraOLEDB metadata caching is enabled and the value
specifies the maximum number of statements for which the metadata can be cached
for a connection. By default, this attribute is set to 10.
Enabling Metadata Caching Through the Registry To enable metadata caching by default for
all OraOLEDB applications running in a system, without changing the application, set
the following registry key to a value greater than 0. By default, it is set to 10.
\\HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\KEY_HOMENAME\
OLEDB\MetaDataCacheSize
Command Timeout and Cancel Method

The Cancel method cancels the OraOLEDB command currently being executed. This
method can be useful when the application needs to cancel a long running command
during times of heavy network traffic or heavy server use.
Alternatively, by using the CommandTimeout property, developers can set a limit to
the time that a command executes before OraOLEDB attempts to cancel it. OraOLEDB
requires setting the EnableCmdTimeout registry value to 1 to enable
CommandTimeout.
When using OLE DB, the default DPBROP_COMMANDTIMEOUT is 0 seconds. When
using ADO, the default CommandTimeout property is 30 seconds.
Enabling CommandTimeout Through the Registry Starting with OraOLEDB release
11.1.0.7.20, the installation adds a registry value called EnableCmdTimeout with the
default value set to 0. Setting it to 0 disables command timeout and setting it to 1
enables it. The CommandTimeout property value setting takes effect only when
EnableCmdTimeout is set to 1.
The registry value is:
\\HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\KEY_
HOMENAME\OLEDB\EnableCmdTimeout
Rowsets
This section discusses using Rowsets with OraOLEDB.
To Create Rowsets
OraOLEDB supports IOpenRowset::OpenRowset and ICommand::Execute for
creating rowsets.
To Create Rowsets with IOpenRowset::OpenRowset

When using IOpenRowset::OpenRowset, note the following guidelines:
The pTableID parameter must contain a DBID structure that specifies a base table
or a view.
The DBID structure's eKind member must be set to DBKIND_GUID_NAME,
DBKIND_NAME, or DBKIND_PGUID_NAME.
The DBID structure's uName member must specify the base table or view name as
a Unicode character string. It cannot be NULL.
The pIndexID parameter of OpenRowset must be NULL.
To Create Rowsets with ICommand::Execute

OraOLEDB supports SQL SELECT statements that return rowsets. OraOLEDB also
supports returning rowsets from PL/SQL stored procedures and functions.
By default, ADO creates a nonupdatable rowset from a command object. An updatable
rowset can be created by setting the Updatability and IRowsetChange properties
on the command object. The Updatability property can be set to the following
values:
Table 22
Possible Values for Updatability Property
Value
Description
update
delete
update and delete
insert
insert and update
insert and delete
insert, delete, and update
The following ADO code sample sets the Updatability property on a command
object to allow insert, delete, and update operations on the rowset object.
Dim Cmd As New ADODB.Command
Dim Rst As New ADODB.Recordset
Dim Con As New ADODB.Connection
...
Cmd.ActiveConnection = Con
Cmd.CommandText = "SELECT * FROM emp"
Cmd.CommandType = adCmdText
cmd.Properties("IRowsetChange") = TRUE
Cmd.Properties("Updatability") = 7
' creates an updatable rowset
Set Rst = cmd.Execute
Updatability
OraOLEDB supports both immediate and deferred update mode. However, insert and
update operations cannot be deferred when the operation changes a nonscalar column,
such as LONG, BLOB, or CLOB. When nonscalar column values are changed in a
deferred update mode, the entire row is transmitted to the database as though the
operation was in an immediate update mode. In addition, these operations cannot be
undone with the Undo method (ADO) or IRowsetUpdate::Undo(). However, if
they are in a transaction, they can be rolled back with RollbackTrans method
(ADO) or ITransactionLocal::Abort().
Rowsets created using queries with joins are updatable by OraOLEDB only with the
Client Cursor Engine enabled. C/C++ OLE DB consumers must enable this service to
make these rowsets updatable. ADO consumers must specify the CursorLocation
as adUseClient to make these rowsets updatable.
For example:
Dim objCon As New ADODB.Connection
Dim objRst As New ADODB.Recordset
objCon.Provider = "OraOLEDB.Oracle"
objCon.Open "MyOraDb", "scott", "tiger"
objRst.CursorLocation = adUseClient
'ADO Client Cursor
objRst.Open "select ename, dname " & _
"from emp, dept " & _
"where emp.deptno = dept.deptno", _
objCon, adOpenStatic, adLockOptimistic, adCmdText
'Recordset created is updatable. Please note that CursorLocation

'needs to be explicitly set to adUseClient for this join recordset
'to be updatable.
Server Data on Insert Property

If DBPROP_SERVERDATAONINSERT (Server Data on Insert) is set to TRUE using
OraOLEDB, the consumer can obtain defaults, sequences, and triggered column
values from newly inserted and updated rows, if the insert and update operations are
made through the rowset.
Having DBPROP_SERVERDATAONINSERT set to TRUE may degrade performance for
both insert and update executions using a rowset because OraOLEDB fetches row data
from the database for the newly inserted and updated row. However, if DBPROP_
SERVERDATAONINSERT is set to its default value of FALSE, only the explicitly
provided values for insert and update operations are returned when column values
are requested for those rows.
If the base table from which the rowset was created does not contain any defaults,
sequences, or triggers, then it is highly recommended that DBPROP_
SERVERDATAONINSERT retain its default value of FALSE.
The DBPROP_SERVERDATAONINSERT property does not affect the performance of
insert and update operations using the command object.
To Search for Rows with IRowsetFind::FindNext

OraOLEDB only supports searches performed on CHAR, DATE, FLOAT, NUMBER, RAW,
and VARCHAR2 columns. Otherwise, DB_E_NOTSUPPORTED is returned.
When a search is done with a NULL value, only the DBCOMPAREOPS_EQ and
DBCOMPAREOPS_NE compare operations are supported. Otherwise, DB_E_
NOTSUPPORTED is returned.
OraOLEDB-Specific Connection String Attributes for Rowsets

OraOLEDB-specific connection string attributes which affect the performance of the
rowset are:
CacheType - specifies the type of caching used by the provider to store rowset
data. OraOLEDB provides two caching mechanisms:
Memory - The provider stores all the rowset data in-memory. This caching
mechanism provides better performance at the expense of higher memory
utilization. The default is Memory.
File - The provider stores all the rowset data on disk. This caching mechanism
limits memory consumption at the expense of performance.
ChunkSize - This attribute specifies the size, in bytes, of the data in LONG and
LONG RAW columns fetched and stored in the provider cache. Providing a high
value for this attribute improves performance, but requires more memory to store
the data in the rowset. Valid values are 1 to 65535. The default is 100.
FetchSize - specifies the number of rows the provider will fetch at a time (fetch
array). It must be set on the basis of data size and the response time of the
network. If the value is set too high, then this could result in more wait time
during the execution of the query. If the value is set too low, then this could result
in many more round trips to the database. Valid values are 1 to 429,496, and
296. The default is 100.
DeferUpdChk - The DeferUpdChk attribute specifies whether or not to defer the
updateability check. This supports updating ADO read-only disconnected
rowsets. Valid values are 0 (FALSE) and 1 (TRUE). The default is FALSE, which
implies that OraOLEDB does not defer the check. If this attribute is not provided
at the connection time, then the default registry value is used.
The default attribute values are set in the registry. For more information, see "Default
Attribute Values" on page 2-8. The following ADO code example overrides the default
attribute values:
Dim con As ADODB.Connection
Set con = NEW ADODB.Connection
con.ConnectionString = "Provider=OraOLEDB.Oracle;User ID=scott;" & _
"Password=tiger;Data Source=MyOraDB;" & _
"FetchSize=200;CacheType=File;"
con.Open
Tips for ADO Programmers

Setting the ADO Rowset property LockType to adLockPessimistic is not
supported by Oracle Provider for OLE DB. If LockType is set to
adLockPessimistic, then OraOLEDB behaves similar to when set as
adLockOptimistic. This behavior occurs because OraOLEDB does not perform
explicit locks on the rows being modified. However, when new data is submitted to
the database, the database only performs the update if the rowset data was not already
updated by another user, which means that dirty writes are not allowed. LockType
values adLockReadOnly, adLockBatchOptimistic, and adLockOptimistic are
supported by OraOLEDB.
Setting ADO Rowset property CursorType to adOpenKeyset or adOpenDynamic is
not supported by Oracle Provider for OLE DB. OraOLEDB does not support either of
the two as Oracle supports Statement Level Read Consistency, which ensures that the
data returned by a query contains only committed data as of the time the query was
executed. CursorType values adOpenStatic and adOpenForwardOnly are
supported by OraOLEDB.
Schema Rowsets
The schema rowsets available through Oracle Provider for OLE DB are:
DBSCHEMA_COLUMNS
DBSCHEMA_INDEXES
DBSCHEMA_SCHEMATA
DBSCHEMA_VIEWS
DBSCHEMA_TABLES
DBSCHEMA_PROVIDER_TYPES (forward scroll only)
DBSCHEMA_FOREIGN_KEYS
DBSCHEMA_PRIMARY_KEYS
DBSCHEMA_PROCEDURES
DBSCHEMA_PROCEDURE_PARAMETERS
Date Formats
The date format for the Oracle session cannot be set using the ALTER SESSION SET
NLS_DATE_FORMAT command. In Visual Basic, date formats are controlled by the
Regional Settings properties in Windows Control Panel. For more information on
Visual Basic date formats, refer to your Visual Basic documentation.
For Oracle Provider for OLE DB, if the Connection property UseSessionFormat is
FALSE, which is a default value, then NLS_DATE_FORMAT is fixed for the session to
'YYYY-MM-DD HH24:MI:SS' by the provider. If you pass the date to Oracle
Database as a string, the date must be in the 'YYYY-MM-DD HH24:MI:SS' format. If
UseSessionFormat is TRUE, then NLS_DATE_FORMAT is not fixed by Oracle
Provider for OLE DB and the default session NLS_DATE_FORMAT is used. For
example:
SELECT * FROM EMP WHERE HIREDATE > '1981-06-15 17:32:12'
To use a different format, you need to use the SQL function, TO_DATE(), to specify
the format for dates passed as strings. For example:
SELECT * FROM EMP WHERE HIREDATE > TO_DATE('15-JUN-81', 'DD-MON-YY')
However, for dates passed as parameters, the date format is controlled by ADO, which
is controlled by the Regional Settings in Windows Control Panel. In this case, TO_
DATE() should not be used. For example:
Private Sub Command1_Click()
Dim objCon As New ADODB.Connection
Dim objCmd As New ADODB.Command
Dim objRst As New ADODB.Recordset
Dim pDate As New ADODB.Parameter
objCon.Provider = "OraOLEDB.Oracle"
objCon.Open "MyOraDb", "scott", "tiger"
Set pDate = objCmd.CreateParameter("pDate", adDate, adParamInput)
objCmd.Parameters.Append pDate
objCmd.CommandText = _
"SELECT * FROM EMP WHERE HIREDATE > ?"
pDate.Value = "06/15/1981"
Set objRst = objCmd.Execute
...
End Sub
Case of Object Names

The names of all objects (tables, columns, views, and so forth) in Oracle Database are
case-sensitive. This allows the two objects EMP and emp to exist in the same namespace
in the database.
The query, SELECT ename FROM emp, executes correctly even though the table
name is EMP (all uppercase) in the database. However, if you want to specify object
names in mixed case, you can do so by enclosing the name in double quotes. For
example:
SELECT ename FROM "Emp"
will execute successfully if the table name in the database is Emp. Double quotes
preserve the case of the object names in Oracle Database.
LOB Support
The ISequentialStream interface is supported for all LONG, LONG RAW, and LOB
(BLOB, CLOB, NCLOB, and BFILE) columns. The consumer can use this interface to
read and write to all the LOB columns, except BFILE which is read-only. To have read
and write access to these columns, the SELECT SQL statement used to create the
rowset should not contain a join.
Although most of the LOB columns in an Oracle Database
support up to 4 GB of data storage, ADO limits the maximum
column size to 2 GB.
Note:
Columns having the BFILE data type are not updatable in the Rowset interface.
However, these columns can be updated using the command interface, if the update is
limited to modifying the directory and name of the external file pointed to by the
BFILE column. For example:
INSERT INTO topomaps (areanum, topomap)
VALUES (158, BFILENAME('mapdir', 'topo158.tps'))
For more information on LOBs, see Oracle Database SecureFiles and Large Objects
Developer's Guide.
Unicode Support
OraOLEDB supports the Unicode character set. Using this feature, consumers can use
OraOLEDB to access data in multiple languages on the same client computer. It can be
especially useful in creating global Internet applications supporting as many
languages as the Unicode standard entails. For example, you can write a single Active
Server Page (ASP) application that accesses an Oracle9i Database to dynamically
generate contents in Japanese, Arabic, English, Thai, and so on.
Types of Unicode Encoding

The Oracle Databases store the Unicode data in the UTF8 encoding scheme, which is
an ASCII compatible multibyte encoding of Unicode. Microsoft Windows 2000 uses
the UCS2 encoding, which is a 2-byte fixed-width encoding scheme. OraOLEDB
transparently converts the data between the two encoding schemes allowing the
consumers to deal with only UCS2.
The Unicode support is transparent to ADO consumers.

OLE DB consumers using C or C++ need to explicitly specify
DBTYPE_WSTR in their data type bindings when Unicode data in
involved.
Note:
How Oracle Unicode Support Works

OraOLEDB works in two modes, Unicode mode and nonUnicode mode. When the
client character set is not a superset of the server character set or the database
character set is a multibyte character set, OraOLEDB automatically enables the
Unicode mode. In this mode, OraOLEDB stores the data in its cache in the UCS2
encoding scheme. The user should ensure that the database's character set is UTF8 to
prevent any data loss.
If the client character set is a superset of the server's, then the provider operates in the
nonUnicode mode. This mode provides slightly better performance as it does not have
to deal with larger character buffers required by the UCS2 encoding.
The detection of the client's and the server's character set is performed during logon.
Note: OraOLEDB no longer requires the client character set to be
set to UTF8 to enable the Unicode mode. The provider still
supports such setups but no longer requires it.
See "Data Type Mappings in Rowsets and Parameters" on page A-1 for further
information.
Unicode Support Setup

To prevent any data loss, the database character set should be UTF8. Other than this,
there is no other setup required for Unicode support.
Database Setup You must ensure that the Oracle Database is configured to store the
data in the UTF8 character set. The character set configuration is typically specified
during database creation. To check the character set setting of your database, execute
the following query in SQL*Plus:
SQL> SELECT parameter, value FROM nls_database_parameters
WHERE parameter = 'NLS_CHARACTERSET';
If the character set of your database is not UTF8, you need to create a new database
with the UTF8 character set and import your data into it. See Oracle Database
Administrator's Guide for more information.
See Also: Oracle Database Globalization Support Guide for general
information
Errors
OLE and COM objects report errors through the HRESULT return code of the object
member functions. An OLE/COM HRESULT return code is a bit-packed structure.
OLE provides macros that dereference structure members. OraOLEDB exposes
IErrorLookup to retrieve information about an error.
All objects support extended error information. For this, the consumer must instantiate
the OLE DB Extended Error object followed by calling the method
GetErrorDescription() to get the error text.
// Instantiate OraOLEDBErrorLookup and obtain a pointer to its
//
IErrorLookup interface
CoCreateInstance(CLSID_OraOLEDBErrorLookup, NULL, CLSCTX_INPROC_SERVER,
IID_IErrorLookup, (void **)&pIErrorLookup)
//Call the method GetErrorDescription() to get the full error text
pIErrorLookup->GetErrorDescription()
The OraOLEDB provider returns the entire error stack in one text block.
For ADO users, the following example applies:
Dim oerr As ADODB.Error
For Each oerr in con.Errors
MsgBox "Error: " & oerr.Description & vbCrLf _
& "Source: " & oerr.Source
Next
OLEDB.NET Data Provider Compatibility

The OLE DB .NET Data Provider can utilize OraOLEDB as the OLE DB Provider for
accessing Oracle Database.
To make OraOLEDB compatible with OLE DB .NET Data Provider, set the connection
string attribute OLEDB.NET to True.
Setting the OLEDB.NET attribute to False disables .NET compatibility.
Note: The OLEDB.NET connection string attribute must not be
used in ADO applications.
Using the OLEDB.NET Attribute in a Connection String

When using OraOLEDB with the OLE DB .NET Data Provider, the OLEDB.NET
connection attribute must be set to True as shown in the following examples:
// in VB.NET
Dim con As New OleDbConnection()
con.ConnectionString = "Provider=OraOLEDB.Oracle;User Id=scott;" & _
"Password=tiger;Data Source=Oracle;OLEDB.NET=True;"
con.Open
// in C#
...
OleDbConnection con = new OleDbConnection();
con.ConnectionString = "Provider=OraOLEDB.Oracle;User Id=scott;" +
"Password=tiger;Data Source=Oracle;OLEDB.NET=true;"
con.Open();
...
Using OraOLEDB Custom Properties

ADO allows OraOLEDB provider-specific properties to be set at the object level. The
OraOLEDB-specific properties SPPrmsLOB and NDatatype can be set as connection
string attributes as well as at the command-object level. The StmtCacheSize

property can be set as a connection string attribute and the AddToStmtCache
property can be set at the command object level. The following example shows the
setting of properties at the command level:
// in VB
Dim cmd as new ADODB.Command
...
cmd.Properties("SPPrmsLOB") = True
cmd.Properties("NDatatype") = True
cmd.Properties("AddToStmtCache") = True
...
However, the OLEDB.NET Data Provider cannot expose OLE DB provider-specific

properties at the object level. Therefore, the SPPrmsLOB and NDatatype properties
can only be set as connection string attributes and AddToStmtCache property is not
supported when OraOLEDB is used by OLE DB .NET Data Provider:
// in VB.NET
Dim con As New OleDbConnection()
con.ConnectionString = "Provider=OraOLEDB.Oracle;User Id=scott;" & _
"Password=tiger;Data Source=Oracle;OLEDB.NET=True;" & _
"SPPrmsLOB=False;NDatatype=False;"
con.Open()
Both SPPrmsLOB and NDatatype connection string attributes are set to False by
default if they are not specified.
Setting either of these connection string attributes to True incurs additional
processing overhead when executing commands with parameters. For this reason,
before setting either attribute to True, see "OraOLEDB Custom Properties for
Commands" on page 2-12.
Updating Oracle with DataTable Changes

In order for the OleDbDataAdapter.Update() method to properly update Oracle
Database with changes made in DataTable, which must contain a primary key of a
database table. If the database table does not contain a primary key, the ROWID must
be selected explicitly when populating DataTable, so that the ROWID can be used to
uniquely identify a row when updating a row in the database.
Do not select the ROWID from database tables that contains a primary key. If ROWID is
selected along with a primary key, ROWID will be the only column marked as the
primary key.
See Also: For further information on using the OLE DB .NET
Data Provider
Microsoft .NET Documentation
Microsoft .NET Framework Class Library

The following simple example illustrates how to use Oracle Provider for OLE DB with
ADO in Visual Basic 6.0 to connect to an Oracle Database and execute PL/SQL stored
procedures and functions.
Setting Up the Oracle Database

This example assumes that the Oracle Database has the demonstration table EMP
under the user account scott. The scott account is included in the Oracle starter
database. If the account does not exist on your database, create the account before
running the sample program. If your database does not contain the emp table, then
you can use the demobld.sql script to create the demonstration tables.
This example also uses exampledb as the database network alias when connecting to
the Oracle Database. You must change this network alias to match your system.
Step 1 Build the Sample Tables:
1. Start SQL*Plus.
2.
Connect as username scott with the password tiger.
3.
Run the demobld.sql script:

SQL> @ORACLE_BASE\ORACLE_HOME\sqlplus\demo\demobld.sql;
After the emp table has been created in the scott account, you need to create the
PL/SQL package that contains the stored procedure and function that are run in the
Visual Basic example.
Step 2 Create the PL/SQL package:
1. Connect as username scott with the password tiger.
2.
Create the PL/SQL packages shown in "PL/SQL Package" on page 2-16.

When creating PL/SQL packages the / character is used as
a terminator and must be added on a separate line following each
CREATE PACKAGE...END block.
Note:
Setting Up the Visual Basic Project

After the Oracle Database setup is completed, you can create the Visual Basic 6.0
project.
1.
Start Visual Basic 6.0 and create a new project.
2.
Make sure that the Microsoft ActiveX Data Objects 2.1 Library and Microsoft
ActiveX Data Objects Recordset 2.1 Library are included as Project References.
3.
Add two command buttons to the form. One of the buttons will run the code to
execute the PL/SQL procedure GetEmpRecords. The other will run the code to
execute the PL/SQL function GetDept.
4.
Add the following code to the Click subroutine of the button that will run the
code to execute the PL/SQL procedure GetEmpRecords.
Dim
Dim
Dim
Dim
Dim
Dim
Dim
Oracon As ADODB.Connection
recset As New ADODB.Recordset
cmd As New ADODB.Command
param1 As New ADODB.Parameter
param2 As New ADODB.Parameter
objErr As ADODB.Error
Message, Title, Default, EmpNoValue
Message = "Enter an employee number (5000 - 9000)"

Title = "Choose an Employee"
Default = "7654"
On Error GoTo err_test
EmpNoValue = InputBox(Message, Title, Default)
If EmpNoValue = "" Then Exit Sub
If EmpNoValue < 5000 Or EmpNoValue > 9000 Then EmpNoValue = 7654
Set Oracon = CreateObject("ADODB.Connection")
Oracon.ConnectionString = "Provider=OraOLEDB.Oracle;" & _
"Data Source=exampledb;" & _
"User ID=scott;" & _
"Password=tiger;"
Oracon.Open
Set cmd.ActiveConnection = Oracon
Set param1 = cmd.CreateParameter("param1", adSmallInt, adParamInput, ,
EmpNoValue)
cmd.Parameters.Append param1
Set param2 = cmd.CreateParameter("param2", adSmallInt, adParamOutput)
cmd.CommandText = "{CALL Employees.GetDept(?, ?)}"
Set recset = cmd.Execute
MsgBox "Number: " & EmpNoValue & "
Dept: " & recset.Fields("deptno").Value
Exit Sub
err_test:
MsgBox Error$
For Each objErr In Oracon.Errors
MsgBox objErr.Description
Next
Oracon.Errors.Clear
Resume Next
5.
Add the following code to the Click subroutine of the button that will run the
code to execute the PL/SQL function GetDept.
Dim
Dim
Dim
Dim
Dim
Dim
Oracon
recset
cmd As
param1
param2
objErr
As ADODB.Connection
As New ADODB.Recordset
New ADODB.Command
As New ADODB.Parameter
As New ADODB.Parameter
As ADODB.Error
Dim Message, Title, Default, DeptValue

Message = "Enter a department number (10, 20, or 30)"
Title = "Choose a Department"
Default = "30"
On Error GoTo err_test
DeptValue = InputBox(Message, Title, Default)
If DeptValue = "" Then Exit Sub
If DeptValue < 10 Or DeptValue > 30 Then DeptValue = 30

Set Oracon = CreateObject("ADODB.Connection")
Oracon.ConnectionString = "Provider=OraOLEDB.Oracle;" & _
"Data Source=exampledb;" & _
"User ID=scott;" & _
"Password=tiger;"
Oracon.Open
Set cmd = New ADODB.Command
Set cmd.ActiveConnection = Oracon
Set param1 = cmd.CreateParameter("param1", adSmallInt, adParamInput, ,
DeptValue)
Set param2 = cmd.CreateParameter("param2", adSmallInt, adParamOutput)
cmd.CommandText = "{CALL Employees.GetEmpRecords(?, ?)}"
Set recset = cmd.Execute
Do While Not recset.EOF
MsgBox "Number: " & recset.Fields("empno").Value & " Name: " &
recset.Fields("ename").Value & " Dept: " & recset.Fields("deptno").Value
recset.MoveNext
Loop
Exit Sub
err_test:
MsgBox Error$
For Each objErr In Oracon.Errors
MsgBox objErr.Description
Next
Oracon.Errors.Clear
Resume Next
6.
Run the project and check the results. For example, if you choose the Get
Employee Records by Dept button, then you would see a dialog box requesting
that you enter a department number.
After you have entered a department number and clicked OK, another dialog box
displays employee names and numbers from that department.
A
A
This appendix describes OLE DB information that is specific to Oracle Provider for
OLE DB. For generic OLE DB information that includes a detailed listing of all OLE
DB properties and interfaces, see the Microsoft OLE DB Programmer's Reference Guide.
This appendix contains these topics:
Data Type Mappings in Rowsets and Parameters
Properties Supported
Interfaces Supported
MetaData Columns Supported
OraOLEDB Tracing
Data Type Mappings in Rowsets and Parameters

This section lists the data type mapping between Oracle data types and OLE
DB-defined types. Oracle Provider for OLE DB represents Oracle data types by using
certain OLE DB-defined data types in the rowset as well as in parameters. OLE
DB-defined types are also mapped to an Oracle data type when creating tables.
Each Oracle data type is mapped to a specific OLE DB data type, as shown in
Table A1. This correspondence is used when data type information is retrieved from
an Oracle Database.
Table A1
Data Type Mappings
Oracle Data Type
OLE DB Data Type Regular (NonUnicode) Mode
OLE DB Data Type Unicode Mode
BFILE
DBTYPE_BYTES
DBTYPE_BYTES
BINARY_FLOAT
DBTYPE_R4
DBTYPE_R4
BINARY_DOUBLE
DBTYPE_R8
DBTYPE_R8
BLOB
DBTYPE_BYTES
DBTYPE_BYTES
CHAR
DBTYPE_STR
DBTYPE_WSTR
CLOB
DBTYPE_STR
DBTYPE_WSTR
DATE
DBTYPE_DBTIMESTAMP
DBTYPE_DBTIMESTAMP
FLOAT
DBTYPE_R8
DBTYPE_R8
INTERVAL DAY TO
SECOND
DBTYPE_STR
DBTYPE_WSTR
Provider-Specific Information A-1
Table A1 (Cont.) Data Type Mappings

OLE DB Data Type Regular (NonUnicode) Mode
OLE DB Data Type Unicode Mode
INTERVAL YEAR TO
MONTH
DBTYPE_STR
DBTYPE_WSTR
LONG
DBTYPE_STR
DBTYPE_WSTR
LONG RAW
BTYPE_BYTES
DBTYPE_BYTES
NCHAR
DBTYPE_STR
DBTYPE_WSTR
NCLOB
DBTYPE_STR
DBTYPE_WSTR
NUMBER
DBTYPE_VARNUMERIC
DBTYPE_VARNUMERIC
NUMBER(p,s)
DBTYPE_NUMERIC
DBTYPE_NUMERIC
NVARCHAR2
DBTYPE_STR
DBTYPE_WSTR
RAW
DBTYPE_BYTES
DBTYPE_BYTES
ROWID
DBTYPE_STR
DBTYPE_STR
TIMESTAMP
DBTYPE_DBTIMESTAMP
DBTYPE_DBTIMESTAMP
TIMESTAMP WITH TIME

ZONE
DBTYPE_DBTIMESTAMP
DBTYPE_DBTIMESTAMP
TIMESTAMP WITH LOCAL DBTYPE_DBTIMESTAMP

TIME ZONE
DBTYPE_DBTIMESTAMP
VARCHAR
DBTYPE_WSTR
Oracle Data Type
DBTYPE_STR
This section lists the properties supported by Oracle Provider for OLE DB. The
read/write status and initial values are noted.
Data Source Properties
DataSourceInfo Properties
Initialization and Authorization Properties
Session Properties
Rowset Properties
Data Source Properties

Table A2 lists data source properties.
Table A2
DBPROPSET_DATASOURCE Properties
Property
Status
Initial Value
DBPROP_CURRENTCATALOG
READ-ONLY
NULL
DataSourceInfo Properties
Table A3 lists DataSourceInfo properties.
A-2 Oracle Provider for OLE DB Developer's Guide
Table A3
DBPROPSET_DATASOURCEINFO Properties
Property
Status
Initial Value
DBPROP_ACTIVESESSIONS
READ-ONLY
0, Unlimited sessions
DBPROP_ASYNCTXNABORT
READ-ONLY
VARIANT_FALSE
DBPROP_ASYNCTXNCOMMIT
READ-ONLY
VARIANT_FALSE
DBPROP_BYREFACCESSORS
READ-ONLY
VARIANT_TRUE
DBPROP_CATALOGLOCATION
READ-ONLY
DBPROPVAL_CL_END
DBPROP_CATALOGTERM
READ-ONLY
"Database link"
DBPROP_CATALOGUSAGE
READ-ONLY
DBPROPVAL_CU_DML_STATEMENTS
DBPROP_COLUMNDEFINITION
READ-ONLY
DBPROPVAL_CD_NOTNULL
DBPROP_CONCATNULLBEHAVIOR
READ-ONLY
DBPROPVAL_CB_NON_NULL
DBPROP_CONNECTIONSTATUS
READ-ONLY
DBPROPVAL_CS_INITIALIZED
DBPROP_DATASOURCENAME
READ-ONLY
" ", set at run time
DBPROP_DATASOURCEREADONLY
READ-ONLY
VARIANT_FALSE
DBPROP_DBMSNAME
READ-ONLY
DBPROP_DBMSVER
READ-ONLY
set at run time
DBPROP_DSOTHREADMODEL
READ/WRITE
DBPROPVAL_RT_FREETHREAD
DBPROP_GROUPBY
READ-ONLY
DBPROPVAL_GB_CONTAINS_SELECT
DBPROP_HETEROGENEOUSTABLES
READ-ONLY
DBPROPVAL_HT_DIFFERENT_CATALOGS
DBPROP_IDENTIFIERCASE
READ-ONLY
DBPROPVAL_IC_UPPER
DBPROP_MAXINDEXSIZE
READ-ONLY
0, limit unknown - depends on block size
DBPROP_MAXOPENCHAPTERS
READ-ONLY
0, not supported
DBPROP_MAXORSINFILTER
READ-ONLY
0, not supported
DBPROP_MAXROWSIZE
READ-ONLY
0, no limit
DBPROP_MAXROWSIZEINCLUDESBLOB
READ-ONLY
VARIANT_FALSE
DBPROP_MAXSORTCOLUMNS
READ-ONLY
0, not supported
DBPROP_MAXTABLESINSELECT
READ-ONLY
0, no limit
DBPROP_MULTIPLEPARAMSETS
READ-ONLY
VARIANT_TRUE
DBPROP_MULTIPLERESULTS
READ-ONLY
DBPROP_MR_SUPPORTED
_MR_CONCURRENT
DBPROP_MULTIPLESTORAGEOBJECTS
READ-ONLY
VARIANT_FALSE
DBPROP_MULTITABLEUPDATE
READ-ONLY
VARIANT_FALSE
DBPROP_NULLCOLLATION
READ-ONLY
DBPROPVAL_NC_HIGH
DBPROP_OLEOBJECTS
READ-ONLY
DBPROPVAL_OO_BLOB
DBPROP_ORDERBYCOLUMNSINSELECT
READ-ONLY
VARIANT_FALSE
DBPROP_OUTPUTPARAMETERAVAILABILITY READ-ONLY
| DBPROPVAL_
DBPROPVAL_OA_ATEXECUTE
DBPROP_PERSISTENTIDTYPE
READ-ONLY
DBPROPVAL_PT_NAME
DBPROP_PREPAREABORTBEHAVIOR
READ-ONLY
DBPROPVAL_CB_PRESERVE
DBPROP_PREPARECOMMITBEHAVIOR
READ-ONLY
DBPROPVAL_CB_PRESERVE
Table A3 (Cont.) DBPROPSET_DATASOURCEINFO Properties

Property
Status
Initial Value
DBPROP_PROCEDURETERM
READ-ONLY
"PL/SQL Stored Procedure"
DBPROP_PROVIDERFRIENDLYNAME
READ-ONLY
"Oracle Provider for OLE DB"
DBPROP_PROVIDERNAME
READ-ONLY
OraOLEDBver.dll
DBPROP_PROVIDEROLEDBVER
READ-ONLY
"02.01"
DBPROP_PROVIDERVER
READ-ONLY
set to current OraOLEDB version
DBPROP_QUOTEDIDENTIFIERCASE
READ-ONLY
DBPROPVAL_IC_SENSITIVE
DBPROP_ROWSETCONVERSIONSONCOMMAND
READ-ONLY
VARIANT_TRUE
DBPROP_SCHEMATERM
READ-ONLY
"Owner"
DBPROP_SCHEMAUSAGE
READ-ONLY
DBPROPVAL_SU_DML_STATEMENTS |
DBPROPVAL_SU_TABLE_DEFINITION |
DBPROPVAL_SU_INDEX_DEFINITION |
DBPROPVAL_SU_PRIVILEGE_DEFINITION
DBPROP_SERVERNAME
READ-ONLY
DBPROP_SORTONINDEX
READ-ONLY
VARIANT_FALSE
DBPROP_SQLSUPPORT
READ-ONLY
DBPROPVAL_SQL_ODBC_MINIMUM |
DBPROPVAL_SQL_ANSI92_ENTRY |
DBPROPVAL_SQL_ESCAPECLAUSES
DBPROP_STRUCTUREDSTORAGE
READ-ONLY
DBPROPVAL_SS_ISEQUENTIAL_STREAM
DBPROP_SUBQUERIES
READ-ONLY
DBPROPVAL_SQ_CORRELATEDSUBQUERIES
DBPROP_SUPPORTEDTXNDDL
READ-ONLY
DBPROPVAL_TC_DDL_COMMIT
DBPROP_SUPPORTEDTXNISOLEVELS
READ-ONLY
DBPROPVAL_TI_CURSORSTABILITY |
DBPROPVAL_TI_READCOMMITTED
DBPROP_SUPPORTEDTXNISORETAIN
READ-ONLY
DBPROPVAL_TR_DONTCARE
DBPROP_TABLETERM
READ-ONLY
"Table"
DBPROP_USERNAME
READ-ONLY
Initialization and Authorization Properties

Table A4 lists initialization and authorization properties.
Table A4
DBPROPSET_DBINIT Properties
Property
Status
Initial Value
DBPROP_AUTH_PERSIST_SENSITIVE_
AUTHINFO
READ-ONLY
VARIANT_FALSE
DBPROP_AUTH_USERID
READ/WRITE
User ID
DBPROP_INIT_DATASOURCE
READ/WRITE
Connect string
DBPROP_INIT_HWND
READ/WRITE
Window handle for prompt
DBPROP_INIT_LCID
READ/WRITE
LCID of system
DBPROP_INIT_OLEDBSERVICES
READ/WRITE
DBPROPVAL_OS_ENABLEALL
DBPROP_INIT_PROMPT
READ/WRITE
DBPROMPT_NOPROMPT
Session Properties
Table A5 lists session properties.
Table A5
DBPROPSET_SESSION Properties
Property
Status
Initial Value
DBPROP_SESS_AUTOCOMMITISOLEVELS
READ-ONLY
DBPROPVAL_TI_CURSORSTABILITY |
DBPROPVAL_TI_READCOMMITTED
Rowset Properties
Table A6 lists rowset properties.
Table A6
DBPROPSET_ROWSET Properties
Property
Status
Initial Value
DBPROP_ABORTPRESERVE
READ/WRITE
VARIANT_TRUE
DBPROP_ACCESSORORDER
READ-ONLY
DBPROP_AO_RANDOM
DBPROP_APPENDONLY
READ-ONLY
VARIANT_FALSE
DBPROP_BLOCKINGSTORAGEOBJECTS
READ-ONLY
VARIANT_FALSE
DBPROP_BOOKMARKINFO
READ-ONLY
DBPROP_BOOKMARKS
READ/WRITE
VARIANT_FALSE
DBPROP_BOOKMARKSKIPPED
READ/WRITE
VARIANT_TRUE
DBPROP_BOOKMARKTYPE
READ-ONLY
DBPROP_BMK_NUMERIC
DBPROP_CACHEDEFERRED
READ-ONLY
VARIANT_FALSE
DBPROP_CANFETCHBACKWARDS
READ/WRITE
VARIANT_FALSE
DBPROP_CANHOLDROWS
READ/WRITE
VARIANT_FALSE
DBPROP_CANSCROLLBACKWARDS
READ/WRITE
VARIANT_FALSE
DBPROP_CHANGEINSERTEDROWS
READ-ONLY
VARIANT_TRUE
DBPROP_CLIENTCURSOR
READ/WRITE
VARIANT_TRUE
DBPROP_COLUMNRESTRICT
READ-ONLY
VARIANT_TRUE
DBPROP_COMMANDTIMEOUT
READ/WRITE
DBPROP_COMMITPRESERVE
READ/WRITE
VARIANT_TRUE
DBPROP_DEFERRED
READ-ONLY
VARIANT_TRUE
DBPROP_DELAYSTORAGEOBJECTS
READ-ONLY
VARIANT_TRUE, no delayed update
DBPROP_FINDCOMPAREOPS
READ-ONLY
DBPROPVAL_CO_EQUALITY |
DBPROPVAL_CO_STRING |
DBPROPVAL_CO_CASESENSITIVE |
DBPROPVAL_CO_CASEINSENSITIVE |
DBPROPVAL_CO_CONTAINS |
DBPROPVAL_CO_BEGINSWITH
DBPROP_HIDDENCOLUMNS
READ-ONLY
DBPROP_IACCESSOR
READ-ONLY
VARIANT_TRUE
DBPROP_ICOLUMNSINFO
READ-ONLY
VARIANT_TRUE
DBPROP_ICOLUMNSROWSET
READ/WRITE
VARIANT_TRUE
DBPROP_ICONNECTIONPOINTCONTAINER
READ-ONLY
VARIANT_TRUE
Table A6 (Cont.) DBPROPSET_ROWSET Properties

Property
Status
Initial Value
DBPROP_ICONVERTTYPE
READ-ONLY
VARIANT_TRUE
DBPROP_IMMOBILEROWS
READ-ONLY
VARIANT_TRUE
DBPROP_IMULTIPLERESULTS
READ/WRITE
VARIANT_TRUE
DBPROP_IROWSET
READ-ONLY
VARIANT_TRUE
DBPROP_IROWSETCHANGE
READ/WRITE
VARIANT_FALSE
DBPROP_IROWSETFIND
READ/WRITE
VARIANT_FALSE
DBPROP_IROWSETIDENTITY
READ-ONLY
VARIANT_TRUE
DBPROP_IROWSETINFO
READ-ONLY
VARIANT_TRUE
DBPROP_IROWSETLOCATE
READ/WRITE
VARIANT_FALSE
DBPROP_IROWSETREFRESH
READ/WRITE
VARIANT_FALSE
DBPROP_IROWSETSCROLL
READ/WRITE
VARIANT_FALSE
DBPROP_IROWSETUPDATE
READ/WRITE
VARIANT_FALSE
DBPROP_ISEQUENTIALSTREAM
READ/WRITE
VARIANT_TRUE
DBPROP_ISUPPORTERRORINFO
READ/WRITE
VARIANT_TRUE
DBPROP_LITERALBOOKMARKS
READ-ONLY
VARIANT_FALSE
DBPROP_LITERALIDENTITY
READ-ONLY
VARIANT_FALSE
DBPROP_LOCKMODE
READ-ONLY
DBPROPVAL_LM_NONE
DBPROP_MAXOPENROWS
READ/WRITE
0, No limit
DBPROP_MAXPENDINGROWS
READ-ONLY
0, No limit
DBPROP_MAXROWS
READ/WRITE
DBPROP_MAXROWSIZE
READ-ONLY
DBPROP_MAXROWSIZEINCLUDESBLOB
READ-ONLY
VARIANT_FALSE
DBPROP_NOTIFICATIONGRANULARITY
READ/WRITE
DBPROPVAL_NT_MULTIPLEROWS
DBPROP_NOTIFICATIONPHASES
READ/WRITE
DBPROPVAL_NP_OKTODO |
DBPROPVAL_NP_ABOUTTODO |
DBPROPVAL_NP_SYNCHAFTER |
DBPROPVAL_NP_FAILEDTODO |
DBPROPVAL_NP_DIDEVENT
DBPROP_NOTIFYCOLUMNSET
READ/WRITE
DBPROP_NOTIFYROWDELETE
READ/WRITE
DBPROP_NOTIFYROWFIRSTCHANGE
READ/WRITE
DBPROPVAL_NP_ABOUTTODO

Property
Status
Initial Value
DBPROP_NOTIFYROWINSERT
READ/WRITE
DBPROP_NOTIFYROWRESYNCH
READ/WRITE
DBPROPVAL_NP_SYNCHAFTER
DBPROP_NOTIFYROWSETRELEASE
READ/WRITE
DBPROP_
NOTIFYROWSETFETCHPOSITIONCHANGE
READ/WRITE
DBPROP_NOTIFYROWUNDOCHANGE
READ/WRITE
DBPROP_NOTIFYROWUNDODELETE
READ/WRITE
DBPROP_NOTIFYROWUNDOINSERT
READ/WRITE
DBPROP_NOTIFYROWUNDOUPDATE
READ/WRITE
DBPROP_ORDEREDBOOKMARKS
READ-ONLY
VARIANT_TRUE
DBPROP_OTHERINSERT
READ-ONLY
VARIANT_FALSE
DBPROP_OTHERUPDATEDELETE
READ-ONLY
VARIANT_FALSE
DBPROP_OWNINSERT
READ-ONLY
VARIANT_TRUE
DBPROP_OWNUPDATEDELETE
READ-ONLY
VARIANT_TRUE
DBPROP_QUICKRESTART
READ/WRITE
VARIANT_FALSE
DBPROP_REENTRANTEVENTS
READ-ONLY
VARIANT_FALSE
DBPROP_REMOVEDELETED
READ-ONLY
VARIANT_TRUE
DBPROP_REPORTMULTIPLECHANGES
READ-ONLY
VARIANT_FALSE
DBPROP_RETURNPENDINGINSERTS
READ/WRITE
VARIANT_TRUE
DBPROP_ROWRESTRICT
READ/WRITE
VARIANT_FALSE
DBPROP_ROWTHREADMODEL
READ-ONLY
DBPROPVAL_RT_FREETHREAD
DBPROP_SERVERCURSOR
READ/WRITE
VARIANT_FALSE
DBPROP_SERVERDATAONINSERT
READ/WRITE
VARIANT_TRUE

Property
Status
Initial Value
DBPROP_STRONGIDENTITY
READ/WRITE
VARIANT_TRUE
DBPROP_TRANSACTEDOBJECT
READ-ONLY
VARIANT_TRUE
DBPROP_UNIQUEROWS
READ/WRITE
VARIANT_FALSE
DBPROP_UPDATABILITY
READ/WRITE
DBPROPVAL_UP_CHANGE |
DBPROPVAL_UP_DELETE |
DBPROPVAL_UP_INSET
Rowset Property Implications

Oracle Provider for OLE DB sets other necessary properties if a particular property is
set to VARIANT_TRUE.
If DBPROP_IROWSETLOCATE is set to VARIANT_TRUE, then the following

properties are also set to VARIANT_TRUE:
DBPROP_CANHOLDROWS
DBPROP_BOOKMARKS
If DBPROP_IROWSETSCROLL is set to VARIANT_TRUE, then the following

properties are also set to VARIANT_TRUE:
DBPROP_IROWSETLOCATE
DBPROP_CANHOLDROWS
DBPROP_BOOKMARKS
If DBPROP_IROWSETUPDATE is set to VARIANT_TRUE, then the DBPROP_

IROWSETCHANGE property is also set to VARIANT_TRUE.
This section identifies the OLE DB interfaces that are supported by Oracle Provider for
OLE DB.
Data Source
Session
Command
Rowset
Multiple Results
Transaction Options
Custom Error Object
Data Source
CoType TDataSource {
interface IDBCreateSession;
interface IDBInitialize;
interface IDBProperties;
interface IPersist;
interface IDBInfo;
interface ISupportErrorInfo;
}
Session
CoType TSession {
interface IGetDataSource;
interface IOpenRowset;
interface ISessionProperties;
interface IDBCreateCommand;
interface IDBSchemaRowset;
interface ITransactionJoin;
interface ITransactionLocal;
interface ITransaction;
}
Command
CoType TCommand {
interface IAccessor;
interface IColumnsInfo;
interface ICommand;
interface ICommandProperties;
interface ICommandText;
interface IConvertType;
interface IColumnsRowset;
interface ICommandPrepare;
interface ICommandWithParameters;
}
Rowset
CoType TRowset {
interface IAccessor;
interface IColumnsInfo;
interface IConvertType;
interface IRowset;
interface IRowsetInfo;
interface IColumnsRowset;
interface IConnectionPointContainer;
interface IRowsetChange;
interface IRowsetFind;
interface IRowsetIdentity;
interface
interface
interface
interface
interface
IRowsetLocate;
IRowsetRefresh;
IRowsetScroll;
IRowsetUpdate;
ISupportErrorInfo;
Multiple Results
CoType TMultipleResults {
interface IMultipleResults;
}
Transaction Options
CoType TTransactionOptions {
interface ITransactionOptions;
}
Custom Error Object

CoType TCustomErrorObject {
interface IErrorLookup;
}

DBTYPE_BASECOLUMNNAME, DBTYPE_BASETABLENAME, and DBTYPE_
BASESCHEMANAME metadata columns are not populated for read-only recordsets.
OraOLEDB creates a read-only recordset for server cursor for SQL queries with
DISTINCT or UNIQUE keywords. OraOLEDB also creates a read-only recordset for
server cursor for JOIN queries.
The following metadata columns are supported by the column rowset of OraOLEDB:
DBCOLUMN_IDNAME
DBCOLUMN_PROPID
DBCOLUMN_NAME
DBCOLUMN_NUMBER
DBCOLUMN_TYPE
DBCOLUMN_TYPEINFO
DBCOLUMN_COLUMNSIZE
DBCOLUMN_PRECISION
DBCOLUMN_SCALE
DBCOLUMN_FLAGS
DBCOLUMN_BASECATALOGNAME
OraOLEDB Tracing
DBCOLUMN_BASECOLUMNNAME
DBCOLUMN_BASESCHEMANAME
DBCOLUMN_BASETABLENAME
DBCOLUMN_COMPUTEMODE
DBCOLUMN_ISAUTOINCREMENT
DBCOLUMN_ISCASESENSITIVE
DBCOLUMN_ISSEARCHABLE
DBCOLUMN_OCTETLENGTH
DBCOLUMN_KEYCOLUMN
OraOLEDB Tracing
OraOLEDB provides the ability to trace the interface calls for debugging purposes.
This feature has been provided to assist Oracle Support Services in debugging
customer issues.
The provider can be configured to record the following information:
For OLE DB Interface method entry and exit:
Parameter values supplied (entry)
Return value; HRESULT (exit)
Thread ID (entry and exit)
For Distributed transaction enlistment and delistment:
Session object information
Transaction ID
To record global transaction enlistment and delistment
information, the TraceLevel value must be set to session object.
See "TraceLevel" on page A-12.
Note:
Registry Setting for Tracing Calls

To trace the interface calls, you must configure the following registry values for HKEY_
LOCAL_MACHINE\SOFTWARE\ORACLE\KEY_HOMENAME\OLEDB\:
TraceFileName
Valid Value: Any valid path and file name
TraceFileName specifies the file name that is to be used for logging trace
information. If TraceOption is set to 0, the name is used as is. However, if
TraceOption is 1, then the thread ID is appended to the file name provided. See
"TraceOption" for more information.
TraceCategory
Valid Values:
0 = None
1 = OLEDB Interface method entry
A-11
OraOLEDB Tracing
2 = OLEDB Interface method exit
4 = Distributed Transaction Enlistment and Delistment
TraceCategory specifies the information that is to be traced. Combinations of

different tracing categories can be made by adding the valid values. For example,
set TraceCategory to 3 to trace all OLE DB interface method entries and exits.
TraceLevel
Valid Values:
0 = None
1 = Data Source object
2 = Session object
4 = Command object
8 = Rowset object
16 = Error object
64 = Multiple Results Object
TraceLevel specifies the OLE DB objects to be traced. Because tracing all the
entry and exit calls for all the OLE DB objects can be excessive, TraceLevel is
provided to limit tracing to a single or multiple OLE DB objects. To obtain tracing
on multiple objects, add the valid values. For example, if TraceLevel is set to 12
and TraceCategory is set to 3, the trace file will only contain method entry and
exit for Command and Rowset objects.
The TraceLevel value must be set to session object (2) to trace global transaction
enlistment and delistment information.
TraceOption
Valid Values:
0 = Single trace file
1 = Multiple trace files
TraceOption specifies whether to log trace information in single or multiple files

for each Thread ID. If a single trace file is specified, the file name specified in
TraceFileName is used. If multiple trace file is requested, a Thread ID is
appended to the file name provided to create a trace file for each thread.
Glossary
Component Object Model (COM)
A binary standard that enables objects to interact with other objects, regardless of
the programming language that each object was written in.
consumer
A consumer is any application or tool that calls to a data source or the interfaces of
provider to access data. See provider.
Oracle Net Services
The Oracle client/server communication software that offers transparent operation
to Oracle tools or databases over any type of network protocol and operating
system.
PL/SQL
Procedural language extension to SQL provided by Oracle .
provider
A provider is an interface or set of components that provides data to a consumer.
As the term is used with Oracle Provider for OLE DB, a data provider is a set of
COM components that transfer data from a data source to a consumer, by placing
the data in a tabular format when called for. See consumer.
stored procedure
A stored procedure is a PL/SQL block that are stored in an Oracle Database and
can be called by name from an application.
Glossary-1
stored procedure
Glossary-2
Index
A
ActiveX Data Objects, vii
ADO, 2-5, 2-9, 2-17
ADO Applications with OLE DB Services, 2-6
ADO.NET, 2-26
attributes
connection string, 2-7
C
C#
connection string, 2-26
example, 2-26
C++/COM, 2-5
C++/COM Applications with OLE DB Services, 2-6
CacheType
connection string attribute for rowsets, 2-7, 2-21
caching, 2-18
Cancel method, 2-19
case of object names, 2-24
ChunkSize
class ID
CLSID_OraOLEDB, 2-5
CLSCTX_INPROC_SERVER macro, 2-5
CLSID_MSDAINITIALIZE class, 2-6
CoCreateInstance
creating an instance of the data source object, 2-5
columns
metadata, A-10
COM
Component Object Model, vii
commands, 2-11
parameters, 2-12
preparing, 2-12
CommandTimeout property, 2-19
compatibility with OLE DB Services, 2-5
My Oracle Support, 1-4
Component Object Model (COM), vii
connecting
Oracle databases supported, 2-5
to a specific database, 2-5
to an Oracle database, 2-6
to an Oracle database using ADO, 2-9
connection string attributes, 2-7

defaults, 2-8
registry, 2-8
rowsets, 2-21
consumers
OLE DB, 1-2
creating
an instance of the data source object, 2-5
rowsets, 2-19
Cursor Stability, 2-11
CursorType
tips for ADO programmers, 2-22
custom error objects
interfaces supported, A-10
D
data source
creating an instance of, 2-5
distributed transactions, 2-8
objects, 2-5
properties, A-2
data source info
properties, A-2
DataTable, 2-27
datatypes
mappings between Oracle datatypes and OLE DB
types, A-1
mappings in rowsets and parameters, A-1
OLE DB, A-1
Oracle, A-1
date formats
NLS_DATE_FORMAT, 2-23
settings, 2-23
DBNotificationPort, 2-8
DBNotifications, 2-8
DBPROP_AUTH_PASSWORD property
setting, 2-5
DBPROP_AUTH_USERNAME property
enabling operating system authentication, 2-9
setting, 2-5
DBPROP_INIT_DATASOURCE property
setting, 2-5
DBPROP_INIT_OLEDBSERVICES property, 2-5
DBPROP_INIT_PROMPT property
setting, 2-5
Index-1
DBPROP_INIT_PROVIDERSTRING property
setting, 2-8
DBPROP_IROWSETUPDATE property
setting of other properties, A-8
DBPROP_SERVERDATAONINSERT property, 2-21
DBPROPSET_DBINIT property set
setting properties, 2-5, 2-8
debugging, A-11
DeferUpdChk, 2-8, 2-22
connection string attribute to indicate whether to
defer updateability, 2-22
demobld.sql, 2-28
design
OLE DB, 1-1
DistribTX
connection string attribute for commands, 2-7
Distributed Transactions, 2-8
EnableCmdTimeout registry value, 2-19

Enhanced Failover Capability, 2-8
enlistment, 2-8
errors
HRESULT, 2-25
OLE and COM, 2-25
examples, 2-26
connecting to an Oracle database using ADO, 2-9
stored procedure returning multiple
rowsets, 2-16
using OraOLEDB with Visual Basic, 2-27
MDAC, 1-3
metadata, 2-18
metadata caching, 2-18
metadata columns
supported by Oracle Provider for OLE DB, A-10
MetaDataCacheSize, 2-8
Microsoft Data Access Components, 1-3
Microsoft Distributed Transaction Coordinator, 2-11
Microsoft Transaction Server, 2-11
MTS, see Microsoft Transaction Server
My Oracle Support, 1-4
files for Oracle Provider for OLE DB, 1-3

interface call traces, A-11
interfaces
custom error objects, A-10
rowsets, A-9
sessions, A-9
transaction options, A-10
KEY_HOMENAME, 2-8
L
LOB support, 2-24
ISequentialStream interface, 2-24
LockType
tips for ADO programmers, 2-22
N
F
features
new, ix
Oracle Provider for OLE DB, 2-1
FetchSize
files
installed on system for Oracle Provider for OLE
DB, 1-3
G
global transactions, 2-11
H
HRESULT
error return code, 2-25
I
initialization and authorization
properties, A-4
installation, 1-3
Index-2
NDataType, 2-7
NDatatype, 2-13
.NET, 2-26
New Features in Oracle Provider for OLE DB for
Release 11.1, ix
New Features in Oracle Provider for OLE DB for
Release 11.1.0.7.20, ix
O
object names
case, 2-24
OLE DB
consumers, 1-2
datatypes, A-1
design, 1-1
Microsoft web site, 1-3
providers, 1-2
OLE DB .NET Data Provider, 2-7
compatibility, 2-26
OLE DB Services
ADO Applications with, 2-6
C++/COM Applications with, 2-6
compatibility with, 2-5
OleDbDataAdapter.Update(), 2-27
OLEDB.NET, 2-7, 2-26

operating system authentication, 2-9
DBPROP_INIT_PROVIDERSTRING, 2-9
Oracle
datatypes, A-1
class ID, 2-5
features, 2-1
intended audience, vii
provider-specific information, A-1
system requirements, 1-3
Oracle Services for Microsoft Transaction
Server, 1-3, 2-11
OracleMetaLink, 1-4
OraOLEDB
see Oracle Provider for OLE DB
OraOLEDB sessions, 2-10
OSAuthent
connection string attribute for data source, 2-7
searching with IRowsetFind,

updatability, 2-20
2-21
S
schema rowsets, 2-22
Server Data on Insert property, 2-21
sessions
objects, 2-10
properties, A-5
SPPrmDefVal, 2-7
SPPrmsLOB, 2-7, 2-14
StmtCacheSize, 2-7
stored procedures and functions
executing, 2-11
returning rowsets, 2-15
system requirements
T
P
password expiration
connection string attribute, 2-9
PwdChgDlg, 2-9
performance, 2-18
PLSQLRSet, 2-12
properties
data source, A-2
data source info, A-2
initialization and authorization, A-4
rowset, A-5
rowset implications, A-8
sessions, A-5
providers
OLE DB, 1-2
PwdChgDlg
connection string attribute for data source, 2-9
R
registry
default attribute values, 2-8
returning rowsets
stored procedures and functions, 2-15
ROWID, 2-27
rowsets, 2-19
creating, 2-19
creating with ICommand, 2-20
creating with IOpenRowset, 2-19
date formats, 2-23
properties, A-5
property implications, A-8
returning with procedures and functions, 2-15
schema, 2-22
tips
for ADO programmers, 2-22
TraceCategory, A-11
TraceFileName, A-11
TraceLevel, A-12
tracing, A-11
transaction options
transactions
distributed, 2-11
global, 2-11
isolation levels, 2-11
local, 2-11
types supported, 2-11
U
UCS-2 character set, 2-24
Unicode, 2-24
UseSessionFormat
V
VB.NET
connection string,
examples, 2-26
VCharNull, 2-7
2-26
Index-3
Index-4

E 17726

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

E 17726

Uploaded by

Copyright:

Available Formats

Oracle Provider for OLE DB

What's New in OraOLEDB? ................................................................................................................... ix

1 Introduction to Oracle Provider for OLE DB

Oracle Database Installation Guide for Windows

Oracle Database Release Notes for Windows

Oracle Database Platform Guide for Windows

Oracle Database Concepts

Oracle Services for Microsoft Transaction Server Developer's Guide

Oracle Net Services Administrator's Guide

Oracle Database New Features

Oracle Database Reference

Oracle Database Globalization Support Guide

For additional information, see:

Boldface type indicates graphical user interface elements associated

Italic type indicates book titles, emphasis, or placeholder variables for

Monospace type indicates commands within a paragraph, URLs, code

What's New in OraOLEDB?

New Features in Oracle Provider for OLE DB for Release 11.1.0.7.20

New Features in Oracle Provider for OLE DB for Release 11.1

New Features in Oracle Provider for OLE DB for Release 11.1.0.7.20

Command Timeout and Command Cancel

New Features in Oracle Provider for OLE DB for Release 11.1

Improved Statement and Metadata Caching

"Statement Caching" on page 2-18

"Metadata Caching" on page 2-18

Enhanced Failover Capability

"Enhanced Failover Capability" on page 2-8

Support of ADO Disconnected Recordsets

This chapter introduces Oracle Provider for OLE DB (OraOLEDB).

Introduction to Oracle Provider for OLE DB

Figure 11 OLE DB Flow

OLE DB Data Providers

1-2 Oracle Provider for OLE DB Developer's Guide

Windows Operating System:

32-bit: Windows 7 (Professional, Enterprise, and Ultimate Editions), Windows

x64: Windows 7 x64 (Professional, Enterprise, and Ultimate Editions),

Access to an Oracle Database (Oracle 9.2 or later)

Introduction to Oracle Provider for OLE DB

Oracle Provider for OLE DB Files

Oracle Provider for OLE DB

Oracle rowset file cache manager

Oracle rowset memory cache manager

Oracle ODBC SQL parser

Language-specific resource DLL

OraOLEDB utility DLL

OraOLEDB type library

OraOLEDB header file

OraOLEDB library file

Language-specific message file

Release notes and online documentation

where lang is the

where lang is the

1-4 Oracle Provider for OLE DB Developer's Guide

OraOLEDB Provider Specific Features

Using OraOLEDB with Visual Basic

OraOLEDB Provider Specific Features

OLEDB.NET Data Provider Compatibility

Additional provider-specific information is provided in Appendix A,

Data Types introduced in Oracle Database 10g:

Data Types introduced in Oracle9i:

Features of OraOLEDB 2-1

OraOLEDB Provider Specific Features

TIMESTAMP WITH TIME ZONE