IVsRefactorNotify.OnBeforeReorderParams Method

Called when a method is about to have the 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 ( _
    pHier As IVsHierarchy, _
    itemid As UInteger, _
    lpszRQName As String, _
    cParamIndexes As UInteger, _
    rgParamIndexes As UInteger(), _
    <OutAttribute> ByRef prgAdditionalCheckoutVSITEMIDs As Array _
) As Integer
int OnBeforeReorderParams(
    IVsHierarchy pHier,
    uint itemid,
    string lpszRQName,
    uint cParamIndexes,
    uint[] rgParamIndexes,
    out Array prgAdditionalCheckoutVSITEMIDs
)
int OnBeforeReorderParams(
    [InAttribute] IVsHierarchy^ pHier, 
    [InAttribute] unsigned int itemid, 
    [InAttribute] String^ lpszRQName, 
    [InAttribute] unsigned int cParamIndexes, 
    [InAttribute] array<unsigned int>^ rgParamIndexes, 
    [OutAttribute] Array^% prgAdditionalCheckoutVSITEMIDs
)
abstract OnBeforeReorderParams : 
        pHier:IVsHierarchy * 
        itemid:uint32 * 
        lpszRQName:string * 
        cParamIndexes:uint32 * 
        rgParamIndexes:uint32[] * 
        prgAdditionalCheckoutVSITEMIDs:Array byref -> int
function OnBeforeReorderParams(
    pHier : IVsHierarchy, 
    itemid : uint, 
    lpszRQName : String, 
    cParamIndexes : uint, 
    rgParamIndexes : uint[], 
    prgAdditionalCheckoutVSITEMIDs : Array
) : int

Parameters

  • itemid
    Type: UInt32

    The VSITEMID of the designer-owned item associated with the file that the language service changed.

  • lpszRQName
    Type: String

    A method that has parameters reordered.

  • cParamIndexes
    Type: UInt32

    The number of parameters reordered.

  • rgParamIndexes
    Type: array<UInt32[]

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

  • prgAdditionalCheckoutVSITEMIDs
    Type: Array%

    An array of VSITEMIDs to be checked out during the reorder parameters operation, if the IVsRefactorNotify implementer must 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: Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

HRESULT OnBeforeReorderParams(
    [in] IVsHierarchy *pHier,
    [in] VSITEMID itemid,
    [in] LPCOLESTR lpszRQName,
    [in] ULONG cParamIndexes,
    [in, size_is(cParamIndexes)] ULONG rgParamIndexes[],
    [out, retval] SAFEARRAY(VSITEMID)* prgAdditionalCheckoutVSITEMIDs);

.NET Framework Security

See Also

Reference

IVsRefactorNotify Interface

Microsoft.VisualStudio.Shell.Interop Namespace