IVsProjectUpgradeViaFactory.UpgradeProject_CheckOnly Method

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

'Declaration
Function UpgradeProject_CheckOnly ( _
    bstrFileName As String, _
    pLogger As IVsUpgradeLogger, _
    <OutAttribute> ByRef pUpgradeRequired As Integer, _
    <OutAttribute> ByRef pguidNewProjectFactory As Guid, _
    <OutAttribute> ByRef pUpgradeProjectCapabilityFlags As UInteger _
) As Integer

'Usage
Dim instance As IVsProjectUpgradeViaFactory 
Dim bstrFileName As String 
Dim pLogger As IVsUpgradeLogger 
Dim pUpgradeRequired As Integer 
Dim pguidNewProjectFactory As Guid 
Dim pUpgradeProjectCapabilityFlags As UInteger 
Dim returnValue As Integer 

returnValue = instance.UpgradeProject_CheckOnly(bstrFileName, _
    pLogger, pUpgradeRequired, pguidNewProjectFactory, _
    pUpgradeProjectCapabilityFlags)

int UpgradeProject_CheckOnly(
    string bstrFileName,
    IVsUpgradeLogger pLogger,
    out int pUpgradeRequired,
    out Guid pguidNewProjectFactory,
    out uint pUpgradeProjectCapabilityFlags
)

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

function UpgradeProject_CheckOnly(
    bstrFileName : String, 
    pLogger : IVsUpgradeLogger, 
    pUpgradeRequired : int, 
    pguidNewProjectFactory : Guid, 
    pUpgradeProjectCapabilityFlags : uint
) : int

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,
);

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.