IVsCommentTaskToken Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents one comment task token.
public interface class IVsCommentTaskTokenpublic interface class IVsCommentTaskToken__interface IVsCommentTaskToken[System.Runtime.InteropServices.Guid("327C43D7-CCB1-41D7-9A7B-CE87751201F7")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsCommentTaskToken[System.Runtime.InteropServices.Guid("327C43D7-CCB1-41D7-9A7B-CE87751201F7")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsCommentTaskToken[<System.Runtime.InteropServices.Guid("327C43D7-CCB1-41D7-9A7B-CE87751201F7")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsCommentTaskToken = interface[<System.Runtime.InteropServices.Guid("327C43D7-CCB1-41D7-9A7B-CE87751201F7")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsCommentTaskToken = interfacePublic Interface IVsCommentTaskToken- Attributes
Remarks
This interface encapsulates the information about a particular comment task token that a user enters via the Task List node of the Environment tree from the Options menu item of the Tools menu. Packages can use this information to find a particular comment task token in order to create its respective task in the task list.
When a document is opened it is parsed for comment identifiers (such as /* in C), and the first non-white space text following any comment identifier is parsed to see if it matches the text of any comment task tokens. If there is a match, a comment task token has been identified. Note that the text that identifies the comment task token is case sensitive.
See illustrations of the calling of this interface in the sample Figures Language Service.
Notes to Callers
Task providers would call this interface to get information about a particular comment task token.
Methods
| Priority(VSTASKPRIORITY[]) |
Returns the priority of a comment task token. |
| Text(String) |
Returns the text of a comment task token. |