IListManager::GetOperations Method [C++]

Article
11/12/2009

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

Definition

[C++]

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

[Visual Basic]

Function GetOperations() As Object

Parameters

ppRecSet[C++]
[out, retval] The address of a pointer used to return the IDispatch interface of an ADO Recordset object used to return information about the operations 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 information about the operations 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 operation in the ListManager object database. There is a record for every operation that has ever been run on lists currently in the database. When a list is deleted, all operations associated with that list are also deleted.

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

Field	Type	Description
op_id	NVARCHAR[128]	A "token" that identifies the operation and can be passed to the CancelOperation method to terminate the operation.
op_desc	NVCHAR[256]	A user-friendly operation description.
op_error_code	int	HRESULT of last failure associated with the list.
op_error_desc	NVARCHAR[1024]	Description of the last failure associated with the list.
op_list_destination	Nvarchar(256)	List destination (Export type operations only).
op_list_id	uniqueidentifier	The list ID on which this operation is taking place.
op_list_id_a	uniqueidentifier	Additional column if the operation has multiple lists involved.
op_list_id_b	uniqueidentifier	Additional column if the operation has multiple lists involved.
op_list_param1	int	Additional column which stores any extra parameters involved in the operation.
op_list_param2	int	Additional column which stores any extra parameters involved in the operation.
op_list_table	nvarchar(256)	Tablename (ExportToSql type operations only).
op_progress	int	Unused.
op_status	smallint	Status of the operation. Legal values are: 0 - complete 1 - executing -1 - failed
op_time_end	datetime	Date/time the operation completed or was aborted.
op_time_start	datetime	Date/time the operation started.
op_type	int	The type of operation. Legal values are: 1 - CreateFromFile 2 - CreateFromSQL 3 - ExportToFile 4 - ExportToSQL 5 - Copy 6 - Subtract 7 - Union 8 - CreateFromDWCalc. 9 - CreateFromSegment 10 - ExtractMailingList 11 - Other (unclassified or temporary)

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