IVsSyntheticTextManager.GetSyntheticTextSession Method

Asks the owning object whether a synthetic text session currently exists.

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

Syntax

'Declaration
Function GetSyntheticTextSession ( _
    pOwningObject As Object, _
    <OutAttribute> ByRef ppSession As IVsSyntheticTextSession _
) As Integer
'Usage
Dim instance As IVsSyntheticTextManager
Dim pOwningObject As Object
Dim ppSession As IVsSyntheticTextSession
Dim returnValue As Integer

returnValue = instance.GetSyntheticTextSession(pOwningObject, _
    ppSession)

int GetSyntheticTextSession(
    Object pOwningObject,
    out IVsSyntheticTextSession ppSession
)

int GetSyntheticTextSession(
    [InAttribute] Object^ pOwningObject, 
    [OutAttribute] IVsSyntheticTextSession^% ppSession
)

abstract GetSyntheticTextSession : 
        pOwningObject:Object * 
        ppSession:IVsSyntheticTextSession byref -> int

function GetSyntheticTextSession(
    pOwningObject : Object, 
    ppSession : IVsSyntheticTextSession
) : int

Parameters

pOwningObject
Type: System.Object
[in] The owning object (normally the buffer)

ppSession
Type: Microsoft.VisualStudio.TextManager.Interop.IVsSyntheticTextSession%
[out] An existing IVsSyntheticTextSession.

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 IVsSyntheticTextManager::GetSyntheticTextSession(
   [in] IUnknown *pOwningObject,
   [out] IVsSyntheticTextSession **ppSession
);

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