IVsLanguageClipboardOps.TextFromData Method

Article
2013-03-11

Render this data object to text.

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

Syntax

'Declaration
Function TextFromData ( _
    pTextLayer As IVsTextLayer, _
    pDO As IDataObject, _
    <OutAttribute> ptdfFlags As LTE_TEXTDATAFLAGS(), _
    <OutAttribute> ByRef pbstrText As String _
) As Integer

int TextFromData(
    IVsTextLayer pTextLayer,
    IDataObject pDO,
    LTE_TEXTDATAFLAGS[] ptdfFlags,
    out string pbstrText
)

int TextFromData(
    [InAttribute] IVsTextLayer^ pTextLayer, 
    [InAttribute] IDataObject^ pDO, 
    [OutAttribute] array<LTE_TEXTDATAFLAGS>^ ptdfFlags, 
    [OutAttribute] String^% pbstrText
)

abstract TextFromData : 
        pTextLayer:IVsTextLayer * 
        pDO:IDataObject * 
        ptdfFlags:LTE_TEXTDATAFLAGS[] byref * 
        pbstrText:string byref -> int

function TextFromData(
    pTextLayer : IVsTextLayer, 
    pDO : IDataObject, 
    ptdfFlags : LTE_TEXTDATAFLAGS[], 
    pbstrText : String
) : int

Parameters

pTextLayer
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextLayer
[in] Pointer to a text layer object for the referenced data object.

pDO
Type: Microsoft.VisualStudio.OLE.Interop.IDataObject
[in] Pointer to the data object.

ptdfFlags
Type: array<Microsoft.VisualStudio.TextManager.Interop.LTE_TEXTDATAFLAGS[]
[out] Specifies options for how text is being pasted. For more information, see LTE_TEXTDATAFLAGS .

pbstrText
Type: System.String%
[out] Text of 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::TextFromData(
   [in] IVsTextLayer *pTextLayer, 
   [in] IDataObject *pDO, 
   [out] LTE_TEXTDATAFLAGS *ptdfFlags, 
   [out, retval] BSTR *pbstrText
);

If you return S_OK to IsTextData , then the environment calls TextFromData to prompt you to return the text of the data object.

.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