IListManager::CreateFromSegment Method [C++]

Article
11/12/2009

Use this method to create a list from a Predictor resource segment.

Definition

[C++]

HRESULT IListManager::CreateFromSegment(BSTRlistName,
  BSTRlistDesc,
  longlFlags,
  longuserFlags,
  BSTRmodelName,
  BSTRsegmentName,
  BSTRpredHostName,
  BSTRDWConnStr,
  doublefpMinProbability,
  BOOL bAsync,
  VARIANT*pvarOpID,
  VARIANT*pvarID);

[Visual Basic]

Function CreateFromSegment(listName As String,
  listDesc As String,
  lFlags As Long,
  userFlags As Long,
  modelName As String,
  segmentName As String,
  predHostName As String,
  DWConnStr As String,
  fpMinProbability As Double,
  bAsync As Boolean,
  Optional pvarOpID As Variant) As Variant

Parameters

listName[C++]
[in] A BSTR that provides the name for the list.
listName[Visual Basic]
A String that contains provides the name for the list.
listDesc[C++]
[in] A BSTR that contains the list description.
listDesc[Visual Basic]
A String that contains the list description.
lFlags[C++]
[in] A long that specifies the bitmask flags that control the type of list created.
lFlags[Visual Basic]
A Long that specifies the bitmask flags that control the type of list created.
userFlags[C++]
[in] A long that contains application specific user flags. Not used by the ListManager object.
userFlags[Visual Basic]
A Long that contains application specific user flags. Not used by the ListManager object.
modelName[C++]
[in] A BSTR that contains the name of the Predictor segment model to use.
modelName[Visual Basic]
A String that contains the name of the Predictor segment model to use.
segmentName[C++]
[in] A BSTR that contains the name of the segment to import.
segmentName[Visual Basic]
A String that contains the name of the segment to import.
predHostName[C++]
[in] A BSTR that contains the name of the Predictor host server.
predHostName[Visual Basic]
A String that contains the name of the Predictor host server.
DWConnStr[C++]
[in] A BSTR that contains the Data Warehouse connection string.
DWConnStr[Visual Basic]
A String that contains the Data Warehouse connection string.
fpMinProbability[C++]
[in] A double that contains the minimum probability associated with a given segment member for that member to be included in the list.
fpMinProbability[Visual Basic]
A Double that contains the minimum probability associated with a given segment member for that member to be included in the list.
bAsync[C++]
[in] A BOOL that specifies whether the creation operation is performed synchronously or asynchronously. A value of True indicates asynchronous processing.
bAsync[Visual Basic]
A Boolean that specifies whether the creation operation is performed synchronously or asynchronously. A value of True indicates asynchronous processing.
pvarOpID[C++]
[out, optional] A pointer to a VARIANT used to return an Operation ID.
pvarOpID[Visual Basic]
An optional Variant used to return an Operation ID.
pvarID[C++]
[out, retval] A pointer to a VARIANT used to return the new list ID.

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 a Variant used to return the new list ID.

Error Values

[C++] 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.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to either standard or custom COM 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_CONNECTIONFAILED	[C++] 0x8C400001 [Visual Basic] &H8C400001	Failed to establish database connection.
E_LM_CREATE_OBJECT	[C++] 0x8C400017 [Visual Basic] &H8C400017	Unable to create the object.
E_LM_INVALID_FLAGS	[C++] 0x8C400005 [Visual Basic] &H8C400005	Invalid flags value.
E_LM_LIST_ALREADY_EXISTS	[C++] 0x8C400007 [Visual Basic] &H8C400007	The specified list has already been created.
E_LM_MAILABLE_LIST_NO_EMAILS	[C++] 0x8C40000D [Visual Basic] &H8C40000D	The list is designated as a Mailable list but does not contain an rcp_email column.
E_LM_OPER_CANCELED	[C++] 0x8C40000B [Visual Basic] &H8C40000B	The operation was canceled.
E_LM_SQLERROR	[C++] 0x8C400003 [Visual Basic] &H8C400003	Error while executing SQL/ADO operation.
E_LM_USER_LIST_NO_GUIDS	[C++] 0x8C40000E [Visual Basic] &H8C40000E	The list is designated as a User list but does not contain an rcp_guid column.
OLE_E_BLANK	[C++] 0x80040007 [Visual Basic] &H80040007	The ListManager object has not been properly initialized.

[C++] 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] 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 calls into the PredictorServiceSiteAdmin object, passing it the modelName, segmentName, and fpMinProbability parameters along with a connection string to the database used by the ListManager object, and the table name that it should create.

For a list of possible values for the lflags parameter, see the GetListFlags method.

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