IVsCommentTaskInfo.DefaultToken Method
Returns the default comment task token.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
Syntax
'Declaration
Function DefaultToken ( _
<OutAttribute> ByRef ppToken As IVsCommentTaskToken _
) As Integer
'Usage
Dim instance As IVsCommentTaskInfo
Dim ppToken As IVsCommentTaskToken
Dim returnValue As Integer
returnValue = instance.DefaultToken(ppToken)
int DefaultToken(
out IVsCommentTaskToken ppToken
)
int DefaultToken(
[OutAttribute] IVsCommentTaskToken^% ppToken
)
abstract DefaultToken :
ppToken:IVsCommentTaskToken byref -> int
function DefaultToken(
ppToken : IVsCommentTaskToken
) : int
Parameters
- ppToken
Type: Microsoft.VisualStudio.Shell.Interop.IVsCommentTaskToken%
[out, retval] Pointer to the IVsCommentTaskToken interface of the default comment task token.
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 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.
.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.