VCCodeModel.AddUnion(String, Object, Object, vsCMAccess) Method

Definition

Namespace:

Microsoft.VisualStudio.VCCodeModel

Assembly:

Microsoft.VisualStudio.VCCodeModel.dll

Adds a union element to the VCCodeModel object.

Microsoft::VisualStudio::VCCodeModel::VCCodeUnion AddUnion(std::wstring const & Name, winrt::Windows::Foundation::IInspectable const & Location, winrt::Windows::Foundation::IInspectable const & Position, EnvDTE::vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault);

[System.Runtime.InteropServices.DispId(567)]
public Microsoft.VisualStudio.VCCodeModel.VCCodeUnion AddUnion (string Name, object Location, object Position, EnvDTE.vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault);

[<System.Runtime.InteropServices.DispId(567)>]
abstract member AddUnion : string * obj * obj * EnvDTE.vsCMAccess -> Microsoft.VisualStudio.VCCodeModel.VCCodeUnion

Public Function AddUnion (Name As String, Location As Object, Optional Position As Object, Optional Access As vsCMAccess = EnvDTE.vsCMAccess.vsCMAccessDefault) As VCCodeUnion

Parameters

Name

String

Required. The name (or identifier) of the union element.

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 AddUnion(String, Object, Object, vsCMAccess) 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.

Access

vsCMAccess

Optional. Not used by the Visual C++ Code Model.

Returns

VCCodeUnion

A VCCodeUnion object.

Attributes

DispIdAttribute

Examples

This example adds a union statement to the stdafx.h file.

Sub AddUnion()  
    Dim codeModel As VCCodeModel  
    codeModel = DTE.Solution.Item(1).CodeModel  
    Dim union As VCCodeUnion  
    union = codeModel.AddUnion("MyUnion", "File.h", -1)  
End Sub  

Remarks

Call this function to add a VCCodeUnion element to the specified file.

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