PropertySortBy Property
Set this value to Ascending or Descending to tell SharePoint that this property will be used to sort the results that will be returned.
Syntax
spsearch.getPropertySortBy(index, [callback]) spsearch.setPropertySortBy(index, propertySortBy, [callback])
Possible Values
0 (sbNone), 1 (sbAscending), 2 (sbDescending)
Default Value
0
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getPropertySortBy([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setPropertySortBy([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
Set this value to Ascending or Descending to tell SharePoint that this property will be used to sort the results that will be returned.
Note that if multiple properties set the PropertySortBy property, the results will be sorted by the order in which the properties are listed within the Properties collection.
Possible values are:
0 (sbNone) | This property is not used in sorting (default) |
1 (sbAscending) | This property will be used to sort results in ascending order |
2 (sbDescending) | This property will be used to sort results in descending order |
The size of the array is controlled by the PropertyCount property.
This property is not available at design time.
Data Type
Integer