GetPropertyValuesAsync Method
Asynchronously retrieves property values for a list of Entities and Property Definitions
Syntax
void GetPropertyValuesAsync(
System.Collections.Generic.IEnumerable<IEntity> entities,
System.Collections.Generic.IEnumerable<PropertyDefinition> propDefs,
PropertyValueSettings settings,
System.object tag,
System.Func<GetPropertyValuesResults,bool> resultFunc
)Sub GetPropertyValuesAsync( _
ByVal entities As System.Collections.Generic.IEnumerable(Of IEntity), _
ByVal propDefs As System.Collections.Generic.IEnumerable(Of PropertyDefinition), _
ByVal settings As PropertyValueSettings, _
ByVal tag As System.Object, _
ByVal resultFunc As System.Func(Of GetPropertyValuesResults,Boolean) _
) Parameters
| Name | Description |
|---|---|
| entities | The list of entities to get property values for |
| propDefs | The list of Property Definitions to get property values for. If null, then values will be retrieved for all property definitions. |
| settings | Optional conifguration which determines how some property values should be computed |
| tag | A value which will be passed back to the resultFunc which helps to identify the request that is associated with the asynchronous results. |
| resultFunc | A callback function used to report incremental progress. The callback function has the syntax of bool callBack(Vault.Results.GetPropertyValuesResults results). The callback should return true to continue processing results. A return of false will cancel the remainder of the retrieval. The PropertyValues property on the results parameter will be null to indicate that there is no more incremental data to report. |