Platforms to show: All Mac Windows Linux Cross-Platform

Back to ODQueryMBS class.

ODQueryMBS.Constructor(node as ODNodeMBS, inRecordTypeOrList as Variant, inAttribute as String, matchType as Integer, inQueryValueOrList as Variant, inReturnAttributeOrList as Variant, maximumResults as Integer, byref error as NSErrorMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Open Directory MBS MacFrameworks Plugin 19.3 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Returns an query object created with provided parameters.

Node: The node to query.
in RecordTypeOrList: The type or types of record to query. Can be an NSString object for a single type or an NSArray object containing NSString objects for multiple types.
inAttribute: The name of the attribute to query.
MatchType: The type of query.
inQueryValueOrList: The value or values to query in the attribute. Can be a string or a memoryblock object for a single value, or an array containing string and memoryblock objects for multiple values.
inReturnAttributeOrList: The attribute or attributes to be returned from the query. Can be a string for a single attribute or an array object containing strings for multiple attributes. Passing nil is equivalent to passing kODAttributeTypeStandardOnly.
maximumResults: The maximum number of values to be returned.
Error: An error reference for error details.

ODQueryMBS.Destructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Open Directory MBS MacFrameworks Plugin 19.3 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
The destructor.

ODQueryMBS.resultsAllowingPartial(AllowPartialResults as Boolean, byref error as NSErrorMBS) as ODRecordMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Open Directory MBS MacFrameworks Plugin 19.3 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Returns results from a query synchronously.

AllowPartialResults: If true, only immediately available results are returned; otherwise, the function waits until all results are available.
Error: An error reference for error details. Can be nil.

Returns the results of the query in an array of ODRecordMBS objects.

Some examples using this method:

ODQueryMBS.start

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Open Directory MBS MacFrameworks Plugin 19.3 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Starts asynchronous search.

ODQueryMBS.synchronize

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Open Directory MBS MacFrameworks Plugin 19.3 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Restarts a query, disposing of any results it has obtained.

If the query was originally started asynchronously, the event is called with inResults set to nil, error.code set to kODErrorQuerySynchronize, and error.domain set to kODErrorDomainFramework.

The items on this page are in the following plugins: MBS MacFrameworks Plugin.


The biggest plugin in space...