VCCodeModel.AddInterface Method

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

Namespace:  Microsoft.VisualStudio.VCCodeModel
Assembly:  Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.dll)

Syntax

'Declaration
Function AddInterface ( _
    Name As String, _
    Location As Object, _
    Position As Object, _
    Bases As Object, _
    Access As vsCMAccess _
) As CodeInterface
CodeInterface AddInterface(
    string Name,
    Object Location,
    Object Position,
    Object Bases,
    vsCMAccess Access
)
CodeInterface^ AddInterface(
    String^ Name, 
    Object^ Location, 
    Object^ Position, 
    Object^ Bases, 
    vsCMAccess Access
)
abstract AddInterface : 
        Name:string * 
        Location:Object * 
        Position:Object * 
        Bases:Object * 
        Access:vsCMAccess -> CodeInterface
function AddInterface(
    Name : String, 
    Location : Object, 
    Position : Object, 
    Bases : Object, 
    Access : vsCMAccess
) : CodeInterface

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 the element should be placed at the end.

  • Bases
    Type: System.Object

    Optional. Default value is Nothing or nulla null reference (Nothing in Visual Basic). A variant that holds a SafeArray of fully qualified type names or CodeInterface objects from which the new interface derives.

Return Value

Type: EnvDTE.CodeInterface
A CodeInterface object.

Remarks

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.

.NET Framework Security

See Also

Reference

VCCodeModel Interface

Microsoft.VisualStudio.VCCodeModel Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples