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

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

public:
 int GetHiddenTextSession(System::Object ^ pOwningObject, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsHiddenTextSession ^ % ppSession);

public:
 int GetHiddenTextSession(Platform::Object ^ pOwningObject, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsHiddenTextSession ^ &  ppSession);

int GetHiddenTextSession(winrt::Windows::Foundation::IInspectable const & pOwningObject, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsHiddenTextSession const & & ppSession);

public int GetHiddenTextSession (object pOwningObject, out Microsoft.VisualStudio.TextManager.Interop.IVsHiddenTextSession ppSession);

abstract member GetHiddenTextSession : obj * IVsHiddenTextSession -> int

Public Function GetHiddenTextSession (pOwningObject As Object, ByRef ppSession As IVsHiddenTextSession) As Integer

Parameters

pOwningObject: Object

[in] Text buffer containing the outlining or hidden text session.

ppSession: IVsHiddenTextSession

[out] Pointer to the outlining or hidden text session object (IVsHiddenTextSession) for the referenced text buffer.

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

Applies to