CodeModel::AddInterface Method (String^, Object^, Object^, Object^, vsCMAccess)

 

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

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

CodeInterface^ AddInterface(
	String^ Name,
	Object^ Location,
	Object^ Position,
	Object^ Bases,
	vsCMAccess Access = vsCMAccess::vsCMAccessDefault
)

Parameters

Name
Type: System::String^

Required. The name of the interface to add.

Location
Type: System::Object^

Required. The path and file name for the new interface definition. Depending on the language, the file name is either relative or absolute to the project file. The file is added to the project if it is not already a project item. If the file cannot be created and added to the project, then AddInterface fails.

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 AddInterface 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.

Bases
Type: System::Object^

Optional. Default value is Nothing. A variant that holds a SafeArray of fully qualified type names or CodeInterface objects from which the new interface derives.

Access
Type: EnvDTE::vsCMAccess

Optional. A vsCMAccess constant.

Return Value

Type: EnvDTE::CodeInterface^

A CodeInterface object.

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.

System_CAPS_noteNote

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).

No code example is currently available or this language may not be supported.
Return to top
Show: