IVsOutliningSession.AddOutlineRegions Method

Creates an outlining region over the specified span of text.

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

Syntax

'宣言
Function AddOutlineRegions ( _
    dwOutliningFlags As UInteger, _
    cRegions As Integer, _
    rgOutlnReg As NewOutlineRegion() _
) As Integer
'使用
Dim instance As IVsOutliningSession
Dim dwOutliningFlags As UInteger
Dim cRegions As Integer
Dim rgOutlnReg As NewOutlineRegion()
Dim returnValue As Integer

returnValue = instance.AddOutlineRegions(dwOutliningFlags, _
    cRegions, rgOutlnReg)
int AddOutlineRegions(
    uint dwOutliningFlags,
    int cRegions,
    NewOutlineRegion[] rgOutlnReg
)
int AddOutlineRegions(
    [InAttribute] unsigned int dwOutliningFlags, 
    [InAttribute] int cRegions, 
    [InAttribute] array<NewOutlineRegion>^ rgOutlnReg
)
function AddOutlineRegions(
    dwOutliningFlags : uint, 
    cRegions : int, 
    rgOutlnReg : NewOutlineRegion[]
) : int

Parameters

  • cRegions
    Type: System.Int32

    [in] Number of outlining regions to add.

  • rgOutlnReg
    Type: []

    [in, size_is(cRegions)] Caller-allocated array of outlining regions to add. For more information, see NewOutlineRegion.

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 IVsOutliningSession::AddOutlineRegions(
   [in] DWORD dwOutliningFlags, 
   [in] long cRegions, 
   [in, size_is(cRegions)] NewOutlineRegion *rgOutlnReg
);

If you have a several regions that you want to outline in the text buffer, then create an array of outline regions and then call AddOutlineRegions once.

Permissions

See Also

Reference

IVsOutliningSession Interface

IVsOutliningSession Members

Microsoft.VisualStudio.TextManager.Interop Namespace