IContentList::get_Sorted, put_Sorted Property
For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.
The Sorted property is a read/write Boolean that determines whether the next enumeration of the ContentList object ActiveRows property will be returned in sorted order by score (highest to lowest).
HRESULT IContentList::get_Sorted(
VARIANT_BOOL* Sorted
);
HRESULT IContentList::put_Sorted(
VARIANT_BOOL Sorted
);
Property Sorted() As Boolean
Parameters
Sorted
[C++][in] When putting the property, a VARIANT_BOOL that specifies whether to return the ActiveRows property in sorted order.
[Visual Basic]
[out,retval] When getting the property, a pointer to a VARIANT_BOOL used to return the value of the Sorted property. See the Remarks section for the effects of this property.
Return Value
[C++]
These methods return an HRESULT indicating whether they completed successfully. See the Error Values section for more details.
[Visual Basic]
None.
Error Values
[C++]
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.
[Visual Basic]
This property 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
A value of True indicates that the next enumeration of the ContentList object ActiveRows property should be returned in sorted order by score (highest to lowest). A value of FALSE indicates that it will not be sorted. The items do not actually change positions in the list — that is, the ordinal identifying an item never changes. Setting the value to True only effects the next enumeration of the ActiveRows property, subsequent enumerations will be unsorted unless the property is set to True again.