VCCodeModel.AddTypedef Method

Article
10/10/2013

Adds a typedef element to a specific file.

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

Syntax

'Declaration
Function AddTypedef ( _
    Name As String, _
    Location As Object, _
    Type As Object, _
    Position As Object, _
    Access As vsCMAccess _
) As VCCodeTypedef

VCCodeTypedef AddTypedef(
    string Name,
    Object Location,
    Object Type,
    Object Position,
    vsCMAccess Access
)

VCCodeTypedef^ AddTypedef(
    String^ Name, 
    Object^ Location, 
    Object^ Type, 
    Object^ Position, 
    vsCMAccess Access
)

abstract AddTypedef : 
        Name:string * 
        Location:Object * 
        Type:Object * 
        Position:Object * 
        Access:vsCMAccess -> VCCodeTypedef

function AddTypedef(
    Name : String, 
    Location : Object, 
    Type : Object, 
    Position : Object, 
    Access : vsCMAccess
) : VCCodeTypedef

Parameters

Name
Type: System.String

Required. The name (or identifier) of the type declaration.

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

Type
Type: System.Object

Required. The type of the element. Can be any standard C++ type.

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.

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.VCCodeTypedef
A VCCodeTypedef object.

Remarks

Call this function to add a VCCodeTypedef 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 typedef statement to the stdafx.h file.

Sub AddTypedef()
    Dim codeModel As VCCodeModel
    codeModel = DTE.Solution.Item(1).CodeModel
    Dim typedef As VCCodeTypedef
    typedef = codeModel.AddTypedef("TreeRoot", "File.h", "TreeNode*", "0")
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