Partager via

OLEDBSimpleProvider Interface and Methods

  • Article

The OLEDBSimpleProvider interface implements the methods used for data access. It specifies methods for the following tasks:

  • Adding and deleting rows.

  • Setting the value of cells.

  • Searching through a data set.

  • Populating or retrieving a data set asynchronously.

  • Implementing or removing an event handler.

OLEDBSimpleProvider is identified by the following IID:

{E0E270C0-C0BE-11d0-8FE4-00A0C90A6341}

Important

This feature will be removed in a future version of Windows. Avoid using this feature in new development work, and plan to modify applications that currently use this feature. Instead, write a fully functional OLE DB provider using the native OLE DB interfaces.

Data References

When using OLEDBSimpleProvider methods, you reference the exposed arraylike data by using row and column indices. Normally, indices begin with a value of 1. Two index values with special meaning are described in the following table.

Index value

Description

-1

Wildcard value. Refers to an unknown value or all values. For example, a row value of -1 and a column value of 2 refers to all the rows in column 2 (not including the row header information).

NoteNote
The OLEDBSimpleProvider::getVariant and OLEDBSimpleProvider::setVariant methods cannot use a value of -1 as an argument for the iRow and iColumn arguments.

0

As a row value, reserved for names of columns. Is ignored (by the OSP mapping layer) as a column value. For example, a row value of 0 and a column of 1 refers to the name of column 1 returned by IColumnsInfo.

NoteNote
The OLEDBSimpleProvider::getVariant and OLEDBSimpleProvider::setVariant methods ignore a value of 0 as an argument for the iColumn argument.

Method List

The following table lists the OLEDBSimpleProvider methods that the OSP Toolkit uses, a short description of each, and the category each method belongs to. Click any method name for detailed information about its implementation.

Method

Description

Category

addOLEDBSimpleProviderListener

Registers an event handler interface, making it possible to receive notifications of changes to data.

Event handler

deleteRows

Deletes a specified number of rows, starting at a specified location.

Insertion and deletion

find

Searches for the specified set of values, starting at a specified location.

Search

getColumnCount

Returns the number of columns.

Schema

getEstimatedRows

Returns the total estimated number of rows in the data set.

Asynchronous data population

getLocale

Indicates the locale of the data.

Localization

getRowCount

Returns the number of rows.

Schema

getRWStatus

Returns the read/write status of a column, row, cell, or data set.

Schema

getVariant

Retrieves the value of the cell at the indicated row and column into the preallocated Variant.

Variant

insertRows

Inserts a specified number of empty rows, starting at a specified location.

Insertion and deletion

isAsync

Indicates whether data is being populated asynchronously.

Asynchronous data population

removeOLEDBSimpleProviderListener

Unregisters a specified event handler interface.

Event handler

setVariant

Sets the value of the cell at the row and column indicated to the value of the Variant.

Variant

stopTransfer

Requests that the OSP discontinue asynchronous transfer of data.

Asynchronous data population