IVsHierarchyRefactorNotify.OnBeforeAddParams 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.11.40262

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.

Called when a method is about to have parameters added.

public:
 int OnBeforeAddParams(System::UInt32 itemid, System::String ^ lpszRQName, System::UInt32 cParams, cli::array <System::UInt32> ^ rgszParamIndexes, cli::array <System::String ^> ^ rgszRQTypeNames, cli::array <System::String ^> ^ rgszParamNames, int promptContinueOnFail);

public:
 int OnBeforeAddParams(unsigned int itemid, Platform::String ^ lpszRQName, unsigned int cParams, Platform::Array <unsigned int> ^ rgszParamIndexes, Platform::Array <Platform::String ^> ^ rgszRQTypeNames, Platform::Array <Platform::String ^> ^ rgszParamNames, int promptContinueOnFail);

int OnBeforeAddParams(unsigned int itemid, std::wstring const & lpszRQName, unsigned int cParams, std::Array <unsigned int> const & rgszParamIndexes, std::Array <std::wstring const &> const & rgszRQTypeNames, std::Array <std::wstring const &> const & rgszParamNames, int promptContinueOnFail);

public int OnBeforeAddParams (uint itemid, string lpszRQName, uint cParams, uint[] rgszParamIndexes, string[] rgszRQTypeNames, string[] rgszParamNames, int promptContinueOnFail);

abstract member OnBeforeAddParams : uint32 * string * uint32 * uint32[] * string[] * string[] * int -> int

Public Function OnBeforeAddParams (itemid As UInteger, lpszRQName As String, cParams As UInteger, rgszParamIndexes As UInteger(), rgszRQTypeNames As String(), rgszParamNames As String(), promptContinueOnFail As Integer) As Integer

Parameters

itemid: UInt32

The VSITEMID that identifies the affected file.

lpszRQName: String

The method that has parameters added.

cParams: UInt32

The number of added parameters.

rgszParamIndexes: UInt32[]

The indexes of added parameters.

rgszRQTypeNames: String[]

The types of added parameters.

rgszParamNames: String[]

The names of added parameters.

promptContinueOnFail: Int32

true to prompt the user to continue the add operation if one or more IVsRefactorNotify implementers fails; otherwise, false.

Returns

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:

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

Applies to

Share via