IVsToolbox.GetData(IDataObject) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Returns the data object for the selected item in the Toolbox.

public:
 int GetData([Runtime::InteropServices::Out] Microsoft::VisualStudio::OLE::Interop::IDataObject ^ % ppDO);

public:
 int GetData([Runtime::InteropServices::Out] Microsoft::VisualStudio::OLE::Interop::IDataObject ^ &  ppDO);

int GetData([Runtime::InteropServices::Out] Microsoft::VisualStudio::OLE::Interop::IDataObject const & & ppDO);

public int GetData (out Microsoft.VisualStudio.OLE.Interop.IDataObject ppDO);

abstract member GetData : IDataObject -> int

Public Function GetData (ByRef ppDO As IDataObject) As Integer

Parameters

ppDO: IDataObject

[out, retval] Toolbox item for which data needs to be returned.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsToolbox::GetData(

[out, retval]IDataObject** ppDO

);

IVsToolbox.GetData returns null if the common pointer tool is the selected item or if the current item is not an enabled item.

Applies to