IVsEnumCommentTaskTokens.Clone Method

Article
03/06/2013

Creates another enumerator that contains the same enumeration state as the current one.

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

Syntax

'Declaration
Function Clone ( _
    <OutAttribute> ByRef ppenum As IVsEnumCommentTaskTokens _
) As Integer

int Clone(
    out IVsEnumCommentTaskTokens ppenum
)

int Clone(
    [OutAttribute] IVsEnumCommentTaskTokens^% ppenum
)

abstract Clone : 
        ppenum:IVsEnumCommentTaskTokens byref -> int

function Clone(
    ppenum : IVsEnumCommentTaskTokens
) : int

Parameters

ppenum
Type: Microsoft.VisualStudio.Shell.Interop.IVsEnumCommentTaskTokens%
[out] Pointer to the cloned IVsEnumCommentTaskTokens interface.

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::Clone(
   [out] IVsEnumCommentTaskTokens **ppenum
);

Using this method, a client can record a snapshot of the enumeration sequence and later return to that point. The new enumerator supports the same interface as the original one.

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