Xojo Conferences

Platforms to show: All Mac Windows Linux Cross-Platform

CSIdentityQueryMBS class

Type Topic Plugin Version macOS Windows Linux Console & Web iOS
class Collaboration MBS MacFrameworks Plugin 13.0 Yes No No Yes, macOS only No
Function: A CSIdentityQuery object provides synchronous or asynchronous access to a collection of identities managed by an identity authority.
Clients call one of the CSIdentityQueryCreate* functions to define the query criteria. A query can be executed exactly once, in either synchronous or asynchronous mode.

For synchronous execution, the client calls CSIdentityQueryExecute. This function will return when all identies matching the criteria have been found. The results are accessed as an array via Results(). No live updates to the results array are provided in synchronous mode.

To execute in asynchronous mode, the client calls ExecuteAsynchronously, specifying a client object to receive callbacks and a runloop/mode on which callbacks are scheduled.

ExecuteAsynchronously returns immediately, and events will be reported to the callback function as results are added by the query. The client may request live updates to the query which will track changes to the results as changes are made to the identity authority by other processes. Currently, only changes to the local identity authority are monitored.

Asynchronous clients must call Stop when done processing query results to prevent the client callbacks from being called again.
This is an abstract class. You can't create an instance, but you can get one from various plugin functions.

Feedback, Comments & Corrections

Execution flags

Constant Value Description
kCSIdentityQueryGenerateUpdateEvents 1 After the intial query phase is complete, monitor the result set for live updates.
kCSIdentityQueryIncludeHiddenIdentities 2 Include all matching identities in the result set, including hidden "system" users and groups (root, www, etc.).

String Operation

Constant Value Description
kCSIdentityQueryStringBeginsWith 2 The identity name must begin with the search string.
When searching for identities by name, this value specifies the string comparison function.
kCSIdentityQueryStringEquals 1 The identity name must equal the search string.
When searching for identities by name, this value specifies the string comparison function.

This class has no sub classes.

Some methods using this class:

Blog Entries

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

CSIdentityMBS   -   CSManagementModuleMBS

The biggest plugin in space...

MBS Xojo PDF Plugins