IPredictorServiceSiteAdmin2::GenerateList Method [C++]

Article
11/12/2009

Use this method to generate a list of the members of a segment or a list of predictions.

Definition

[C++]

HRESULT IPredictorServiceSiteAdmin2::GenerateList(
  long lOpType,   IDictionary* spdictProps);

[Visual Basic]

Sub GenerateList(lOpType As Long,
  spdictProps As Object,
)

Parameters

lOpType[C++]
[in] A long that specifies the type of list to generate. See the Remarks section for allowed values.
lOpType[Visual Basic]
A Long that specifies the type of list to generate. See the Remarks section for allowed values.
spdictProps[C++]
[in] A pointer to a Dictionary object that contains the properties of the list to be generated. See the Remarks section for details.
spdictProps[Visual Basic]
A Dictionary object that contains the properties of the list to be generated. See the Remarks section for details.

Return Values

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

[Visual Basic] None.

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

The following table shows the names and definitions of the allowed values for the lOptype parameter.

Name	Value	Definition
ExportSegmentToList	1	Export a segment to a list.
ExportProductToList	0	Export products to a list.

The following table shows the keys for the spdispProps dictionary parameter.

Key	Type of Operation	Definition
LMConn	Both	The connection string to the ListManager database.
ModelName	Both	The name of source model.
MinProbability	Both	The minimum level of confidence in a user belonging to the list
TableName	ExportSegmentToList	The name of the source table.
SegmentName	ExportSegmentToList	The name of the source segment.
ListName	ExportProductToList	The name of the list to be created.
SKU	ExportProductToList	The name of the PivotColumn in the model, for example, “SKU.”
Value	ExportProductToList	The name of the AggregateColumn in the model, for example, “QTY.”
Product	ExportProductToList	The identifier of the product. This should be identical to the identifier that appears in the column specified by the SKU key.
Predictions	ExportProductToList	The limit on the number of predictions. Limiting predictions will improve performance.

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