IListManager::GetLists Method [C++]

Article
11/12/2009

Use this method to enumerate all lists known to the ListManager object.

Definition

[C++]

HRESULT IListManager::GetLists(IDispatch**ppRecSet);

[Visual Basic]

Function GetLists() As Object

Parameters

ppRecSet[C++]
[out, retval] The address of a pointer to the IDispatch interface of an ADO Recordset object used to return the details of the lists known to this instance of the ListManager object.

[Visual Basic] None.

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 an ADO Recordset object that contains the details of the lists known to this instance of the ListManager object.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. 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] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. 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 returns an instance of a read-only ADO Recordset object that contains a record for each list in the ListManager object database. The Recordset object does not contain any lists that are not completely created at the time this method is invoked.

If there are not any lists completely created at the time this method is invoked, the method returns successfully, but the Recordset object is empty.

The following table describes the fields returned in the Recordset object.

Field	Type	Description
list_id	uniqueidentifier	Identification number of the list.
list_name	NVARCHAR [64]	Name of the list.
list_created	datetime	Date/time the list record was created.
list_creation_type	smallint	Method used to create the list. Legal values are: 1 - CreateFromFile 2 - CreateFromSQL 3 - CreateFromDWCalc 4 - CreateFromSegment 5 - Other (subtraction, union, extraction, etc.)
list_description	NVARCHAR [256]	List description.
list_err_limit	long	The error threshold for the list.
list_flags	int	Bit flags for the list. Can bitwise OR together to specify more than one flag. Legal values are: 0x0 - DEFAULT 0x1 - HIDDEN 0x2 - DYNAMIC 0x4 - USER 0x8 - GENERIC 0x10 - MAILABLE
list_location	NVARCHAR [256]	Location (table name) where the list data is stored.
list_query	NVARCHAR [1024]	Query used to create the list.
list_recent_operid	NVARCHAR [128]	ID of the most recent list operation. May be Null if the list is a new list created by the CreateEmpty method.
list_size	int	Number of rows in the list (-1 for dynamic lists).
list_source	NVARCHAR [512]	Name of the file, connection string, or filename used to create the list.
list_status	int	Status of the list. Legal values are: 1 - ready for processing 2 - being processed; other operations are not permitted 3 - failed
list_unique_emails	int	Number of unique rcp_email values in the list (-1 for dynamic lists).
list_unique_guids	int	Number of unique rcp_guid values in the list (-1 for dynamic lists).
list_userflags	int	Application specific. Not used by the ListManager object.

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