IVsHierarchyRefactorNotify.OnBeforeReorderParams Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

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 reordered.

public:
 int OnBeforeReorderParams(System::UInt32 itemid, System::String ^ lpszRQName, System::UInt32 cParamIndexes, cli::array <System::UInt32> ^ rgParamIndexes, int promptContinueOnFail);

public:
 int OnBeforeReorderParams(unsigned int itemid, Platform::String ^ lpszRQName, unsigned int cParamIndexes, Platform::Array <unsigned int> ^ rgParamIndexes, int promptContinueOnFail);

int OnBeforeReorderParams(unsigned int itemid, std::wstring const & lpszRQName, unsigned int cParamIndexes, std::Array <unsigned int> const & rgParamIndexes, int promptContinueOnFail);

public int OnBeforeReorderParams (uint itemid, string lpszRQName, uint cParamIndexes, uint[] rgParamIndexes, int promptContinueOnFail);

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

Public Function OnBeforeReorderParams (itemid As UInteger, lpszRQName As String, cParamIndexes As UInteger, rgParamIndexes As UInteger(), promptContinueOnFail As Integer) As Integer

Parameters

itemid: UInt32

The VSITEMID that identifies the affected file.

lpszRQName: String

The method that has parameters reordered.

cParamIndexes: UInt32

The number of parameters reordered.

rgParamIndexes: UInt32[]

An array of parameter indexes. The index defines the position of the parameter after reordering. The value at the index defines the position of the parameter before reordering.

promptContinueOnFail: Int32

true to prompt the user to continue the reorder 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 reorder 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 OnBeforeReorderParams(  
    [in] VSITEMID itemid,                                 
    [in] LPCOLESTR lpszRQName,                            
    [in] ULONG cParamIndexes,                             
    [in, size_is(cParamIndexes)] ULONG rgParamIndexes[],  
    [in] BOOL promptContinueOnFail);

Applies to