CodeFunction::AddParameter Method (String^, Object^, Object^)

Visual Studio 2015

Creates a new parameter code construct and inserts the code in the correct location.

Namespace: EnvDTE
Assembly: EnvDTE (in EnvDTE.dll)

Syntax

CodeParameter^ AddParameter(
	String^ Name,
	Object^ Type,
	Object^ Position
)

Parameters

Name: Type: System::String^
Required. The name of the parameter.

Type: Type: System::Object^
Required. A vsCMTypeRef constant indicating the data type that the function returns. This can be a CodeTypeRef object, a vsCMTypeRef constant, or a fully qualified type name.

Position

Type: System::Object^

Optional. Default = 0. The code element after which to add the new element. If the value is a CodeElement, then the new element is added immediately after it.

If the value is a Long data type, then AddParameter indicates the element after which to add the new element.

Because collections begin their count at 1, passing 0 indicates that the new element should be placed at the beginning of the collection. A value of -1 means that the element should be placed at the end.

Return Value

Type: EnvDTE::CodeParameter^

A CodeParameter object.

Remarks

Native Native Visual C++ requires the colon-separated (::) format for its fully qualified type names. All other languages support the period-separated format.

The correctness of the arguments is determined by the language behind the code model.

Note
The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

Examples

C++

No code example is currently available or this language may not be supported.