VCCodeModel.AddMacro(String, Object, String, Object) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.VCCodeModel

Assembly:: Microsoft.VisualStudio.VCCodeModel.dll

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.

Adds a #define element to a specific file.

Microsoft::VisualStudio::VCCodeModel::VCCodeMacro AddMacro(std::wstring const & Name, winrt::Windows::Foundation::IInspectable const & Location, std::wstring const & Value = "", winrt::Windows::Foundation::IInspectable const & Position);

[System.Runtime.InteropServices.DispId(564)]
public Microsoft.VisualStudio.VCCodeModel.VCCodeMacro AddMacro (string Name, object Location, string Value = "", object Position);

[<System.Runtime.InteropServices.DispId(564)>]
abstract member AddMacro : string * obj * string * obj -> Microsoft.VisualStudio.VCCodeModel.VCCodeMacro

Public Function AddMacro (Name As String, Location As Object, Optional Value As String = "", Optional Position As Object) As VCCodeMacro

Parameters

Name: String

Required. Specifies the name of the macro.

Location: Object

Required. The path or file name of the file to be modified. If the file does not exist, it is created automatically. The file is added to the project if it is not already a project item. If the file cannot be created and added to the project, then AddMacro(String, Object, String, Object) fails.

Value: String

Optional. The text of the macro's definition.

Position: Object

Optional. Default = 0. The code element after which to add the new element. If the value is a CodeElement, then the new element is added immediately after it.Since collections begin their count at one, passing 0 indicates that the new element should be placed at the beginning of the collection. A value of -1 means the element should be placed at the end.

Returns

VCCodeMacro

A VCCodeMacro object.

Attributes: DispIdAttribute

Examples

This example adds a macro statement to the stdafx.h file.

Sub AddMacro()  
    Dim codeModel As VCCodeModel  
    codeModel = DTE.Solution.Item(1).CodeModel  
    Dim macro As VCCodeMacro  
    macro = codeModel.AddMacro("LAST_CHAR", "File.h", "'Z'")  
End Sub

Remarks

Call this function to add a #define Directive (C/C++) element to the specified file.

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

Applies to