AdoDotNetObjectEnumerator.EnumerateObjects Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Data.AdoDotNet

Assembly:: Microsoft.VisualStudio.Data.dll

Package:: Microsoft.VisualStudio.Data v17.10.40170

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Enumerates items for a set of data objects of the specified type with the specified restrictions and sort string, if supported.

public:
 override Microsoft::VisualStudio::Data::DataReader ^ EnumerateObjects(System::String ^ typeName, cli::array <System::Object ^> ^ items, cli::array <System::Object ^> ^ restrictions, System::String ^ sort, cli::array <System::Object ^> ^ parameters);

public override Microsoft.VisualStudio.Data.DataReader EnumerateObjects (string typeName, object[] items, object[] restrictions, string sort, object[] parameters);

override this.EnumerateObjects : string * obj[] * obj[] * string * obj[] -> Microsoft.VisualStudio.Data.DataReader

Public Overrides Function EnumerateObjects (typeName As String, items As Object(), restrictions As Object(), sort As String, parameters As Object()) As DataReader

Parameters

typeName: String

Name of the type of the object to enumerate.

items: Object[]

The set of items to enumerate, specified as strings where named items are available, otherwise as indexes. In cases in which a data provider does not support items filtering, this parameter is ignored.

restrictions: Object[]

A set of filtering restrictions to apply to the set of returned objects.

sort: String

A sort string, which follows syntax for the SQL Server ORDER BY clause. The actual sort order should be source-based; that is, if the client is English and the source is Chinese, the sort should be applied in Chinese.

parameters: Object[]

An array whose contents are defined by the given implementation of EnumerateObjects, and which is specified by the Data Object Support XML file. Information supplied in this parameter can be used to provide extra data indicating how to perform the enumeration, allowing implementations of this method to be more data driven.

Returns

DataReader

Returns a AdoDotNetDataReader object containing the results of the enumeration call.

Exceptions

ArgumentNullException

The typeName parameter is null.

Applies to

Share via