Export (0) Print
Expand All

AddInclude Method (VCCodeModel)

Visual Studio .NET 2003

Adds a #include element to a specific file.

[Visual Basic .NET]
Public Function AddInclude( _
   ByVal Name As String, _
   ByVal Location As Object, _
   Optional ByVal Position As Object _
) As VCCodeInclude
[Visual Basic 6]
Function AddInclude( _
   ByVal Name As String, _
   ByVal Location As Variant, _
   Optional ByVal Position As Variant _
) As VCCodeInclude
[C++]
HRESULT __stdcall AddInclude(
   BSTR Name,
   VARIANT Location,
   VARIANT Position,
   /* [out, retval] */ VCCodeInclude** retVal
);
[C#]
public VCCodeInclude AddInclude(
   string Name,
   object Location,
   object Position
);
[JScript .NET]
public function AddInclude(
   Name : String,
   Location : Object,
   Position : Object
) : VCCodeInclude

Parameters

Name
Required. Specifies the name (in quotes or angle brackets) of the file being included.
Location
Required. The path or filename 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 AddInclude fails.
Position
Required. 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.

Return Value

Returns a VCCodeInclude object.

Remarks

Call this function to insert a #include element into the specified file of the VCCodeModel object.

Example

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

Sub AddInclude()
    Dim codeModel As VCCodeModel
    codeModel = DTE.Solution.Item(1).CodeModel
    Dim include As VCCodeInclude
    include = codeModel.AddInclude("""stdafx.h""", "File.h", 0)
End Sub

See Samples for Code Model Extensibility for information on how to compile and run this sample.

See Also

Applies To: VCCodeModel Object

Show:
© 2014 Microsoft