Platforms to show: All Mac Windows Linux Cross-Platform
CSIdentityQueryMBS class
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
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.
- property Handle as Integer
- 5 methods
- method Constructor Private
- method Execute(flags as Integer = 0) as Boolean
- method Execute(flags as Integer, byref error as Variant) as Boolean
- method Results as CSIdentityMBS()
- method Stop
- 7 shared methods
- shared method Available as Boolean
- shared method Create(identityClass as Integer, authority as CSIdentityAuthorityMBS) as CSIdentityQueryMBS
- shared method CreateForCurrentUser as CSIdentityQueryMBS
- shared method CreateForName(name as string, comparisonMethod as Integer, identityClass as Integer, authority as CSIdentityAuthorityMBS) as CSIdentityQueryMBS
- shared method CreateForPersistentReference(data as memoryblock) as CSIdentityQueryMBS
- shared method CreateForPosixID(posixID as Integer, identityClass as Integer, authority as CSIdentityAuthorityMBS) as CSIdentityQueryMBS
- shared method CreateForUUID(uuid as string, authority as CSIdentityAuthorityMBS) as CSIdentityQueryMBS
- 4 constants
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:
- CSIdentityMBS.GroupMembershipQuery as CSIdentityQueryMBS
Blog Entries
The items on this page are in the following plugins: MBS MacFrameworks Plugin.
CSIdentityMBS - CSManagementModuleMBS