VCMidlTool.HeaderFileName Property

Definition

Namespace:

Microsoft.VisualStudio.VCProjectEngine

Assembly:

Microsoft.VisualStudio.VCProjectEngine.dll

Package:

Microsoft.VisualStudio.VCProjectEngine v17.12.40390

Gets or sets the name of the generated header file; default is idlfile.h.

public:
 property System::String ^ HeaderFileName { System::String ^ get(); void set(System::String ^ value); };

public:
 property Platform::String ^ HeaderFileName { Platform::String ^ get(); void set(Platform::String ^ value); };

[System.Runtime.InteropServices.DispId(31)]
public string HeaderFileName { [System.Runtime.InteropServices.DispId(31)] get; [System.Runtime.InteropServices.DispId(31)] set; }

[<System.Runtime.InteropServices.DispId(31)>]
[<get: System.Runtime.InteropServices.DispId(31)>]
[<set: System.Runtime.InteropServices.DispId(31)>]
member this.HeaderFileName : string with get, set

Public Property HeaderFileName As String

Property Value

String

The name of the generated header file.

Attributes

DispIdAttribute

Examples

See How to: Compile Example Code for Project Model Extensibility for information about how to compile and run this example.

The following example modifies the HeaderFileName property in the integrated development environment (IDE):

[Visual Basic]

' add reference to Microsoft.VisualStudio.VCProjectEngine  
Imports EnvDTE  
Imports Microsoft.VisualStudio.VCProjectEngine  

Public Module Module1  
    Sub Test()  
        Dim prj As VCProject  
        Dim cfgs, tools As IVCCollection  
        Dim cfg As VCConfiguration  
        Dim tool As VCMidlTool  
        prj = DTE.Solution.Projects.Item(1).Object  
        cfgs = prj.Configurations  
        cfg = cfgs.Item(1)  
        tool = cfg.Tools("VCMIDLTool")  
        tool.HeaderFileName = "c:\somename.h"  
    End Sub  
End Module  

Remarks

HeaderFileName exposes the functionality of the /h MIDL option.