VCCodeModel.AddInclude メソッド
特定のファイルに #include 要素を追加します。
名前空間: Microsoft.VisualStudio.VCCodeModel
アセンブリ: Microsoft.VisualStudio.VCCodeModel (Microsoft.VisualStudio.VCCodeModel.dll 内)
構文
'宣言
Function AddInclude ( _
Name As String, _
Location As Object, _
Position As Object _
) As VCCodeInclude
VCCodeInclude AddInclude(
string Name,
Object Location,
Object Position
)
VCCodeInclude^ AddInclude(
String^ Name,
Object^ Location,
Object^ Position
)
abstract AddInclude :
Name:string *
Location:Object *
Position:Object -> VCCodeInclude
function AddInclude(
Name : String,
Location : Object,
Position : Object
) : VCCodeInclude
パラメーター
Name
型 : String必須。 インクルードするファイルの名前を二重引用符または山かっこで囲んで指定します。
Location
型 : Object必須。 変更するファイルのパスまたはファイル名。 ファイルが存在しない場合は、自動的に作成されます。 ファイルが既にプロジェクト項目になっていない場合は、ファイルがプロジェクトに追加されます。 ファイルを作成してプロジェクトに追加できない場合、AddInclude は失敗します。
Position
型 : Object必須。 既定値は 0 です。 ここで指定したコード要素の後に、新しい要素を追加します。 値が CodeElement の場合は、その値の直後に新しい要素が追加されます。
コレクションは 1 からカウントを開始するので、0 が渡された場合は、新規の要素はコレクションの先頭に配置されます。 値 -1 は要素を末尾に配置することを示します。
戻り値
型 : Microsoft.VisualStudio.VCCodeModel.VCCodeInclude
VCCodeInclude オブジェクト。
解説
この関数は、VCCodeModel オブジェクトの特定のファイルに #include ディレクティブ (C/C++) 要素を挿入するために呼び出します。
このサンプル コードをコンパイルして実行する方法については、「方法 : Visual C++ コード モデル機能拡張のプログラム例をコンパイルする」を参照してください。
例
次の例では、stdafx.h ファイルに #include ステートメントを追加します。
Sub AddInclude()
Dim codeModel As VCCodeModel
codeModel = DTE.Solution.Item(1).CodeModel
Dim include As VCCodeInclude
include = codeModel.AddInclude("""stdafx.h""", "File.h", 0)
End Sub
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。