IVsHierarchyRefactorNotify::OnBeforeRemoveParams Method (UInt32, String^, UInt32, array<UInt32>^, Int32)

Visual Studio 2015

Called when a method is about to have parameters removed.

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

Syntax

C++

int OnBeforeRemoveParams(
	unsigned int itemid,
	String^ lpszRQName,
	unsigned int cParamIndexes,
	array<unsigned int>^ rgParamIndexes,
	int promptContinueOnFail
)

Parameters

itemid: Type: System::UInt32
The VSITEMID that identifies the affected file.

lpszRQName: Type: System::String^
The method that has parameters removed.

cParamIndexes: Type: System::UInt32
The number of parameters removed.

rgParamIndexes: Type: array<System::UInt32>^
The indexes of removed parameters.

promptContinueOnFail: Type: System::Int32
true to prompt the user to continue the remove operation if one or more IVsRefactorNotify implementers fails; otherwise, false.

Return Value

Type: System::Int32

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

Remarks

To stop the remove operation, the HRESULT must contain one of the following error codes:

E_ABORT

OLE_E_PROMPTSAVECANCELLED

OLECMDERR_E_CANCELED

HR_E_CSHARP_USER_CANCEL

COM Signature

From vsshell80.idl:

C++

HRESULT OnBeforeRemoveParams(
    [in] VSITEMID itemid,                               
    [in] LPCOLESTR lpszRQName,                          
    [in] ULONG cParamIndexes,                           
    [in, size_is(cParamIndexes)] ULONG rgParamIndexes[],
    [in] BOOL promptContinueOnFail);