ISimpleList::Delete Method [C++]
Use this method to delete the specified item from the SimpleList object.
Definition
[C++]
HRESULT ISimpleList::Delete(longIndex);
[Visual Basic]
Sub Delete(Index As Long)
Parameters
- Index[C++]
[in] A long that contains the index value of the item to delete. - Index[Visual Basic]
A Long that contains the index value of the item to delete.
Return Values
[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.
[Visual Basic] None.
Error Values
[C++] This method returns S_OK (0x00000000) to indicate success and either standard or custom COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.
[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to either standard or custom COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.
The following table shows the custom COM errors that this method can return.
| Constant | Description |
|---|---|
| DISP_E_BADINDEX | The Index parameter references an out-of-range value. This means that Index contains a value either larger than the SimpleList or less than zero. |
[C++] Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.
[Visual Basic] Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.
Remarks
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
[Visual Basic]
Example
' The following example deletes the SimpleList item at index 1008
' oSimpleList is a Commerce SimpleList object
oSimpleList.Delete(1008)
See Also
[C++]SimpleList Object
[C++]ISimpleList::Add
[Visual Basic]SimpleList Object
[Visual Basic]SimpleList.Add
[Visual Basic]SimpleList.Count
Copyright © 2005 Microsoft Corporation.
All rights reserved.