Share via


IVsHiddenTextManager.CreateHiddenTextSession Method

Definition

Creates a new hidden text session for a text buffer.

public:
 int CreateHiddenTextSession(System::UInt32 dwFlags, System::Object ^ pOwningObject, Microsoft::VisualStudio::TextManager::Interop::IVsHiddenTextClient ^ pClient, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsHiddenTextSession ^ % ppState);
public:
 int CreateHiddenTextSession(unsigned int dwFlags, Platform::Object ^ pOwningObject, Microsoft::VisualStudio::TextManager::Interop::IVsHiddenTextClient ^ pClient, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsHiddenTextSession ^ &  ppState);
int CreateHiddenTextSession(unsigned int dwFlags, winrt::Windows::Foundation::IInspectable const & pOwningObject, Microsoft::VisualStudio::TextManager::Interop::IVsHiddenTextClient const & pClient, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsHiddenTextSession const & & ppState);
public int CreateHiddenTextSession (uint dwFlags, object pOwningObject, Microsoft.VisualStudio.TextManager.Interop.IVsHiddenTextClient pClient, out Microsoft.VisualStudio.TextManager.Interop.IVsHiddenTextSession ppState);
abstract member CreateHiddenTextSession : uint32 * obj * Microsoft.VisualStudio.TextManager.Interop.IVsHiddenTextClient * IVsHiddenTextSession -> int
Public Function CreateHiddenTextSession (dwFlags As UInteger, pOwningObject As Object, pClient As IVsHiddenTextClient, ByRef ppState As IVsHiddenTextSession) As Integer

Parameters

dwFlags
UInt32

[in] This value is reserved for future use.

pOwningObject
Object

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

pClient
IVsHiddenTextClient

[in] Pointer to a hidden text client for the buffer. The hidden text client provides notification of when a hidden text or outlining region is expanded or collapsed by the user. For more information, see IVsHiddenTextClient.

ppState
IVsHiddenTextSession

[out] Pointer to the newly created hidden text session for the text buffer. For more information, see IVsHiddenTextSession.

Returns

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

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsHiddenTextManager::CreateHiddenTextSession  
   ([in] DWORD dwFlags,   
   [in] IUnknown *pOwningObject,   
   [in] IVsHiddenTextClient *pClient,   
   [out] IVsHiddenTextSession **ppState  
);  

If a hidden text session already exists in a buffer (that is, a call to GetHiddenTextSession is non-null, then you cannot specify a hidden text client (IVsHiddenTextManager) to inform you of user actions on the hidden text region.

Applies to