VCProject Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.VCProjectEngine

Assembly:: Microsoft.VisualStudio.VCProjectEngine.dll

Package:: Microsoft.VisualStudio.VCProjectEngine v17.11.40252

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This object exposes the properties on a Visual C++ project.

public interface class VCProject : Microsoft::VisualStudio::VCProjectEngine::VCProjectItem

public interface class VCProject : Microsoft::VisualStudio::VCProjectEngine::VCProjectItem

__interface VCProject : Microsoft::VisualStudio::VCProjectEngine::VCProjectItem

[System.Runtime.InteropServices.Guid("DBF177F2-06DB-4A47-8AAD-C8E12BFD6C86")]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)]
public interface VCProject : Microsoft.VisualStudio.VCProjectEngine.VCProjectItem

[<System.Runtime.InteropServices.Guid("DBF177F2-06DB-4A47-8AAD-C8E12BFD6C86")>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)>]
type VCProject = interface
    interface VCProjectItem

Public Interface VCProject
Implements VCProjectItem

Attributes: GuidAttribute TypeLibTypeAttribute

Implements: VCProjectItem

Examples

' Add a reference to Microsoft.VisualStudio.VCProjectEngine and have a   
' Visual C++ project loaded before running this example.  
Imports EnvDTE  
Imports Microsoft.VisualStudio.VCProjectEngine  
Public Module Module1  
    Sub Test()  
        Dim prj As VCProject  
        Dim vcar As VCAssemblyReference  
        Dim refcfg As VCReferenceConfiguration  

        prj = DTE.Solution.Projects.Item(1).Object  
        If prj.CanAddAssemblyReference("C:\Program Files\ _  
        Microsoft Visual Studio 8\Common7\IDE\ _  
        PublicAssemblies\envdte.dll") Then  
           vcar = prj.AddAssemblyReference("C:\Program Files\ _  
           Microsoft Visual Studio 8\Common7\IDE\ _  
           PublicAssemblies\envdte.dll")  
        End If  
        refcfg = vcar.ReferenceConfigurations.Item(1)  
        MsgBox("Consumable? " & refcfg.ConsumableByDesigner)  
    End Sub  
End Module

Properties

ActiveConfiguration
AssemblyReferenceSearchPaths	Sets or gets a list of assembly search paths.
Capabilities
Configurations	Gets the collection of configurations on the project.
FileEncoding	Microsoft Internal Use Only.
FileFormat	Microsoft Internal Use Only.
Files	Gets the collection of files on the object.
Filters	Gets the collection of filters (or folders) on the object.
GetAllowedReferencesTypes
IsDirty	Microsoft Internal Use Only.
ItemName	Gets the name of the current item in the collection.
Items	Gets the collection of files and top-level folders in a project or the collection of files and folders in a folder.
keyword	Gets or sets the collection of Dynamic Help keywords associated with a project.
Kind	Gets an enumeration indicating the type of object.
LatestTargetPlatformVersion
ManagedDBConnection	Microsoft Internal Use Only.
ManagedDBProvider	Microsoft Internal Use Only.
Name	Gets or set the name of the object.
Object	Provides a reference between the Visual Studio object model and the Visual C++ object model.
OwnerKey	Microsoft Internal Use Only.
Parent	Gets the immediate parent object.
Platforms	Gets the platforms for which this project can be built. For Visual C++, this is only Win32.
project	Gets the VCProject associated with the object.
ProjectDirectory	Gets the name of the directory that contains the project file.
ProjectFile	Gets the name of the project file.
ProjectGUID	Microsoft Internal Use Only.
References	Gets the collection of references for the selected project.
ReferencesConsumableByDesigners	Gets the collection of references that are consumable by designers in the active solution configuration.
RootNamespace	Gets the root namespace for the specified project.
SccAuxPath	Microsoft Internal Use Only.
SccLocalPath	Microsoft Internal Use Only.
SccProjectName	Microsoft Internal Use Only.
SccProvider	Microsoft Internal Use Only.
ShowAllFiles	Sets or gets whether to show all files in the solution explorer.
SupportedPlatformNames
TargetFrameworkMoniker	Gets the name of the target framework.
TargetFrameworkVersion	Gets or sets the version of the .NET Framework that is targeted by the project.
ToolFiles	Gets a collection of custom build rule files.
VCProjectEngine	Gets a pointer to the project engine.
VCReferences	Gets the collection of references for the selected project.

Methods

AddActiveXReference(String, Int32, Int32, Int32, String)	Adds an ActiveX (COM) reference to the project.
AddAssemblyReference(String)	Adds an assembly (.NET) reference to the selected project.
AddConfiguration(String)	Adds a configuration to the current project.
AddFile(String)	Adds a file to the current project or folder.
AddFilter(String)	Adds a folder to the current project or folder.
AddPlatform(String)	Adds a platform to the current project (not enabled for Visual C++).
AddProjectReference(Object)	Adds a project reference to the project.
AddRuleDefinition(String, String, Boolean)	Adds a rule to the project so that it is available as an IVCRulePropertyStorage.
AddSdkReference(String)
AddToolFile(VCToolFile)	Adds a custom build rule file to a project.
AddWebReference(String, String)	Adds a reference to a Web Service to the project.
AddWinRTReference(String)
CanAddActiveXReference(String, Int32, Int32, Int32, String)	Gets a value indicating whether to add the given ActiveX (COM) reference.
CanAddAssemblyReference(String)	Returns whether it is okay to add the given assembly (.NET) reference.
CanAddFile(String)	Returns `true` if the specified file can be added to the current project or filter.
CanAddFilter(String)	Returns `true` if the specified filter can be added as a top-level filter or as a subfilter to the current filter.
CanAddProjectReference(Object)	Returns whether it is okay to add the given project reference
CanAddSdkReference(String)
CanAddWinRTReference(String)
ContainsFileEndingWith(String)	Indicates whether there is a file name that ends with a specified string.
ContainsFileWithItemType(String)	Indicates whether there is a file whose type matches a specified type.
FindFile(String)
GetFilesEndingWith(String)	Retrieves a collection of file names whose trailing characters match a specified string.
GetFilesWithItemType(String)	Retrieves a collection of file names whose whose type matches a specified type.
GetVCService(Guid)
IncludeHeaderFile(String, String)	Adds a `#include HeaderFile` directive to a pre-compiled header file, or to a specified file.
IsCapabilityPresent(String)
LoadProjectOptions(Object)	Microsoft Internal Use Only.
LoadUserFile()	Loads the user option file.
MakeManagedDBConnection(Boolean)	Microsoft Internal Use Only.
MatchName(String, Boolean)	Matches a specified name to the name of a collection item.
RemoveConfiguration(Object)	Removes a configuration from the current project.
RemoveFile(Object)	Removes a file from the current project or folder.
RemoveFilter(Object)	Removes a folder from the current project and any files or other folders in the folder.
RemovePlatform(Object)	Removes a platform from the current project (not enabled for Visual C++).
RemoveReference(Object)	Removes the specified reference from the project or references collection.
RemoveRuleDefinition(String)	Removes a Rule definition from the project.
RemoveToolFile(VCToolFile)	Removes a custom build rules file from the project.
Save()	Saves the project file (.vcxproj).
SaveProjectOptions(Object)	Microsoft Internal Use Only.
SaveUserFile()	Saves the user option file.
Version(Int32, Int32)	Sets or returns the major and minor version numbers of the project.

Applies to

Share via