Share via


DataObjectEnumerator.EnumerateObjects Method

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

Namespace:  Microsoft.VisualStudio.Data
Assembly:  Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)

Syntax

'Declaration
Public MustOverride Function EnumerateObjects ( _
    typeName As String, _
    items As Object(), _
    restrictions As Object(), _
    sort As String, _
    parameters As Object() _
) As DataReader
public abstract DataReader EnumerateObjects(
    string typeName,
    Object[] items,
    Object[] restrictions,
    string sort,
    Object[] parameters
)
public:
virtual DataReader^ EnumerateObjects(
    String^ typeName, 
    array<Object^>^ items, 
    array<Object^>^ restrictions, 
    String^ sort, 
    array<Object^>^ parameters
) abstract
abstract EnumerateObjects : 
        typeName:string * 
        items:Object[] * 
        restrictions:Object[] * 
        sort:string * 
        parameters:Object[] -> DataReader
public abstract function EnumerateObjects(
    typeName : String, 
    items : Object[], 
    restrictions : Object[], 
    sort : String, 
    parameters : Object[]
) : DataReader

Parameters

  • typeName
    Type: System.String

    Name of the type of the object to enumerate.

  • items
    Type: array<System.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.

    Not supported in Visual Studio 2005.

  • restrictions
    Type: array<System.Object[]

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

  • sort
    Type: System.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.

    Not supported in Visual Studio 2005.

  • parameters
    Type: array<System.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.

Return Value

Type: Microsoft.VisualStudio.Data.DataReader
Returns a DataReader object containing the results of the enumeration call.

Exceptions

Exception Condition
ArgumentNullException

The typeName parameter is null.

Remarks

Other exceptions indicate that a provider-specific error occurred during the enumeration operation.

Note

The items and sort parameters are not used in Visual Studio 2005 and should not be used.

.NET Framework Security

See Also

Reference

DataObjectEnumerator Class

Microsoft.VisualStudio.Data Namespace