VCCodeModel.AddMacro Method

Article
10/10/2013

Adds a #define element to a specific file.

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

Syntax

'Declaration
Function AddMacro ( _
    Name As String, _
    Location As Object, _
    Value As String, _
    Position As Object _
) As VCCodeMacro

VCCodeMacro AddMacro(
    string Name,
    Object Location,
    string Value,
    Object Position
)

VCCodeMacro^ AddMacro(
    String^ Name, 
    Object^ Location, 
    String^ Value, 
    Object^ Position
)

abstract AddMacro : 
        Name:string * 
        Location:Object * 
        Value:string * 
        Position:Object -> VCCodeMacro

function AddMacro(
    Name : String, 
    Location : Object, 
    Value : String, 
    Position : Object
) : VCCodeMacro

Parameters

Name
Type: System.String

Required. Specifies the name of the macro.

Location
Type: System.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 fails.

Value
Type: System.String

Optional. The text of the macro's definition.

Position
Type: System.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.

Return Value

Type: Microsoft.VisualStudio.VCCodeModel.VCCodeMacro
A VCCodeMacro object.

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.

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via