IListManager::CreateEmpty

Article
06/07/2013

Ee825711.vb_on(en-US,CS.10).gif

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

Definition

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

Parameters

listName

[in] A BSTR that provides the name for the new list.

listDesc

[in] A BSTR that provides a description for the new list.

flags

[in] A long that specifies the bitmask flags that control the type of list created.

userFlags

[in] A long that contains application specific user flags. Not used by the ListManager object.

pvarID

[out, retval] A pointer to a VARIANT used to return the ID of the new list.

Return Values

This method returns an HRESULT indicating whether or not it completed successfully. See the Error Values section for more details.

Error Values

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.

The following table shows the custom COM errors that this method can return.

Constant	Value	Description
E_LM_INVALID_FLAGS	0x8C400005	Invalid flags value.
E_LM_LIST_ALREADY_EXISTS	0x8C400007	The specified list has already been created.
E_LM_SQLERROR	0x8C400003	Error while executing SQL/ADO operation.
OLE_E_BLANK	0x80040007	The ListManager object has not been properly initialized.

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.

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.