VCFileCodeModel.AddMacro Method
Adds a #define element to the VCFileCodeModel object.
Namespace: Microsoft.VisualStudio.VCCodeModel
Assembly: Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.dll)
Syntax
'Declaration
Function AddMacro ( _
Name As String, _
Value As String, _
Position As Object _
) As VCCodeMacro
VCCodeMacro AddMacro(
string Name,
string Value,
Object Position
)
VCCodeMacro^ AddMacro(
String^ Name,
String^ Value,
Object^ Position
)
abstract AddMacro :
Name:string *
Value:string *
Position:Object -> VCCodeMacro
function AddMacro(
Name : String,
Value : String,
Position : Object
) : VCCodeMacro
Parameters
Name
Type: System.StringRequired. Specifies the name (in quotes or angle brackets) of the file being included.
Value
Type: System.StringOptional. The text of the macro's definition.
Position
Type: System.ObjectRequired. 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.
Because 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 insert a #define Directive (C/C++) element into the file represented by the VCFileCodeModel object.
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 file represented by the vcFile object.
Sub AddMacro()
Dim vcFile as VCFileCodeModel
vcFile = DTE.Solution.Item(1).ProjectItems.Item(1).FileCodeModel
vcFile.AddMacro("LAST_CHAR", "'Z'", 0)
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.