IVsFileUpgrade::UpgradeFile Method (String^, String^, Int32, IVsUpgradeLogger^, Int32)

Visual Studio 2015

Upgrades a single file.

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

Syntax

C++

int UpgradeFile(
	String^ bstrProjectName,
	String^ bstrFileName,
	int bNoBackup,
	IVsUpgradeLogger^ pLogger,
	[OutAttribute] int% pUpgradeRequired
)

Parameters

bstrProjectName: Type: System::String^
[in] String containing the name of the project the file belongs to.

bstrFileName: Type: System::String^
[in] String containing the full path and name of the file to upgrade.

bNoBackup: Type: System::Int32
[in] Boolean. If true, no backup file is created.

pLogger: Type: Microsoft.VisualStudio.Shell.Interop::IVsUpgradeLogger^
[in] Pointer to a IVsUpgradeLogger interface to use for logging upgrade actions.

pUpgradeRequired: Type: System::Int32
[out] Boolean. Set to true if the upgrade succeeded.

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 IVsFileUpgrade::UpgradeFile(
    [in] BSTR bstrProjectName,
    [in] BSTR bstrFileName,
    [in] BOOL bNoBackup,
    [in] IVsUpgradeLogger * pLogger,
    [out] BOOL * pUpgradeRequired
);

Notes to Implementers

Not all implementations will necessarily use all of the method arguments. For example, some implementations will make no use of the project name (bstrProjectName).