VCCodeModel.AddUnion Method

Article
04/26/2013

Adds a union element to the VCCodeModel object.

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

Syntax

'Declaration
Function AddUnion ( _
    Name As String, _
    Location As Object, _
    Position As Object, _
    Access As vsCMAccess _
) As VCCodeUnion

VCCodeUnion AddUnion(
    string Name,
    Object Location,
    Object Position,
    vsCMAccess Access
)

VCCodeUnion^ AddUnion(
    String^ Name, 
    Object^ Location, 
    Object^ Position, 
    vsCMAccess Access
)

abstract AddUnion : 
        Name:string * 
        Location:Object * 
        Position:Object * 
        Access:vsCMAccess -> VCCodeUnion

function AddUnion(
    Name : String, 
    Location : Object, 
    Position : Object, 
    Access : vsCMAccess
) : VCCodeUnion

Parameters

Name
Type: String

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

Location
Type: 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 fails.

Position
Type: 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
Type: EnvDTE.vsCMAccess

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

Return Value

Type: Microsoft.VisualStudio.VCCodeModel.VCCodeUnion
A VCCodeUnion object.

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.

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via