IVsHiddenTextManager.CreateHiddenTextSession Method

Article
09/25/2012

Creates a new hidden text session for a text buffer.

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

Syntax

'Declaration
Function CreateHiddenTextSession ( _
    dwFlags As UInteger, _
    pOwningObject As Object, _
    pClient As IVsHiddenTextClient, _
    <OutAttribute> ByRef ppState As IVsHiddenTextSession _
) As Integer

'Usage
Dim instance As IVsHiddenTextManager 
Dim dwFlags As UInteger 
Dim pOwningObject As Object 
Dim pClient As IVsHiddenTextClient 
Dim ppState As IVsHiddenTextSession 
Dim returnValue As Integer 

returnValue = instance.CreateHiddenTextSession(dwFlags, _
    pOwningObject, pClient, ppState)

int CreateHiddenTextSession(
    uint dwFlags,
    Object pOwningObject,
    IVsHiddenTextClient pClient,
    out IVsHiddenTextSession ppState
)

int CreateHiddenTextSession(
    [InAttribute] unsigned int dwFlags, 
    [InAttribute] Object^ pOwningObject, 
    [InAttribute] IVsHiddenTextClient^ pClient, 
    [OutAttribute] IVsHiddenTextSession^% ppState
)

function CreateHiddenTextSession(
    dwFlags : uint, 
    pOwningObject : Object, 
    pClient : IVsHiddenTextClient, 
    ppState : IVsHiddenTextSession
) : int

Parameters

dwFlags
Type: System.UInt32

[in] This value is reserved for future use.

pOwningObject
Type: System.Object

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

pClient
Type: Microsoft.VisualStudio.TextManager.Interop.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
Type: Microsoft.VisualStudio.TextManager.Interop.IVsHiddenTextSession%

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

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:

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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via