IVsTextImage.GetText Method

Article
05/06/2010

Return the text of a text span.

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

Syntax

'Déclaration
Function GetText ( _
    pts As TextSpan(), _
    cch As Integer, _
    <OutAttribute> psz As UShort() _
) As Integer
'Utilisation
Dim instance As IVsTextImage
Dim pts As TextSpan()
Dim cch As Integer
Dim psz As UShort()
Dim returnValue As Integer

returnValue = instance.GetText(pts, cch, _
    psz)

int GetText(
    TextSpan[] pts,
    int cch,
    ushort[] psz
)

int GetText(
    [InAttribute] array<TextSpan>^ pts, 
    [InAttribute] int cch, 
    [OutAttribute] array<unsigned short>^ psz
)

abstract GetText : 
        pts:TextSpan[] * 
        cch:int * 
        psz:uint16[] byref -> int

function GetText(
    pts : TextSpan[], 
    cch : int, 
    psz : ushort[]
) : int

Parameters

pts
Type: array<Microsoft.VisualStudio.TextManager.Interop.TextSpan[]
[in] Pointer to a TextSpan structure.

cch
Type: System.Int32
[in] Number of characters to return.

psz
Type: array<System.UInt16[]
[out] Pointer to a null terminated string 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::GetText(
   [in] const TextSpan * pts,
   [in] LONG cch,
   [out, size_is(cch)] LPOLESTR psz
);

.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.