IListManager::CreateEmpty Method [C++]

Article
11/12/2009

Use this method to create an empty list for subsequent operations.

Definition

[C++]

HRESULT IListManager::CreateEmpty(BSTRlistName,
 BSTRlistDesc,
 longflags,
 longuserFlags,
 VARIANT*pvarID);

[Visual Basic]

Function CreateEmpty(listName As String,
 listDesc As String,
 flags As Long,
 userFlags As Long) As Variant

Parameters

listName[C++]
[in] A BSTR that provides the name for the new list.
listName[Visual Basic]
A String that provides the name for the new list.
listDesc[C++]
[in] A BSTR that provides a description for the new list.
listDesc[Visual Basic]
A String that provides a description for the new list.
flags[C++]
[in] A long that specifies the bitmask flags that control the type of list created.
flags[Visual Basic]
A Long that specifies the bitmask flags that control the type of list created.
userFlags[C++]
[in] A long that contains application specific user flags. Not used by the ListManager object.
userFlags[Visual Basic]
A Long that contains application specific user flags. Not used by the ListManager object.
pvarID[C++]
[out, retval] A pointer to a VARIANT used to return the ID of the new list.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] If this method completes successfully, it returns a Variant that contains the ID of the new list.

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	Value	Description
E_LM_INVALID_FLAGS	[C++] 0x8C400005 [Visual Basic] &H8C400005	Invalid flags value.
E_LM_LIST_ALREADY_EXISTS	[C++] 0x8C400007 [Visual Basic] &H8C400007	The specified list has already been created.
E_LM_SQLERROR	[C++] 0x8C400003 [Visual Basic] &H8C400003	Error while executing SQL/ADO operation.
OLE_E_BLANK	[C++] 0x80040007 [Visual Basic] &H80040007	The ListManager object has not been properly initialized.

[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

This method is useful for creating an empty list for use as the result list of a copy, subtract, or union operation.

For a list of possible values for the flags parameter, see the GetListFlags method.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

[Visual Basic]

Example

' vListID is a Variant
vListID = oListManager.CreateEmpty("TequillaBuyers1", _
 "Tequilla buyers in January", 20, 0)

Share via