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

'宣告
<GuidAttribute("88BFCECB-1AFB-4353-A377-C878097467C9")> _
Public Interface VCCodeMacro

[GuidAttribute("88BFCECB-1AFB-4353-A377-C878097467C9")]
public interface VCCodeMacro

[GuidAttribute(L"88BFCECB-1AFB-4353-A377-C878097467C9")]
public interface class VCCodeMacro

[<GuidAttribute("88BFCECB-1AFB-4353-A377-C878097467C9")>]
type VCCodeMacro =  interface end

public interface VCCodeMacro

The VCCodeMacro type exposes the following members.

Properties

	Name	Description
	Children	Gets a collection of objects contained within this code construct.
	CodeModel	Gets the VCCodeModel 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 full name of the object.
	DTE	Gets the top-level extensibility object.
	EndPoint	Gets the edit point that is the location of the end of the code item.
	EndPointOf	Gets the end point of the object.
	Extender	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 exists.
	Kind	Gets an enumeration indicating the type of object.
	Language	Gets the programming language used to author the code.
	Location	Gets the location of the object declaration.
	Name	Gets or sets the name of the object.
	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 associated with the object.
	ProjectItem	Gets the ProjectItem object associated with the given object.
	References	Not currently implemented.
	StartPoint	Gets a TextPoint object that defines the beginning of the code item.
	StartPointOf	Gets the start point of the object.
	Value	Gets or sets the data for the object.

Top

Methods

	Name	Description
	AddParameter	Creates a new parameter code construct and inserts the code in the correct location.
	GetEndPoint	Gets a TextPoint object that marks the end of the code element definition.
	GetStartPoint	Gets a TextPoint object that defines the beginning of the code element definition.
	IsSelf	Determines if the specified code element is the same as another code element.
	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