Edit

Share via

IDebugDocumentText2::GetText

  • Article

Retrieves the text from the specified position in the document.

Syntax

int GetText(
    eumn_TEXT_POSITION pos,
    uint               cMaxChars,
    IntPtr             pText,
    out uint           pcNumChars
);

Parameters

pos
[in] A TEXT_POSITION structure that indicates the location of the text to be retrieved.

cMaxChars
[in] The maximum number of characters of the text to be retrieved.

pText
[in, out] A pointer to a buffer that is to be filled in with the desired text. This buffer must be able to contain at least cMaxChars number of wide characters.

pcNumChars
[out] Returns the number of characters actually retrieved.

Return Value

If successful, returns S_OK; otherwise, returns an error code.

Example

This example shows how this method can be called from C#.

using System.Runtime.Interop.Services;
using Microsoft.VisualStudio;
using Microsoft.VisualStudio.Debugger.Interop;

namespace Mynamespace
{
    class MyClass
    {
        string GetDocumentText(IDebugDocumentText2 pText, TEXT_POSITION pos)
        {
            string documentText = string.Empty;
            if (pText != null)
            {
                uint numLines = 0;
                uint numChars = 0;
                int hr;
                hr = pText.GetSize(ref numLines, ref numChars);
                if (ErrorHandler.Succeeded(hr))
                {
                    IntPtr buffer = Marshal.AllocCoTaskMem((int)numChars * sizeof(char));
                    uint actualChars = 0;
                    hr = pText.GetText(pos, numChars, buffer, out actualChars);
                    if (ErrorHandler.Succeeded(hr))
                    {
                        documentText = Marshal.PtrToStringUni(buffer, (int)actualChars);
                    }
                    Marshal.FreeCoTaskMem(buffer);
                }
            }
            return documentText;
        }
    }
}

See also