VCCodeModel.AddTypedef メソッド

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

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

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

構文

'宣言
Function AddTypedef ( _
    Name As String, _
    Location As Object, _
    Type As Object, _
    Position As Object, _
    Access As vsCMAccess _
) As VCCodeTypedef
'使用
Dim instance As VCCodeModel
Dim Name As String
Dim Location As Object
Dim Type As Object
Dim Position As Object
Dim Access As vsCMAccess
Dim returnValue As VCCodeTypedef

returnValue = instance.AddTypedef(Name, _
    Location, Type, Position, Access)

VCCodeTypedef AddTypedef(
    string Name,
    Object Location,
    Object Type,
    Object Position,
    vsCMAccess Access
)

VCCodeTypedef^ AddTypedef(
    String^ Name, 
    Object^ Location, 
    Object^ Type, 
    Object^ Position, 
    vsCMAccess Access
)

function AddTypedef(
    Name : String, 
    Location : Object, 
    Type : Object, 
    Position : Object, 
    Access : vsCMAccess
) : VCCodeTypedef

パラメータ

Name
型 : System.String

必ず指定します。型宣言の名前または識別子を指定します。

Location
型 : System.Object

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

Type
型 : System.Object

必ず指定します。要素の型を指定します。C++ の基本データ型ならば、どれでも使用できます。

Position
型 : System.Object

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

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

Access
型 : EnvDTE.vsCMAccess

省略可能です。Visual C++ コードモデルでは使用されません。

戻り値

型 : Microsoft.VisualStudio.VCCodeModel.VCCodeTypedef

VCCodeTypedef オブジェクト。

解説

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

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

例

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

Sub AddTypedef()
    Dim codeModel As VCCodeModel
    codeModel = DTE.Solution.Item(1).CodeModel
    Dim typedef As VCCodeTypedef
    typedef = codeModel.AddTypedef("TreeRoot", "File.h", "TreeNode*", "0")
End Sub