IVsProjectUpgradeViaFactory::UpgradeProject_CheckOnly Method (String^, IVsUpgradeLogger^, Int32, Guid, UInt32)

Visual Studio 2015

Checks to see if a project needs to be upgraded.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

C++

int UpgradeProject_CheckOnly(
	String^ bstrFileName,
	IVsUpgradeLogger^ pLogger,
	[OutAttribute] int% pUpgradeRequired,
	[OutAttribute] Guid% pguidNewProjectFactory,
	[OutAttribute] unsigned int% pUpgradeProjectCapabilityFlags
)

Parameters

bstrFileName: Type: System::String^
[in] Project file of project to update.

pLogger: Type: Microsoft.VisualStudio.Shell.Interop::IVsUpgradeLogger^
[in] A IVsUpgradeLogger interface to the upgrade logger.

pUpgradeRequired: Type: System::Int32
[out] true if the project needs upgrading. false if the project is already up-to-date.

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

pUpgradeProjectCapabilityFlags: Type: System::UInt32
[in] Upgrade types specified by the __VSPPROJECTUPGRADEVIAFACTORYFLAGS enumeration. Only one may be specified.

Return Value

Type: System::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,
);