Share via


IVsCommentTaskInfo.DefaultToken(IVsCommentTaskToken) Method

Definition

Returns the default comment task token.

public:
 int DefaultToken([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsCommentTaskToken ^ % ppToken);
public:
 int DefaultToken([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsCommentTaskToken ^ &  ppToken);
int DefaultToken([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsCommentTaskToken const & & ppToken);
public int DefaultToken (out Microsoft.VisualStudio.Shell.Interop.IVsCommentTaskToken ppToken);
abstract member DefaultToken : IVsCommentTaskToken -> int
Public Function DefaultToken (ByRef ppToken As IVsCommentTaskToken) As Integer

Parameters

ppToken
IVsCommentTaskToken

[out, retval] Pointer to the IVsCommentTaskToken interface of the default comment task token.

Returns

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsCommentTaskInfo::DefaultToken(  
   [out, retval] IVsCommentTaskToken** ppToken  
);  

This is the token that add-ins should use when inserting generic comment tasks into the user's code. In the Visual Studio IDE, the default comment task token is "TODO" with normal priority. The name of the default comment task token cannot be changed, but the user can change its priority.

Applies to