VCCodeModel.AddMacro メソッド

[アーティクル]
01/29/2008

特定のファイルに #define 要素を追加します。

名前空間 : Microsoft.VisualStudio.VCCodeModel
アセンブリ : Microsoft.VisualStudio.VCCodeModel (Microsoft.VisualStudio.VCCodeModel.dll 内)

構文

'宣言
Function AddMacro ( _
    Name As String, _
    Location As Object, _
    Value As String, _
    Position As Object _
) As VCCodeMacro
'使用
Dim instance As VCCodeModel
Dim Name As String
Dim Location As Object
Dim Value As String
Dim Position As Object
Dim returnValue As VCCodeMacro

returnValue = instance.AddMacro(Name, _
    Location, Value, Position)

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

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

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

パラメータ

Name
型 : System.String

必ず指定します。マクロの名前を指定します。

Location
型 : System.Object

必ず指定します。変更するファイルのパスまたはファイル名。ファイルが存在しない場合は、自動的に作成されます。ファイルが既にプロジェクト項目になっていない場合は、ファイルがプロジェクトに追加されます。ファイルを作成してプロジェクトに追加できない場合、AddMacro は失敗します。

Value
型 : System.String

省略可能です。マクロ定義のテキストです。

Position
型 : System.Object

省略可能です。既定では 0 が指定されます。ここで指定したコード要素の後に、新しい要素を追加します。値が CodeElement の場合は、その値の直後に新しい要素が追加されます。

コレクションは 1 からカウントを開始するので、0 が渡された場合は、新規の要素はコレクションの先頭に配置されます。値 -1 は要素を末尾に配置することを示します。

戻り値

型 : Microsoft.VisualStudio.VCCodeModel.VCCodeMacro

VCCodeMacro オブジェクト。

解説

この関数は、指定したファイルに The #define Directive 要素を追加するために呼び出します。

このサンプルコードをコンパイルして実行する方法については、「方法 : Visual C++ コードモデル機能拡張のプログラム例をコンパイルする」を参照してください。

例

次の例では、stdafx.h ファイルにマクロステートメントを追加します。

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