IVsTextStream.GetStream(Int32, Int32, IntPtr) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides direct, stream-oriented access to the text buffer.

public:
 int GetStream(int iPos, int iLength, IntPtr pszDest);

public int GetStream (int iPos, int iLength, IntPtr pszDest);

abstract member GetStream : int * int * nativeint -> int

Public Function GetStream (iPos As Integer, iLength As Integer, pszDest As IntPtr) As Integer

Parameters

iPos: Int32

[in] Starting position in the text buffer

iLength: Int32

[in] Length of the text stream to access.

pszDest: IntPtr
nativeint

[in] The caller-allocated string buffer. This buffer is filled with the requested text.

Returns

Int32

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

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsTextStream::GetStream(  
   [in] long iPos,  
   [in] long iLength,  
   [out] WCHAR *pszDest  
);

When using this method, be sure to allocate a buffer of size iLength+1, because this call appends a null to the character array.

Applies to