IVsSyntheticTextSession.AddSyntheticRegions Method

Article
05/06/2010

Adds synthetic text sessions.

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

Syntax

'Déclaration
Function AddSyntheticRegions ( _
    dwUpdateFlags As UInteger, _
    cRegions As Integer, _
    rgSynthReg As NewSyntheticRegion(), _
    <OutAttribute> ppEnum As IVsEnumSyntheticRegions() _
) As Integer
'Utilisation
Dim instance As IVsSyntheticTextSession
Dim dwUpdateFlags As UInteger
Dim cRegions As Integer
Dim rgSynthReg As NewSyntheticRegion()
Dim ppEnum As IVsEnumSyntheticRegions()
Dim returnValue As Integer

returnValue = instance.AddSyntheticRegions(dwUpdateFlags, _
    cRegions, rgSynthReg, ppEnum)

int AddSyntheticRegions(
    uint dwUpdateFlags,
    int cRegions,
    NewSyntheticRegion[] rgSynthReg,
    IVsEnumSyntheticRegions[] ppEnum
)

int AddSyntheticRegions(
    [InAttribute] unsigned int dwUpdateFlags, 
    [InAttribute] int cRegions, 
    [InAttribute] array<NewSyntheticRegion>^ rgSynthReg, 
    [OutAttribute] array<IVsEnumSyntheticRegions^>^ ppEnum
)

abstract AddSyntheticRegions : 
        dwUpdateFlags:uint32 * 
        cRegions:int * 
        rgSynthReg:NewSyntheticRegion[] * 
        ppEnum:IVsEnumSyntheticRegions[] byref -> int

function AddSyntheticRegions(
    dwUpdateFlags : uint, 
    cRegions : int, 
    rgSynthReg : NewSyntheticRegion[], 
    ppEnum : IVsEnumSyntheticRegions[]
) : int

Parameters

dwUpdateFlags
Type: System.UInt32
[in] Update flags. For values of dwUpdateFlags see the CHANGE_SYNTHETIC_REGION_FLAGS enumeration.

cRegions
Type: System.Int32
[in] Number of regions to add.

rgSynthReg
Type: array<Microsoft.VisualStudio.TextManager.Interop.NewSyntheticRegion[]
[in] An array of cRegions structs defining the new regions.

ppEnum
Type: array<Microsoft.VisualStudio.TextManager.Interop.IVsEnumSyntheticRegions[]
[out] May be nulla null reference (Nothing in Visual Basic); if non-null, returns an enumeration of the new regions.

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 IVsSyntheticTextSession::AddSyntheticRegions(
   [in] DWORD dwUpdateFlags,
   [in] long cRegions,
   [in, size_is(cRegions)] NewSyntheticRegion *rgSynthReg,
   [out] IVsEnumSyntheticRegions **ppEnum
);

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