IVsObjectList.DoDelete(UInt32, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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.

Asks the given list item to do the delete operation.

public:
 int DoDelete(System::UInt32 index, System::UInt32 grfFlags);

public:
 int DoDelete(unsigned int index, unsigned int grfFlags);

int DoDelete(unsigned int index, unsigned int grfFlags);

public int DoDelete (uint index, uint grfFlags);

abstract member DoDelete : uint32 * uint32 -> int

Public Function DoDelete (index As UInteger, grfFlags As UInteger) As Integer

Parameters

index: UInt32

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

grfFlags: UInt32

[in] Values taken from the _VSOBJOPFLAGS enum.

Returns

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.

Applies to

Partilhar via