IVsEnumCommentTaskTokens.Next Method

Article
07/12/2014

Retrieves a specified number of comment task tokens in the enumeration sequence.

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

Syntax

'Declaration
Function Next ( _
    celt As UInteger, _
    <OutAttribute> rgelt As IVsCommentTaskToken(), _
    <OutAttribute> ByRef pceltFetched As UInteger _
) As Integer

int Next(
    uint celt,
    IVsCommentTaskToken[] rgelt,
    out uint pceltFetched
)

int Next(
    [InAttribute] unsigned int celt, 
    [OutAttribute] array<IVsCommentTaskToken^>^ rgelt, 
    [OutAttribute] unsigned int% pceltFetched
)

abstract Next : 
        celt:uint32 * 
        rgelt:IVsCommentTaskToken[] byref * 
        pceltFetched:uint32 byref -> int

function Next(
    celt : uint, 
    rgelt : IVsCommentTaskToken[], 
    pceltFetched : uint
) : int

Parameters

celt
Type: System.UInt32

[in] The requested number of comment task tokens to retrieve.

rgelt
Type: array<Microsoft.VisualStudio.Shell.Interop.IVsCommentTaskToken[]

[out, size_is(celt), length_is(*pceltFetched)] The list of IVsCommentTaskToken objects that have been retrieved.

pceltFetched
Type: System.UInt32%

[out] Pointer to the actual number of comment task tokens supplied in rgelt. Returns nulla null reference (Nothing in Visual Basic) if celt is one.

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 vsshell.idl:

HRESULT IVsEnumCommentTaskTokens::Next(
   [in] ULONG celt,
   [out, size_is(celt), length_is(*pceltFetched)] IVsCommentTaskToken **rgelt,
   [out] ULONG *pceltFetched
);

The comment task tokens are retrieved from the current position of the enumeration. The Reset and Skip methods of this interface can be used to get to a particular position of the enumeration before using IVsEnumCommentTaskTokens.Next to retrieve the tokens from the enumeration.

.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