retrieve_objects_to_callback

The following is a list of properties for the function retrieve_objects_to_callback:

Property	Value
`brief`	Retrieve adaptive objects
`category`	adaptor
`description`	This function retrieves adaptive objects from an adaptor, specified by adaptorId, which match the type specified by objectType. Each object is passed to the callback as it's retrieved. The optional queryCriteria is used to filter the adaptive objects returned. Use the objectOptions parameter to influence how the objects are viewed. Options, specific to the adaptorId, can be optionally supplied.
`functionId`	retrieve_objects_to_callback
`functionLabel`	retrieve_objects_to_callback
`parameters`	[ { "brief": "Object Callback", "dataType": "function", "dataTypeParameter": "(object: object, userData: any): boolean", "description": "If this is specified, this function is called once for each object retrieved instead of adding the object to the return list. Parameter object will be an object retrieved or undefined if there are no more objects. This function should return true if it wants to abort the retrieve request.", "name": "objectCallback" }, { "brief": "User data", "canBeUndefined": true, "description": "This value is passed to the objectCallback function in the userData parameter.", "name": "userData" }, { "brief": "Id of adaptor", "dataType": "string", "description": "Id of adaptor containing objects to retrieve.", "name": "adaptorId" }, { "brief": "Id of object type", "dataType": "string", "description": "Id of adaptive object type of objects to retrieve.", "name": "objectType" }, { "brief": "Query criteria", "dataType": "object", "dataTypeParameter": "_AdaptiveQueryCriteria_", "description": "This is the query criteria for objects to be retrieved. If not specified, all objects will be retrieved.", "name": "queryCriteria", "optional": true }, { "brief": "Object options", "dataType": "object", "dataTypeParameter": "_AdaptiveObjectOptions_", "description": "Object view options. See /afw/_AdaptiveObjectType_/_AdaptiveObjectOptions_ for more information.", "name": "options", "optional": true }, { "brief": "Adaptor specific", "dataType": "object", "description": "This is an optional object parameter with an objectType determined by the adaptorType associated with the adaptorId parameter. If the adaptorType supports this parameter, adaptor afw will have an adaptive object type with an id of:\n\n_AdaptiveAdaptorTypeSpecific_${adaptorType}_retrieve_objects_to_callback\n\nWhere ${adaptorType} is the adaptor type id.", "name": "adaptorTypeSpecific", "optional": true } ]
`returns`	{ "dataType": "null" }