IVsProjectUpgradeViaFactory.UpgradeProject_CheckOnly Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Checks to see if a project needs to be upgraded.

public:
 int UpgradeProject_CheckOnly(System::String ^ bstrFileName, Microsoft::VisualStudio::Shell::Interop::IVsUpgradeLogger ^ pLogger, [Runtime::InteropServices::Out] int % pUpgradeRequired, [Runtime::InteropServices::Out] Guid % pguidNewProjectFactory, [Runtime::InteropServices::Out] System::UInt32 % pUpgradeProjectCapabilityFlags);

public int UpgradeProject_CheckOnly (string bstrFileName, Microsoft.VisualStudio.Shell.Interop.IVsUpgradeLogger pLogger, out int pUpgradeRequired, out Guid pguidNewProjectFactory, out uint pUpgradeProjectCapabilityFlags);

abstract member UpgradeProject_CheckOnly : string * Microsoft.VisualStudio.Shell.Interop.IVsUpgradeLogger * int * Guid * uint32 -> int

Public Function UpgradeProject_CheckOnly (bstrFileName As String, pLogger As IVsUpgradeLogger, ByRef pUpgradeRequired As Integer, ByRef pguidNewProjectFactory As Guid, ByRef pUpgradeProjectCapabilityFlags As UInteger) As Integer

Parameters

bstrFileName

String

[in] Project file of project to update.

pLogger

IVsUpgradeLogger

[in] A IVsUpgradeLogger interface to the upgrade logger.

pUpgradeRequired

Int32

[out] true if the project needs upgrading. false if the project is already up-to-date.

pguidNewProjectFactory

Guid

[out] If a different project factory is used to create the upgraded project, the GUID should be returned here.

pUpgradeProjectCapabilityFlags

UInt32

[in] Upgrade types specified by the __VSPPROJECTUPGRADEVIAFACTORYFLAGS enumeration. Only one may be specified.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

[C++]

HRESULT UpgradeProject_CheckOnly(  
    [in]  BSTR               bstrFileName,  
    [in]  IVsUpgradeLogger * pLogger,  
    [out] BOOL             * pUpgradeRequired,  
    [out] GUID             * pguidNewProjectFactory,  
    [out] VSPUVF_FLAGS     * pUpgradeProjectCapabilityFlags,  
);