次の方法で共有


VCCodeModel.AddMacro メソッド

特定のファイルに #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
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

パラメーター

  • Name
    型 : String

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

  • Location
    型 : Object

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

  • Value
    型 : String

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

  • Position
    型 : Object

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

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

戻り値

型 : Microsoft.VisualStudio.VCCodeModel.VCCodeMacro
VCCodeMacro オブジェクト。

解説

この関数は、指定したファイルに #define ディレクティブ (C/C++) 要素を追加するために呼び出します。

このサンプル コードをコンパイルして実行する方法については、「方法 : 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

.NET Framework セキュリティ

  • 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。

参照

関連項目

VCCodeModel インターフェイス

Microsoft.VisualStudio.VCCodeModel 名前空間