IVsRefactorNotify::OnBeforeAddParams Method (IVsHierarchy^, UInt32, String^, UInt32, array<UInt32>^, array<String^>^, array<String^>^, Array^)

Visual Studio 2015

Called when a method is about to have the 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(
	IVsHierarchy^ pHier,
	unsigned int itemid,
	String^ lpszRQName,
	unsigned int cParams,
	array<unsigned int>^ rgszParamIndexes,
	array<String^>^ rgszRQTypeNames,
	array<String^>^ rgszParamNames,
	[OutAttribute] Array^% prgAdditionalCheckoutVSITEMIDs
)

Parameters

pHier: Type: Microsoft.VisualStudio.Shell.Interop::IVsHierarchy^
A hierarchy of the designer-owned item associated with the file that the language service changed.

itemid: Type: System::UInt32
The VSITEMID of the designer-owned item associated with the file that the language service is about to change.

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

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

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

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

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

prgAdditionalCheckoutVSITEMIDs: Type: System::Array^
An array of VSITEMIDs to be checked out during the add parameter operation, if the IVsRefactorNotify implementer needs to modify additional files as a part of the refactoring operation. Implementers must return the VSITEMID of the designer-owned item, if that file is modified during the refactoring operation.

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 OnBeforeAddParams(
    [in] IVsHierarchy *pHier,
    [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[],
    [out, retval] SAFEARRAY(VSITEMID)* prgAdditionalCheckoutVSITEMIDs);