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

Definition

Namespace:

Microsoft.VisualStudio.VCCodeModel

Assembly:

Microsoft.VisualStudio.VCCodeModel.dll

Adds a typedef element to a specific file.

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

[System.Runtime.InteropServices.DispId(566)]
public Microsoft.VisualStudio.VCCodeModel.VCCodeTypedef AddTypedef (string Name, object Location, object Type, object Position, EnvDTE.vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault);

[<System.Runtime.InteropServices.DispId(566)>]
abstract member AddTypedef : string * obj * obj * obj * EnvDTE.vsCMAccess -> Microsoft.VisualStudio.VCCodeModel.VCCodeTypedef

Public Function AddTypedef (Name As String, Location As Object, Optional Type As Object, Optional Position As Object, Optional Access As vsCMAccess = EnvDTE.vsCMAccess.vsCMAccessDefault) As VCCodeTypedef

Parameters

Name

String

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

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

Type

Object

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

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

VCCodeTypedef

A VCCodeTypedef object.

Attributes

DispIdAttribute

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  

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.