VCCodeMapEntry Interface

Definition

Namespace:

Microsoft.VisualStudio.VCCodeModel

Assembly:

Microsoft.VisualStudio.VCCodeModel.dll

An object defining a map entry construct in a source file.

public interface class VCCodeMapEntry

public interface class VCCodeMapEntry

__interface VCCodeMapEntry

[System.Runtime.InteropServices.Guid("C1EC2F79-3644-40D7-8F62-4BB1070CE20B")]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)]
public interface VCCodeMapEntry

[<System.Runtime.InteropServices.Guid("C1EC2F79-3644-40D7-8F62-4BB1070CE20B")>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)>]
type VCCodeMapEntry = interface

Public Interface VCCodeMapEntry

Attributes

GuidAttribute TypeLibTypeAttribute

Examples

This example retrieves the first map entry element in the first VCCodeMap object of the current solution and displays it in a message box.

Sub GetFirstMapEntry()  
    Dim vcCM As VCCodeModel  
    Dim vcMap As VCCodeMap  
    vcCM = DTE.Solution.Item(1).CodeModel  
    vcMap = vcCM.Maps.Item(1)  
    MsgBox(vcMap.Entries.Item(1).DisplayName)  
End Sub  

Remarks

The VCCodeMapEntry object represents a map entry code element in a source file, allowing access or modification to existing map elements at the map entry level.

See How to: Compile Example Code for Visual C++ Code Model Extensibility for information on how to compile and run this sample.

Properties

Children	Gets a collection of objects contained within this code construct.
CodeModel	Gets the VCCodeModel object for the project.
Collection	Gets the collection containing the object supporting this property or contained within this code construct.
Comment	Gets or sets the comment associated with the code element.
DisplayName	Gets the name used in the user interface for this output group.
DTE	Gets the top-level extensibility object.
EndPoint	Gets the edit point that is the location of the end of the code item.
EndPointOf[vsCMPart, vsCMWhere]	Gets the end point of the object.
Extender[String]	Gets the requested Extender object if it is available for this object.
ExtenderCATID	Gets the Extender category ID (CATID) for the object.
ExtenderNames	Gets a list of available Extenders for the object.
File	Gets the file where this object is defined.
FullName	Gets the full path and name of the object's file.
InfoLocation	Gets the capabilities of the code model.
IsCaseSensitive	Gets a value indicating whether a code element is case-sensitive.
IsCodeType	Gets a value indicating whether a CodeType object can be obtained from this object.
IsInjected	Gets a value indicating whether a code element has been injected by an attribute or macro expansion.
IsReadOnly	Gets a value indicating whether the file containing the object is read-only.
IsZombie	Gets a value indicating whether the object no longer exists.
Kind	Gets an enumeration indicating the type of object.
Language	Gets the programming language used to author the code.
Location[vsCMWhere]	Gets the location of the object declaration.
Name	Gets or sets the name of the object.
Namespace	Gets an object defining the namespace.
Parameters	Gets a collection of parameters for this item.
Parent	Gets the immediate parent object of a given object.
Picture	Gets a picture automation object to be used as an icon in the user interface.
Project	Gets the Project object associated with the object.
ProjectItem	Gets the ProjectItem object associated with the given object.
StartPoint	Gets a TextPoint object that defines the beginning of the code item.
StartPointOf[vsCMPart, vsCMWhere]	Gets the start point of the object.

Methods

AddParameter(String, Object)	Creates a new parameter code construct and inserts the code in the correct location.
GetEndPoint(vsCMPart)	Gets a TextPoint object that marks the end of the code element definition.
GetStartPoint(vsCMPart)	Gets a TextPoint object that defines the beginning of the code element definition.
IsSelf(Object)	Determines if the specified code element is the same as another code element.
RemoveParameter(Object)	Removes a parameter from the argument list.