IPredictorServiceSiteAdmin::get_SegmentLabels, put_SegmentLabels
.gif "Ee796692.c++_off(en-US,CS.10).gif")
.gif "Ee796692.vb_on(en-US,CS.10).gif")
The SegmentLabels property is a read/write Variant that contains the labels for a given segment model.
Definition
Get method:
HRESULT IPredictorServiceSiteAdmin::get_SegmentLabels(BSTRsModelName,longlDepth,VARIANT*pvarsaLabels);
Put method:
HRESULT IPredictorServiceSiteAdmin::put_SegmentLabels(BSTRsModelName,longlDepth,VARIANTpvarsaLabels);
Parameters
sModelName
[in] A BSTR that contains the name of the segment model.
lDepth
[in] A long that specifies the depth in the segment hierarchy from which labels are assigned or retrieved.
pvarsaLabels
[in] When putting the property, a VARIANT that contains the segment labels.
[out, retval] When getting the property, a pointer to a VARIANT used to return the segment labels.
Return Values
These methods return an HRESULT indicating whether or not they completed successfully. See the following Error Values section for more details.
Error Values
These methods return 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.
Remarks
A segment model classifies groups of users into segments of users with similar user properties. Similar segments are grouped into higher order collections of segments, creating a hierarchy. When the segments are first generated they are generically labeled (for example, Segment4 or Group2). Rename the labels to better identify the different groups.
Valid values for the lDepth parameter are -1 (returns all segments) and 2 or greater.
Connect to the Data Warehouse using the Init method before accessing this property.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
The pvarsaLabels parameter contains valid data only if the property is accessed successfully.