ResultId Property
Id of the result aggregate stored in Aggregate .
Syntax
objsearch.getResultId(index, [callback])
Default Value
""
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 getResultId([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 setResultId([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
Id of the result aggregate stored in Aggregate.
The ResultIds will automatically be prefixed with a hash, and may be passed as is to the Get method of any class, or used as references.
The corresponding XML response aggregate is provided in the Aggregate property
The index parameter specifies the index of the item in the array. The size of the array is controlled by the ResultCount property.
This property is read-only and not available at design time.
Data Type
String