CodeClass2.AddVariable メソッド (String, Object, Object, vsCMAccess, Object)
クラスに新しい変数を作成します。
名前空間: EnvDTE80
アセンブリ: EnvDTE80 (EnvDTE80.dll 内)
構文
'宣言
Function AddVariable ( _
Name As String, _
Type As Object, _
Position As Object, _
Access As vsCMAccess, _
Location As Object _
) As CodeVariable
CodeVariable AddVariable(
string Name,
Object Type,
Object Position,
vsCMAccess Access,
Object Location
)
CodeVariable^ AddVariable(
String^ Name,
Object^ Type,
Object^ Position,
vsCMAccess Access,
Object^ Location
)
abstract AddVariable :
Name:string *
Type:Object *
Position:Object *
Access:vsCMAccess *
Location:Object -> CodeVariable
function AddVariable(
Name : String,
Type : Object,
Position : Object,
Access : vsCMAccess,
Location : Object
) : CodeVariable
パラメーター
- Name
型 : System.String
必ず指定します。新しい変数の名前。
- Type
型 : System.Object
必ず指定します。関数で返されるデータ型を示す vsCMTypeRef 定数です。CodeTypeRef オブジェクト、vsCMTypeRef 定数、または完全修飾型名のいずれかになります。
- Position
型 : System.Object
省略可能です。既定値は 0 です。ここで指定したコード要素の後に、新しい要素を追加します。
値が long 型の場合は、後ろに新しい要素を追加する要素が Position によって示されます。
コレクションのカウントは 1 から始まるため、0 を指定すると新しい要素がコレクションの最初に配置されます。値 -1 は要素を末尾に配置することを示します。
- Access
型 : EnvDTE.vsCMAccess
省略可能です。定数 vsCMAccess。
- Location
型 : System.Object
省略可能です。新しい変数定義のパスとファイル名。言語に応じて、ファイル名はプロジェクト ファイルへの相対パスまたは絶対パスで表されます。ファイルが既にプロジェクト項目になっていない場合は、ファイルがプロジェクトに追加されます。ファイルの作成およびプロジェクトへの追加ができない場合は、AddVariable が失敗します。
戻り値
型 : EnvDTE.CodeVariable
CodeVariable オブジェクト。
解説
ネイティブな Visual C++ では、コロン区切り形式 (::) で完全修飾型名を指定する必要があります。他のすべての言語では、ピリオド区切りの形式がサポートされます。
引数が正しいかどうかは、コード モデルの背後にある言語によって決まります。
[!メモ]
特定の種類の編集を行った後に、クラス、構造体、関数、属性、デリゲートなどのコード モデル要素の値を決定できないことがあります。つまり、これらの要素の値は、信頼できる値ではなく、常に同じ値になるとは限りません。詳細については、「コード モデルを使用したコードの調査 (Visual Basic)」で、コード モデル要素値を変更する方法についての説明を参照してください。
例
[C#]
public void CodeClass2AddVariableExample(DTE2 dte2)
{
// Before running this example, open a code document from a project
// and place the insertion point inside a class definition.
try
{
// Retrieve the CodeClass at the insertion point.
TextSelection sel =
(TextSelection)dte2.ActiveDocument.Selection;
CodeClass2 cls =
(CodeClass2)sel.ActivePoint.get_CodeElement(
vsCMElement.vsCMElementClass);
object pos = -1; // Place variable at end of members collection
// Add variable to ActiveDocument.
CodeVariable cvar = cls.AddVariable("TestAddVar",
vsCMTypeRef.vsCMTypeRefFloat, pos,
vsCMAccess.vsCMAccessProtected, null);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
}
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。
参照
関連項目
その他の技術情報
方法 : オートメーション オブジェクト モデルのコード例をコンパイルおよび実行する