IVsHiddenTextManager::GetHiddenTextSession Method (Object^, IVsHiddenTextSession^)

Visual Studio 2015

Returns the current hidden text session for the specified text buffer, if one exists.

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

Syntax

C++

int GetHiddenTextSession(
	Object^ pOwningObject,
	[OutAttribute] IVsHiddenTextSession^% ppSession
)

Parameters

pOwningObject: Type: System::Object^
[in] Text buffer containing the outlining or hidden text session.

ppSession: Type: Microsoft.VisualStudio.TextManager.Interop::IVsHiddenTextSession^
[out] Pointer to the outlining or hidden text session object (IVsHiddenTextSession) for the referenced text 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:

C++

HRESULT IVsHiddenTextManager::GetHiddenTextSession(
   [in] IUnknown *pOwningObject, 
   [out] IVsHiddenTextSession **ppSession
);

If this method returns null, then no other hidden text sessions exist for the specified buffer. In this case, call CreateHiddenTextSession to create a hidden text session for the buffer. Use the methods of IVsHiddenTextSession to add hidden text regions to the buffer.