IVsEditorAdaptersFactoryService.GetDocumentBuffer Method

Article
03/13/2013

Gets the document buffer of an IVsTextBuffer adapter. This is the bottom buffer of the data model buffer graph.

Namespace: Microsoft.VisualStudio.Editor
Assembly: Microsoft.VisualStudio.Editor (in Microsoft.VisualStudio.Editor.dll)

Syntax

'Declaration
Function GetDocumentBuffer ( _
    bufferAdapter As IVsTextBuffer _
) As ITextBuffer

ITextBuffer GetDocumentBuffer(
    IVsTextBuffer bufferAdapter
)

ITextBuffer^ GetDocumentBuffer(
    IVsTextBuffer^ bufferAdapter
)

abstract GetDocumentBuffer : 
        bufferAdapter:IVsTextBuffer -> ITextBuffer

function GetDocumentBuffer(
    bufferAdapter : IVsTextBuffer
) : ITextBuffer

Parameters

bufferAdapter
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextBuffer
The text buffer adapter of interest.

Return Value

Type: Microsoft.VisualStudio.Text.ITextBuffer
The ITextBuffer document buffer that is presented to the view model, or nulla null reference (Nothing in Visual Basic) if this method is called before content has been established for the adapter.

Exceptions

Exception	Condition
ArgumentNullException	bufferAdapter is null.
ArgumentException	bufferAdapter was not produced by this factory.

Remarks

This buffer will be the same as the data buffer, except in buffer coordinator scenarios.

.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