VCFileCodeModel.AddInclude メソッド

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

VCFileCodeModel オブジェクトに #include 要素を追加します。

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

構文

'宣言
Function AddInclude ( _
    Name As String, _
    Position As Object _
) As VCCodeInclude
'使用
Dim instance As VCFileCodeModel
Dim Name As String
Dim Position As Object
Dim returnValue As VCCodeInclude

returnValue = instance.AddInclude(Name, _
    Position)

VCCodeInclude AddInclude(
    string Name,
    Object Position
)

VCCodeInclude^ AddInclude(
    String^ Name, 
    Object^ Position
)

function AddInclude(
    Name : String, 
    Position : Object
) : VCCodeInclude

パラメータ

Name
型 : System.String

必ず指定します。インクルードするファイルの名前を二重引用符または山かっこで囲んで指定します。

Position
型 : System.Object

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

コレクションのカウントは 1 から始まるため、0 を指定すると新しい要素がコレクションの最初に配置されます。値 -1 は要素を末尾に配置することを示します。

戻り値

型 : Microsoft.VisualStudio.VCCodeModel.VCCodeInclude

VCCodeInclude オブジェクト。

解説

この関数は、VCFileCodeModel オブジェクトが表すファイルに The #include Directive 要素を挿入するために呼び出します。

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

例

この例では、vcFile オブジェクトで表されるファイルに、#include ステートメントを追加します。

Sub AddInclude()
    Dim vcFile as VCFileCodeModel
    vcFile = DTE.Solution.Item(1).ProjectItems.Item(1).FileCodeModel
    vcFile.AddInclude("""stdafx.h""", 0)
End Sub