Share via


IVsTextView.GetSelectionDataObject Method

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)

Syntax

'Declaration
Function GetSelectionDataObject ( _
    <OutAttribute> ByRef ppIDataObject As IDataObject _
) As Integer
int GetSelectionDataObject(
    out IDataObject ppIDataObject
)
int GetSelectionDataObject(
    [OutAttribute] IDataObject^% ppIDataObject
)
abstract GetSelectionDataObject : 
        ppIDataObject:IDataObject byref -> int
function GetSelectionDataObject(
    ppIDataObject : IDataObject
) : int

Parameters

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

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.

.NET Framework Security

See Also

Reference

IVsTextView Interface

Microsoft.VisualStudio.TextManager.Interop Namespace