RetrieveNamesOnly Property

Return only the names and Ids in the results.

Syntax

 objsearch.getRetrieveNamesOnly([callback])
 objsearch.setRetrieveNamesOnly( retrieveNamesOnly, [callback])

Default Value

FALSE

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 getRetrieveNamesOnly([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 setRetrieveNamesOnly([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

If RetrieveNamesOnly is True, entity searches (Customer, Employee, etc) will return only the FullName and ListID for each result. The class will silently ignore this property if it is not applicable to the search being performed. This property requires a QBXMLVersion of "4.0" or greater, and is set to False by default.

Data Type

Boolean