IVsFileUpgrade.UpgradeFile_CheckOnly Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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.

Checks if a file requires upgrading but does not perform the upgrade.

public:
 int UpgradeFile_CheckOnly(System::String ^ bstrProjectName, System::String ^ bstrFileName, int bNoBackup, Microsoft::VisualStudio::Shell::Interop::IVsUpgradeLogger ^ pLogger, [Runtime::InteropServices::Out] int % pUpgradeRequired);

int UpgradeFile_CheckOnly(std::wstring const & bstrProjectName, std::wstring const & bstrFileName, int bNoBackup, Microsoft::VisualStudio::Shell::Interop::IVsUpgradeLogger const & pLogger, [Runtime::InteropServices::Out] int & pUpgradeRequired);

public int UpgradeFile_CheckOnly (string bstrProjectName, string bstrFileName, int bNoBackup, Microsoft.VisualStudio.Shell.Interop.IVsUpgradeLogger pLogger, out int pUpgradeRequired);

abstract member UpgradeFile_CheckOnly : string * string * int * Microsoft.VisualStudio.Shell.Interop.IVsUpgradeLogger * int -> int

Public Function UpgradeFile_CheckOnly (bstrProjectName As String, bstrFileName As String, bNoBackup As Integer, pLogger As IVsUpgradeLogger, ByRef pUpgradeRequired As Integer) As Integer

Parameters

bstrProjectName: String

[in] String containing the name of the project the file belongs to.

bstrFileName: String

[in] String containing the full path and name of the file proposed for upgrade.

bNoBackup: Int32

[in] Boolean. If true, no backup file would be created.

pLogger: IVsUpgradeLogger

[in] Pointer to a IVsUpgradeLogger interface to use for logging upgrade actions.

pUpgradeRequired: Int32

[out] Boolean. Set to true if the file requires upgrading.

Returns

Int32

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

Remarks

COM Signature

From vsshell80.idl:

HRESULT IVsFileUpgrade::UpgradeFile_CheckOnly()  
    [in] BSTR bstrProjectName,  
    [in] BSTR bstrFileName,  
    [in] BOOL bNoBackup,  
    [in] IVsUpgradeLogger * pLogger,  
    [out] BOOL * pUpgradeRequired  
);

Applies to

Partilhar via