VCCodeMapEntry Interface

 

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

Namespace:   Microsoft.VisualStudio.VCCodeModel
Assembly:  Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.dll)

[GuidAttribute("D883C9FF-5BF7-4BAF-855D-F9B2BDD649E8")]
public interface VCCodeMapEntry

NameDescription
System_CAPS_pubpropertyChildren

Gets a collection of objects contained within this code construct.

System_CAPS_pubpropertyCodeModel

Gets the VCCodeModel object for the project.

System_CAPS_pubpropertyCollection

Gets the collection containing the object supporting this property or contained within this code construct.

System_CAPS_pubpropertyComment

Gets or sets the comment associated with the code element.

System_CAPS_pubpropertyDisplayName

Gets the name used in the user interface for this output group.

System_CAPS_pubpropertyDTE

Gets the top-level extensibility object.

System_CAPS_pubpropertyEndPoint

Gets the edit point that is the location of the end of the code item.

System_CAPS_pubpropertyEndPointOf[vsCMPart, vsCMWhere]

Gets the end point of the object.

System_CAPS_pubpropertyExtender[String]

Gets the requested Extender object if it is available for this object.

System_CAPS_pubpropertyExtenderCATID

Gets the Extender category ID (CATID) for the object.

System_CAPS_pubpropertyExtenderNames

Gets a list of available Extenders for the object.

System_CAPS_pubpropertyFile

Gets the file where this object is defined.

System_CAPS_pubpropertyFullName

Gets the full path and name of the object's file.

System_CAPS_pubpropertyInfoLocation

Gets the capabilities of the code model.

System_CAPS_pubpropertyIsCaseSensitive

Gets a value indicating whether a code element is case-sensitive.

System_CAPS_pubpropertyIsCodeType

Gets a value indicating whether a CodeType object can be obtained from this object.

System_CAPS_pubpropertyIsInjected

Gets a value indicating whether a code element has been injected by an attribute or macro expansion.

System_CAPS_pubpropertyIsReadOnly

Gets a value indicating whether the file containing the object is read-only.

System_CAPS_pubpropertyIsZombie

Gets a value indicating whether the object no longer exists.

System_CAPS_pubpropertyKind

Gets an enumeration indicating the type of object.

System_CAPS_pubpropertyLanguage

Gets the programming language used to author the code.

System_CAPS_pubpropertyLocation[vsCMWhere]

Gets the location of the object declaration.

System_CAPS_pubpropertyName

Gets or sets the name of the object.

System_CAPS_pubpropertyNamespace

Gets an object defining the namespace.

System_CAPS_pubpropertyParameters

Gets a collection of parameters for this item.

System_CAPS_pubpropertyParent

Gets the immediate parent object of a given object.

System_CAPS_pubpropertyPicture

Gets a picture automation object to be used as an icon in the user interface.

System_CAPS_pubpropertyProject

Gets the Project object associated with the object.

System_CAPS_pubpropertyProjectItem

Gets the ProjectItem object associated with the given object.

System_CAPS_pubpropertyStartPoint

Gets a TextPoint object that defines the beginning of the code item.

System_CAPS_pubpropertyStartPointOf[vsCMPart, vsCMWhere]

Gets the start point of the object.

NameDescription
System_CAPS_pubmethodAddParameter(String, Object)

Creates a new parameter code construct and inserts the code in the correct location.

System_CAPS_pubmethodGetEndPoint(vsCMPart)

Gets a TextPoint object that marks the end of the code element definition.

System_CAPS_pubmethodGetStartPoint(vsCMPart)

Gets a TextPoint object that defines the beginning of the code element definition.

System_CAPS_pubmethodIsSelf(Object)

Determines if the specified code element is the same as another code element.

System_CAPS_pubmethodRemoveParameter(Object)

Removes a parameter from the argument list.

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.

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
Return to top
Show: