IVsDataObjectStore.SelectObjects Method

Definition

Namespace:

Microsoft.VisualStudio.Data.Services

Assembly:

Microsoft.VisualStudio.Data.Services.dll

Package:

Microsoft.VisualStudio.Data.Services v17.10.40170

Overloads

SelectObjects(String)	Returns a collection of data objects for the specified type from the object store.
SelectObjects(String, Object[])	Returns a collection of data objects for the specified type from the object store, filtered by the specified restrictions.
SelectObjects(String, Object[], Boolean)	Returns a collection of data objects for the specified type from the object store, filtered by the specified restrictions.
SelectObjects(String, Object[], String)	Returns a collection of data objects for the specified type from the object store, filtered by the specified restrictions and filter.
SelectObjects(String, Object[], String[])	Returns a collection of data objects for the specified type from the object store, filtered by the specified restrictions and properties.
SelectObjects(String, Object[], String, String)	Returns a collection of data objects for the specified type from the object store, filtered by the specified restrictions and filter, and sorted according to the specified ordering.
SelectObjects(String, Object[], String[], String)	Returns a collection of data objects for the specified type from the object store, filtered by the specified restrictions, properties, and filter.
SelectObjects(String, Object[], String[], String, String)	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.
SelectObjects(String, Object[], 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.

SelectObjects(String)

Returns a collection of data objects for the specified type from the object store.

public:
 Microsoft::VisualStudio::Data::Services::IVsDataObjectCollection ^ SelectObjects(System::String ^ typeName);

public Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection SelectObjects (string typeName);

abstract member SelectObjects : string -> Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection

Public Function SelectObjects (typeName As String) As IVsDataObjectCollection

Parameters

typeName

String

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

Returns

IVsDataObjectCollection

An IVsDataObjectCollection containing the data objects.

Exceptions

ArgumentNullException

The typeName parameter is null.

SelectObjects(String, Object[])

Returns a collection of data objects for the specified type from the object store, filtered by the specified restrictions.

public:
 Microsoft::VisualStudio::Data::Services::IVsDataObjectCollection ^ SelectObjects(System::String ^ typeName, cli::array <System::Object ^> ^ restrictions);

public Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection SelectObjects (string typeName, object[] restrictions);

abstract member SelectObjects : string * obj[] -> Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection

Public Function SelectObjects (typeName As String, restrictions As Object()) As IVsDataObjectCollection

Parameters

typeName

String

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

restrictions

Object[]

The restrictions for filtering the data objects returned.

Returns

IVsDataObjectCollection

An IVsDataObjectCollection containing the data objects.

Exceptions

ArgumentNullException

The typeName parameter is null.

ArgumentException

The required restriction is missing.

SelectObjects(String, Object[], Boolean)

Returns a collection of data objects for the specified type from the object store, filtered by the specified restrictions.

public:
 Microsoft::VisualStudio::Data::Services::IVsDataObjectCollection ^ SelectObjects(System::String ^ typeName, cli::array <System::Object ^> ^ restrictions, bool refresh);

public Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection SelectObjects (string typeName, object[] restrictions, bool refresh);

abstract member SelectObjects : string * obj[] * bool -> Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection

Public Function SelectObjects (typeName As String, restrictions As Object(), refresh As Boolean) As IVsDataObjectCollection

Parameters

typeName

String

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

restrictions

Object[]

The restrictions for filtering the data objects returned.

refresh

Boolean

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

Returns

IVsDataObjectCollection

An IVsDataObjectCollection containing the data objects.

Exceptions

ArgumentNullException

The typeName parameter is null.

ArgumentException

The required restriction is missing.

SelectObjects(String, Object[], String)

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

public:
 Microsoft::VisualStudio::Data::Services::IVsDataObjectCollection ^ SelectObjects(System::String ^ typeName, cli::array <System::Object ^> ^ restrictions, System::String ^ filter);

public Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection SelectObjects (string typeName, object[] restrictions, string filter);

abstract member SelectObjects : string * obj[] * string -> Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection

Public Function SelectObjects (typeName As String, restrictions As Object(), filter As String) As IVsDataObjectCollection

Parameters

typeName

String

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

restrictions

Object[]

The restrictions for filtering the data objects returned.

filter

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.

Returns

IVsDataObjectCollection

An IVsDataObjectCollection containing the data objects.

Exceptions

ArgumentNullException

The typeName parameter is null.

ArgumentException

The required restriction is missing.

SelectObjects(String, Object[], String[])

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

public:
 Microsoft::VisualStudio::Data::Services::IVsDataObjectCollection ^ SelectObjects(System::String ^ typeName, cli::array <System::Object ^> ^ restrictions, cli::array <System::String ^> ^ properties);

public Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection SelectObjects (string typeName, object[] restrictions, string[] properties);

abstract member SelectObjects : string * obj[] * string[] -> Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection

Public Function SelectObjects (typeName As String, restrictions As Object(), properties As String()) As IVsDataObjectCollection

Parameters

typeName

String

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

restrictions

Object[]

The restrictions for filtering the data objects returned.

properties

String[]

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

Returns

IVsDataObjectCollection

An IVsDataObjectCollection containing the data objects.

Exceptions

ArgumentNullException

The typeName parameter is null.

ArgumentException

The required restriction is missing.

SelectObjects(String, Object[], String, String)

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

public:
 Microsoft::VisualStudio::Data::Services::IVsDataObjectCollection ^ SelectObjects(System::String ^ typeName, cli::array <System::Object ^> ^ restrictions, System::String ^ filter, System::String ^ ordering);

public Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection SelectObjects (string typeName, object[] restrictions, string filter, string ordering);

abstract member SelectObjects : string * obj[] * string * string -> Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection

Public Function SelectObjects (typeName As String, restrictions As Object(), filter As String, ordering As String) As IVsDataObjectCollection

Parameters

typeName

String

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

restrictions

Object[]

The restrictions for filtering the data objects returned.

filter

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

String

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

Returns

IVsDataObjectCollection

An IVsDataObjectCollection containing the data objects.

Exceptions

ArgumentNullException

The typeName parameter is null.

ArgumentException

The required restriction is missing.

SelectObjects(String, Object[], String[], String)

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

public:
 Microsoft::VisualStudio::Data::Services::IVsDataObjectCollection ^ SelectObjects(System::String ^ typeName, cli::array <System::Object ^> ^ restrictions, cli::array <System::String ^> ^ properties, System::String ^ filter);

public Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection SelectObjects (string typeName, object[] restrictions, string[] properties, string filter);

abstract member SelectObjects : string * obj[] * string[] * string -> Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection

Public Function SelectObjects (typeName As String, restrictions As Object(), properties As String(), filter As String) As IVsDataObjectCollection

Parameters

typeName

String

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

restrictions

Object[]

The restrictions for filtering the data objects returned.

properties

String[]

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

filter

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.

Returns

IVsDataObjectCollection

An IVsDataObjectCollection containing the data objects.

Exceptions

ArgumentNullException

The typeName parameter is null.

ArgumentException

The required restriction is missing.

SelectObjects(String, Object[], String[], String, String)

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.

public:
 Microsoft::VisualStudio::Data::Services::IVsDataObjectCollection ^ SelectObjects(System::String ^ typeName, cli::array <System::Object ^> ^ restrictions, cli::array <System::String ^> ^ properties, System::String ^ filter, System::String ^ ordering);

public Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection SelectObjects (string typeName, object[] restrictions, string[] properties, string filter, string ordering);

abstract member SelectObjects : string * obj[] * string[] * string * string -> Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection

Public Function SelectObjects (typeName As String, restrictions As Object(), properties As String(), filter As String, ordering As String) As IVsDataObjectCollection

Parameters

typeName

String

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

restrictions

Object[]

The restrictions for filtering the data objects returned.

properties

String[]

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

filter

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

String

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

Returns

IVsDataObjectCollection

An IVsDataObjectCollection containing the data objects.

Exceptions

ArgumentNullException

The typeName parameter is null.

ArgumentException

The required restriction is missing.

SelectObjects(String, Object[], 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.

public:
 Microsoft::VisualStudio::Data::Services::IVsDataObjectCollection ^ SelectObjects(System::String ^ typeName, cli::array <System::Object ^> ^ restrictions, cli::array <System::String ^> ^ properties, System::String ^ filter, System::String ^ ordering, bool refresh);

public Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection SelectObjects (string typeName, object[] restrictions, string[] properties, string filter, string ordering, bool refresh);

abstract member SelectObjects : string * obj[] * string[] * string * string * bool -> Microsoft.VisualStudio.Data.Services.IVsDataObjectCollection

Public Function SelectObjects (typeName As String, restrictions As Object(), properties As String(), filter As String, ordering As String, refresh As Boolean) As IVsDataObjectCollection

Parameters

typeName

String

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

restrictions

Object[]

The restrictions for filtering the data objects returned.

properties

String[]

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

filter

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

String

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

refresh

Boolean

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

Returns

IVsDataObjectCollection

An IVsDataObjectCollection containing the data objects.

Exceptions

ArgumentNullException

The typeName parameter is null.

ArgumentException

The required restriction is missing.