IVsDataObjectStore.SelectObjects Method (String, array<Object[], array<String , String, String, Boolean)

Returns a collection of data objects for the specified type from the object store, filtered by the specified restrictions, properties, and filter, and sorted according to the specified ordering.

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

Syntax

'Declaration
Function SelectObjects ( _
    typeName As String, _
    restrictions As Object(), _
    properties As String(), _
    filter As String, _
    ordering As String, _
    refresh As Boolean _
) As IVsDataObjectCollection
IVsDataObjectCollection SelectObjects(
    string typeName,
    Object[] restrictions,
    string[] properties,
    string filter,
    string ordering,
    bool refresh
)
IVsDataObjectCollection^ SelectObjects(
    String^ typeName, 
    array<Object^>^ restrictions, 
    array<String^>^ properties, 
    String^ filter, 
    String^ ordering, 
    bool refresh
)
abstract SelectObjects : 
        typeName:string * 
        restrictions:Object[] * 
        properties:string[] * 
        filter:string * 
        ordering:string * 
        refresh:bool -> IVsDataObjectCollection
function SelectObjects(
    typeName : String, 
    restrictions : Object[], 
    properties : String[], 
    filter : String, 
    ordering : String, 
    refresh : boolean
) : IVsDataObjectCollection

Parameters

  • typeName
    Type: System.String

    The data source–specific name of the specified type to retrieve data objects for.

  • restrictions
    Type: array<System.Object[]

    The restrictions for filtering the data objects returned.

  • properties
    Type: array<System.String[]

    Specifies the property values of the requested data objects. The current version of DDEX does not support properties.

  • filter
    Type: System.String

    A filter to further narrow down the selection of data objects when there is no one-to-one mapping between the mapped type and the data source–specific type. The format of the filter is identical to the format of the DataColumn expression.

  • ordering
    Type: System.String

    A string of comma-delimited data objects representing the sort ordering of the returned data objects.

  • refresh
    Type: System.Boolean

    A Boolean value indicating whether to update the list of required restrictions and properties for the specified type.

Return Value

Type: Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection
An IVsDataObjectCollection containing the data objects.

Exceptions

Exception Condition
ArgumentNullException

The typeName parameter is nulla null reference (Nothing in Visual Basic).

ArgumentException

The required restriction is missing.

.NET Framework Security

See Also

Reference

IVsDataObjectStore Interface

SelectObjects Overload

Microsoft.VisualStudio.Data.Services Namespace