IVsDataObjectStore.GetObject Method

Definition

Namespace:

Microsoft.VisualStudio.Data.Services

Assembly:

Microsoft.VisualStudio.Data.Services.dll

Package:

Microsoft.VisualStudio.Data.Services v17.10.40170

Overloads

GetObject(String, Object[])	Retrieves the specified data object from the object store.
GetObject(String, Object[], Boolean)	Retrieves the specified data object from the object store.
GetObject(String, Object[], String[])	Retrieves the specified data object from the object store.
GetObject(String, Object[], String[], Boolean)	Retrieves the specified data object from the object store.

GetObject(String, Object[])

Retrieves the specified data object from the object store.

public:
 Microsoft::VisualStudio::Data::Services::IVsDataObject ^ GetObject(System::String ^ typeName, cli::array <System::Object ^> ^ identifier);

public Microsoft.VisualStudio.Data.Services.IVsDataObject GetObject (string typeName, object[] identifier);

abstract member GetObject : string * obj[] -> Microsoft.VisualStudio.Data.Services.IVsDataObject

Public Function GetObject (typeName As String, identifier As Object()) As IVsDataObject

Parameters

typeName

String

The data source–specific type name of the data object to retrieve.

identifier

Object[]

An array containing the identifier parts that uniquely identify the data object in the object store.

Returns

IVsDataObject

An IVsDataObject representing the data object to retrieve.

Exceptions

ArgumentNullException

The typeName parameter is null.

GetObject(String, Object[], Boolean)

Retrieves the specified data object from the object store.

public:
 Microsoft::VisualStudio::Data::Services::IVsDataObject ^ GetObject(System::String ^ typeName, cli::array <System::Object ^> ^ identifier, bool refresh);

public Microsoft.VisualStudio.Data.Services.IVsDataObject GetObject (string typeName, object[] identifier, bool refresh);

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

Public Function GetObject (typeName As String, identifier As Object(), refresh As Boolean) As IVsDataObject

Parameters

typeName

String

The data source–specific type name of the data object to retrieve.

identifier

Object[]

An array containing the identifier parts that uniquely identify the data object in the object store.

refresh

Boolean

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

Returns

IVsDataObject

An IVsDataObject representing the data object to retrieve.

Exceptions

ArgumentNullException

The typeName parameter is null.

GetObject(String, Object[], String[])

Retrieves the specified data object from the object store.

public:
 Microsoft::VisualStudio::Data::Services::IVsDataObject ^ GetObject(System::String ^ typeName, cli::array <System::Object ^> ^ identifier, cli::array <System::String ^> ^ properties);

public Microsoft.VisualStudio.Data.Services.IVsDataObject GetObject (string typeName, object[] identifier, string[] properties);

abstract member GetObject : string * obj[] * string[] -> Microsoft.VisualStudio.Data.Services.IVsDataObject

Public Function GetObject (typeName As String, identifier As Object(), properties As String()) As IVsDataObject

Parameters

typeName

String

The data source–specific type name of the data object to retrieve.

identifier

Object[]

An array containing the identifier parts that uniquely identify the data object in the object store.

properties

String[]

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

Returns

IVsDataObject

An IVsDataObject representing the data object to retrieve.

Exceptions

ArgumentNullException

The typeName parameter is null.

GetObject(String, Object[], String[], Boolean)

Retrieves the specified data object from the object store.

public:
 Microsoft::VisualStudio::Data::Services::IVsDataObject ^ GetObject(System::String ^ typeName, cli::array <System::Object ^> ^ identifier, cli::array <System::String ^> ^ properties, bool refresh);

public Microsoft.VisualStudio.Data.Services.IVsDataObject GetObject (string typeName, object[] identifier, string[] properties, bool refresh);

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

Public Function GetObject (typeName As String, identifier As Object(), properties As String(), refresh As Boolean) As IVsDataObject

Parameters

typeName

String

The data source–specific type name of the data object to retrieve.

identifier

Object[]

An array containing the identifier parts that uniquely identify the data object in the object store.

properties

String[]

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

refresh

Boolean

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

Returns

IVsDataObject

An IVsDataObject representing the data object to retrieve.

Exceptions

ArgumentNullException

The typeName parameter is null.