VCCodeMacro Interface

An object representing a macro (#define statement) code element in the source code of a solution.

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

Syntax

'Declaration
<GuidAttribute("F3F444D1-E125-4910-871B-1533F6F70BEC")> _
Public Interface VCCodeMacro
[GuidAttribute("F3F444D1-E125-4910-871B-1533F6F70BEC")]
public interface VCCodeMacro
[GuidAttribute(L"F3F444D1-E125-4910-871B-1533F6F70BEC")]
public interface class VCCodeMacro
[<GuidAttribute("F3F444D1-E125-4910-871B-1533F6F70BEC")>]
type VCCodeMacro =  interface end
public interface VCCodeMacro

The VCCodeMacro type exposes the following members.

Properties

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

Top

Methods

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

Top

Remarks

The VCCodeMacroobject represents the #define code element. Primarily, the object is used to access or modify the elements of an existing macro.

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

Examples

This example retrieves the first VCCodeMacro object of the current solution and displays it in a message box. It assumes a default MFC project is open.

Sub GetFirstMacro()
    Dim vcCM As VCCodeModel
    Dim vcMacro As VCCodeMacro
    vcCM = DTE.Solution.Item(1).CodeModel
    vcMacro = vcCM.Macros.Item(1)
    MsgBox(vcMacro.DisplayName)
End Sub

See Also

Reference

Microsoft.VisualStudio.VCCodeModel Namespace