IVsHierarchyRefactorNotify.OnBeforeReorderParams Method

Article
02/04/2013

Called when a method is about to have parameters reordered.

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

Syntax

'Declaration
Function OnBeforeReorderParams ( _
    itemid As UInteger, _
    lpszRQName As String, _
    cParamIndexes As UInteger, _
    rgParamIndexes As UInteger(), _
    promptContinueOnFail As Integer _
) As Integer

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

int OnBeforeReorderParams(
    [InAttribute] unsigned int itemid, 
    [InAttribute] String^ lpszRQName, 
    [InAttribute] unsigned int cParamIndexes, 
    [InAttribute] array<unsigned int>^ rgParamIndexes, 
    [InAttribute] int promptContinueOnFail
)

abstract OnBeforeReorderParams : 
        itemid:uint32 * 
        lpszRQName:string * 
        cParamIndexes:uint32 * 
        rgParamIndexes:uint32[] * 
        promptContinueOnFail:int -> int

function OnBeforeReorderParams(
    itemid : uint, 
    lpszRQName : String, 
    cParamIndexes : uint, 
    rgParamIndexes : uint[], 
    promptContinueOnFail : int
) : int

Parameters

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

lpszRQName
Type: System.String
The method that has parameters reordered.

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

rgParamIndexes
Type: array<System.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
Type: System.Int32
true to prompt the user to continue the reorder 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 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);

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.