IVsRefactorNotify.OnBeforeReorderParams 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 the parameters reordered.

public:
 int OnBeforeReorderParams(Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ pHier, System::UInt32 itemid, System::String ^ lpszRQName, System::UInt32 cParamIndexes, cli::array <System::UInt32> ^ rgParamIndexes, [Runtime::InteropServices::Out] Array ^ % prgAdditionalCheckoutVSITEMIDs);

public int OnBeforeReorderParams (Microsoft.VisualStudio.Shell.Interop.IVsHierarchy pHier, uint itemid, string lpszRQName, uint cParamIndexes, uint[] rgParamIndexes, out Array prgAdditionalCheckoutVSITEMIDs);

abstract member OnBeforeReorderParams : Microsoft.VisualStudio.Shell.Interop.IVsHierarchy * uint32 * string * uint32 * uint32[] * Array -> int

Public Function OnBeforeReorderParams (pHier As IVsHierarchy, itemid As UInteger, lpszRQName As String, cParamIndexes As UInteger, rgParamIndexes As UInteger(), ByRef prgAdditionalCheckoutVSITEMIDs As Array) As Integer

Parameters

pHier: IVsHierarchy

A hierarchy of the designer-owned item associated with the file that the language service changed.

itemid: UInt32

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

lpszRQName: String

A method that has parameters reordered.

cParamIndexes: UInt32

The number of parameters reordered.

rgParamIndexes: 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: 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.

Returns

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

Applies to

Share via