IVsLanguageClipboardOps.GetDataObject Method

Article
2013-03-11

Creates an IDataObject with language-specific formats.

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

Syntax

'Declaration
Function GetDataObject ( _
    pView As IVsTextView, _
    pTextLayer As IVsTextLayer, _
    <OutAttribute> ByRef ppDO As IDataObject _
) As Integer

int GetDataObject(
    IVsTextView pView,
    IVsTextLayer pTextLayer,
    out IDataObject ppDO
)

int GetDataObject(
    [InAttribute] IVsTextView^ pView, 
    [InAttribute] IVsTextLayer^ pTextLayer, 
    [OutAttribute] IDataObject^% ppDO
)

abstract GetDataObject : 
        pView:IVsTextView * 
        pTextLayer:IVsTextLayer * 
        ppDO:IDataObject byref -> int

function GetDataObject(
    pView : IVsTextView, 
    pTextLayer : IVsTextLayer, 
    ppDO : IDataObject
) : int

Parameters

pView
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextView
[In] The view containing the data object.

pTextLayer
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextLayer
[In] The text layer containing the data object.

ppDO
Type: Microsoft.VisualStudio.OLE.Interop.IDataObject%
[out] The data object.

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 IVsLanguageClipboardOps::GetDataObject(
   [in] IVsTextView *pView, 
   [in] IVsTextLayer *pTextLayer, 
   [out, retval] IDataObject **ppDO
);

The data object created must not hold a reference to the view (pView) or the text layer (pTextLayer) because the data object can outlive them.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via