IVsRefactorNotify.OnBeforeRemoveParams Method

Article
07/12/2014

Called when a method is about to have the parameters removed.

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

Syntax

'Declaration
Function OnBeforeRemoveParams ( _
    pHier As IVsHierarchy, _
    itemid As UInteger, _
    lpszRQName As String, _
    cParamIndexes As UInteger, _
    rgParamIndexes As UInteger(), _
    <OutAttribute> ByRef prgAdditionalCheckoutVSITEMIDs As Array _
) As Integer

int OnBeforeRemoveParams(
    IVsHierarchy pHier,
    uint itemid,
    string lpszRQName,
    uint cParamIndexes,
    uint[] rgParamIndexes,
    out Array prgAdditionalCheckoutVSITEMIDs
)

int OnBeforeRemoveParams(
    [InAttribute] IVsHierarchy^ pHier, 
    [InAttribute] unsigned int itemid, 
    [InAttribute] String^ lpszRQName, 
    [InAttribute] unsigned int cParamIndexes, 
    [InAttribute] array<unsigned int>^ rgParamIndexes, 
    [OutAttribute] Array^% prgAdditionalCheckoutVSITEMIDs
)

abstract OnBeforeRemoveParams : 
        pHier:IVsHierarchy * 
        itemid:uint32 * 
        lpszRQName:string * 
        cParamIndexes:uint32 * 
        rgParamIndexes:uint32[] * 
        prgAdditionalCheckoutVSITEMIDs:Array byref -> int

function OnBeforeRemoveParams(
    pHier : IVsHierarchy, 
    itemid : uint, 
    lpszRQName : String, 
    cParamIndexes : uint, 
    rgParamIndexes : uint[], 
    prgAdditionalCheckoutVSITEMIDs : Array
) : int

Parameters

pHier
Type: Microsoft.VisualStudio.Shell.Interop.IVsHierarchy

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

itemid
Type: System.UInt32

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

lpszRQName
Type: System.String

A method that has parameters removed.

cParamIndexes
Type: System.UInt32

The number of parameters removed.

rgParamIndexes
Type: array<System.UInt32[]

An array of parameter indexes where each value indicates the index of the parameter being removed.

prgAdditionalCheckoutVSITEMIDs
Type: System.Array%

An array of VSITEMIDs to be checked out during the remove parameter 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: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

HRESULT OnBeforeRemoveParams(
    [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

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.

Share via