Share via


IVsTextImage.GetTextBSTR Method

Return the text of a text span as a BSTR

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

Syntax

'Declaration
Function GetTextBSTR ( _
    pts As TextSpan(), _
    <OutAttribute> ByRef pbstrText As String _
) As Integer
int GetTextBSTR(
    TextSpan[] pts,
    out string pbstrText
)
int GetTextBSTR(
    [InAttribute] array<TextSpan>^ pts, 
    [OutAttribute] String^% pbstrText
)
abstract GetTextBSTR : 
        pts:TextSpan[] * 
        pbstrText:string byref -> int 
function GetTextBSTR(
    pts : TextSpan[], 
    pbstrText : String
) : int

Parameters

  • pbstrText
    Type: System.String%
    [out] Pointer to a BSTR containing the text.

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 IVsTextImage::GetTextBSTR(
   [in] const TextSpan * pts,
   [out, retval] BSTR * pbstrText
);

.NET Framework Security

See Also

Reference

IVsTextImage Interface

Microsoft.VisualStudio.TextManager.Interop Namespace