VCCodeModel.AddUsing(String, Object, Object) Method

Definition

Namespace:

Microsoft.VisualStudio.VCCodeModel

Assembly:

Microsoft.VisualStudio.VCCodeModel.dll

Adds a #using element to a specific file.

Microsoft::VisualStudio::VCCodeModel::VCCodeUsing AddUsing(std::wstring const & Name, winrt::Windows::Foundation::IInspectable const & Location, winrt::Windows::Foundation::IInspectable const & Position);

[System.Runtime.InteropServices.DispId(570)]
public Microsoft.VisualStudio.VCCodeModel.VCCodeUsing AddUsing (string Name, object Location, object Position);

[<System.Runtime.InteropServices.DispId(570)>]
abstract member AddUsing : string * obj * obj -> Microsoft.VisualStudio.VCCodeModel.VCCodeUsing

Public Function AddUsing (Name As String, Location As Object, Optional Position As Object) As VCCodeUsing

Parameters

Name

String

Required. Specifies the name of the assembly being imported.

Location

Object

Required. The path or file name of the file to be modified. If the file does not exist, it is created automatically. 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 AddUsing(String, Object, Object) fails.

Position

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.Since collections begin their count at one, 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.

Returns

VCCodeUsing

A VCCodeUsing object.

Attributes

DispIdAttribute

Examples

This example adds a #using statement to the stdafx.h file.

Sub AddUsing()  
    Dim codeModel As VCCodeModel  
    codeModel = DTE.Solution.Item(1).CodeModel  
    Dim using As VCCodeUsing  
    using = codeModel.AddUsing("<MyDll.dll>", "stdafx.h")  
End Sub  

Remarks

Call this function to import metadata into the VCCodeModel object.

See How to: Compile Example Code for Visual C++ Code Model Extensibility for information on how to compile and run this sample.