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

Visual Studio 2015

Called when a method is about to have parameters added.

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

Syntax

C++

int OnBeforeAddParams(
	unsigned int itemid,
	String^ lpszRQName,
	unsigned int cParams,
	array<unsigned int>^ rgszParamIndexes,
	array<String^>^ rgszRQTypeNames,
	array<String^>^ rgszParamNames,
	int promptContinueOnFail
)

Parameters

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

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

cParams: Type: System::UInt32
The number of added parameters.

rgszParamIndexes: Type: array<System::UInt32>^
The indexes of added parameters.

rgszRQTypeNames: Type: array<System::String^>^
The types of added parameters.

rgszParamNames: Type: array<System::String^>^
The names of added parameters.

promptContinueOnFail: Type: System::Int32
true to prompt the user to continue the add 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 add 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 OnBeforeAddParams(
    [in] VSITEMID itemid,                              
    [in] LPCOLESTR lpszRQName,                         
    [in] ULONG cParams,                                
    [in, size_is(cParams)] ULONG rgszParamIndexes[],   
    [in, size_is(cParams)] LPCOLESTR rgszRQTypeNames[],
    [in, size_is(cParams)] LPCOLESTR rgszParamNames[], 
    [in] BOOL promptContinueOnFail);