GetSelectionDataObject Method

IVsTextView.GetSelectionDataObject Method (IDataObject)

 

Returns a copy of the selected text in IDataObject interface format.

Namespace:   Microsoft.VisualStudio.TextManager.Interop
Assembly:  Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

int GetSelectionDataObject(
	out IDataObject ppIDataObject
)

Parameters

ppIDataObject
Type: Microsoft.VisualStudio.OLE.Interop.IDataObject

[out] Pointer to an IDataObject object containing the selected text.

Return Value

Type: System.Int32

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

From textmgr.idl:

HRESULT IVsTextView::GetSelectionDataObject(
   [out] IDataObject **ppIDataObject
);

Use this method to return a selected span of text in a data object, rather that returning the text in a BSTR. This allows you to retain the formatting associated with the data object when you transfer the text to another application. For more information, see IDataObject.

Return to top
Show:
© 2016 Microsoft