IVsTextStream.GetSize(Int32) Method

Definition

Namespace:

Microsoft.VisualStudio.TextManager.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Returns the size in characters of the buffer.

public:
 int GetSize([Runtime::InteropServices::Out] int % piLength);

int GetSize([Runtime::InteropServices::Out] int & piLength);

public int GetSize (out int piLength);

abstract member GetSize : int -> int

Public Function GetSize (ByRef piLength As Integer) As Integer

Parameters

piLength

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.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Implements

GetSize(Int32)

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsTextStream::GetSize(  
   [out] long *piLength  
);  

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