IVsObjectList.DoDelete Method

Asks the given list item to do the delete operation.

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

Syntax

'Declaration
Function DoDelete ( _
    index As UInteger, _
    grfFlags As UInteger _
) As Integer
int DoDelete(
    uint index,
    uint grfFlags
)
int DoDelete(
    [InAttribute] unsigned int index, 
    [InAttribute] unsigned int grfFlags
)
abstract DoDelete : 
        index:uint32 * 
        grfFlags:uint32 -> int
function DoDelete(
    index : uint, 
    grfFlags : uint
) : int

Parameters

  • index
    Type: UInt32

    [in] Specifies the index of the list item to delete.

  • grfFlags
    Type: UInt32

    [in] Values taken from the _VSOBJOPFLAGS enum.

Return Value

Type: Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsObjectList::DoDelete(
   [in] ULONG Index,
   [in] VSOBJOPFLAGS grfFlags
);

The environment calls DoDelete when the user asks to delete the item at index. This method will only be called after CanDelete has been called on the item and has returned true. On a successful deletion DoDelete should return S_OK, if the deletion failed, return the failure as an error in hr and set the rich error info to indicate the problem that was encountered.

.NET Framework Security

See Also

Reference

IVsObjectList Interface

Microsoft.VisualStudio.Shell.Interop Namespace