IVsTextBuffer.GetSize Method

Article
08/01/2012

Returns the size in characters of the buffer.

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

Syntax

'Déclaration
Function GetSize ( _
    <OutAttribute> ByRef piLength As Integer _
) As Integer

int GetSize(
    out int piLength
)

int GetSize(
    [OutAttribute] int% piLength
)

abstract GetSize : 
        piLength:int byref -> int

function GetSize(
    piLength : int
) : int

Parameters

piLength
Type: System.Int32%
[out] Pointer to the size of the buffer, which is not necessarily the same value as the size of the buffer's internally-allocated memory or the size of the file (if any) represented by the buffer.

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 IVsTextBuffer::GetSize(
   [out] long *piLength
);

This method might require considerable resources, depending upon the underlying implementation of the buffer. That is, it might be very difficult to calculate the size of the buffer if it is a virtual-line-oriented implementation as in Visual Basic.

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

Partager via