ListManager.GetOperations Method (PIA)

Article
11/12/2009

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

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Targeting
…
Public Function GetOperations() As Object

[C#]

using Microsoft.CommerceServer.Interop.Targeting;
using ADODB26Lib;                              //For Recordset
…
public object GetOperations();

Return Values

[Visual Basic .NET] If this method completes successfully, it returns a Recordset object that contains information about the operations known to this instance of the ListManager object.

[C#] This method returns an object (typically an ADODB26Lib.Recordset) used to return information about the operations known to this instance of the ListManager object.

Exceptions

This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

Remarks

[Visual Basic .NET]

This method returns an instance of a read-only 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 that stores any extra parameters involved in the operation.
op_list_param2	int	Additional column that stores any extra parameters involved in the operation.
op_list_table	NVARCHAR(256)	Table name (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)

[C#]

This method returns an instance of a read-only ADODB26Lib.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 that stores any extra parameters involved in the operation.
op_list_param2	Int	Additional column that stores any extra parameters involved in the operation.
op_list_table	NVARCHAR(256)	Table name (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)

Requirements

Namespace: Microsoft.CommerceServer.Interop.Targeting

Platforms: Windows 2000, Windows Server 2003

Assembly: listmanagerlib (in listmanagerlib.dll)