Messaging and Directory Server software used around the world in the Government, Military, Aviation and Commercial sectors.
Documentation
Isode Simple Directory API
Directory Common Argument Parameter IDs
Defines | |
| #define | DS_SVC_OPT_PREFERCHAIN MAKE_PARAM_ID(1, DS_BOOL_TYPE) |
| #define | DS_SVC_OPT_CHAININGPROHIBIT MAKE_PARAM_ID(2, DS_BOOL_TYPE) |
| #define | DS_SVC_OPT_LOCALSCOPE MAKE_PARAM_ID(3, DS_BOOL_TYPE) |
| #define | DS_SVC_OPT_DONTUSECOPY MAKE_PARAM_ID(4, DS_BOOL_TYPE) |
| #define | DS_SVC_OPT_DONTDEREFALIAS MAKE_PARAM_ID(5, DS_BOOL_TYPE) |
| #define | DS_SVC_OPT_SUBENTRIES MAKE_PARAM_ID(6, DS_BOOL_TYPE) |
| #define | DS_SVC_OPT_COPYSHALLDO MAKE_PARAM_ID(7, DS_BOOL_TYPE) |
| #define | DS_SVC_PRIORITY MAKE_PARAM_ID(8, DS_INT_TYPE) |
| #define | DS_SVC_TIMELIMIT MAKE_PARAM_ID(9, DS_INT_TYPE) |
| #define | DS_SVC_SIZELIMIT MAKE_PARAM_ID(10, DS_INT_TYPE) |
| #define | DS_EXT_OPT_MANAGEDSAIT MAKE_PARAM_ID(11, DS_BOOL_TYPE) |
| #define | DS_SEC_SIGNED MAKE_PARAM_ID(12, DS_BOOL_TYPE) |
| #define | DS_SEC_ENCRYPTED MAKE_PARAM_ID(13, DS_BOOL_TYPE) |
| #define | DS_SVC_OPT_ATTRSONLY MAKE_PARAM_ID(14, DS_BOOL_TYPE) |
| #define | DS_SVC_OPT_SEARCHALIASES MAKE_PARAM_ID(15, DS_BOOL_TYPE) |
| #define | DS_EXT_OPT_USEALIASONUPDATE MAKE_PARAM_ID(16, DS_BOOL_TYPE) |
| #define | DS_SVC_PASSWORDPOLICY MAKE_PARAM_ID(17, DS_BOOL_TYPE) |
Detailed Description
Define Documentation
| #define DS_SVC_OPT_PREFERCHAIN MAKE_PARAM_ID(1, DS_BOOL_TYPE) |
Request chained operation (rather than referral) where necessary.
Definition at line 436 of file dsapi_const.h.
| #define DS_SVC_OPT_CHAININGPROHIBIT MAKE_PARAM_ID(2, DS_BOOL_TYPE) |
Prohibit the use of chaining in a distributed operation.
Definition at line 438 of file dsapi_const.h.
| #define DS_SVC_OPT_LOCALSCOPE MAKE_PARAM_ID(3, DS_BOOL_TYPE) |
Restrict operation to data stored in local scope (usually the local DSA).
Definition at line 441 of file dsapi_const.h.
| #define DS_SVC_OPT_DONTUSECOPY MAKE_PARAM_ID(4, DS_BOOL_TYPE) |
Request that copied data not be used to satisfy the operation.
Definition at line 444 of file dsapi_const.h.
| #define DS_SVC_OPT_DONTDEREFALIAS MAKE_PARAM_ID(5, DS_BOOL_TYPE) |
Indicates that any alias used to identify the entry affected by the operation is not to be dereferenced.
Definition at line 447 of file dsapi_const.h.
| #define DS_SVC_OPT_SUBENTRIES MAKE_PARAM_ID(6, DS_BOOL_TYPE) |
Indicates that a Search or List operation is to access subentries only; normal entries become inaccessible.
Definition at line 450 of file dsapi_const.h.
| #define DS_SVC_OPT_COPYSHALLDO MAKE_PARAM_ID(7, DS_BOOL_TYPE) |
Indicates that if the Directory is able to partly but not fully satisfy a query at a copy of an entry, it shall not chain the query. It is meaningful only if DS_SVC_OPT_DONTUSECOPY is not set.
Definition at line 453 of file dsapi_const.h.
| #define DS_SVC_PRIORITY MAKE_PARAM_ID(8, DS_INT_TYPE) |
Sets the priority of the operation. 0 is low priority, 1 is medium, and 2 is high priority.
Definition at line 458 of file dsapi_const.h.
| #define DS_SVC_TIMELIMIT MAKE_PARAM_ID(9, DS_INT_TYPE) |
Sets the maximum elapsed time in seconds that the operation should be allowed to take.
Definition at line 461 of file dsapi_const.h.
| #define DS_SVC_SIZELIMIT MAKE_PARAM_ID(10, DS_INT_TYPE) |
Sets the maximum number of entries that can be returned by a list or search operation..
Definition at line 464 of file dsapi_const.h.
| #define DS_EXT_OPT_MANAGEDSAIT MAKE_PARAM_ID(11, DS_BOOL_TYPE) |
Indicates that the Directory operation should be processed against the DsaIT instead of the DIT.
Definition at line 467 of file dsapi_const.h.
| #define DS_SEC_SIGNED MAKE_PARAM_ID(12, DS_BOOL_TYPE) |
Indicates that the Directory operation should be cryptographically signed.
Definition at line 470 of file dsapi_const.h.
| #define DS_SEC_ENCRYPTED MAKE_PARAM_ID(13, DS_BOOL_TYPE) |
Indicates that the Directory operation should be encrypted.
Definition at line 474 of file dsapi_const.h.
| #define DS_SVC_OPT_ATTRSONLY MAKE_PARAM_ID(14, DS_BOOL_TYPE) |
Indicates that a search or read operation should return attribute types without returning values.
- Since:
- DSAPI_VERSION 2008
Definition at line 477 of file dsapi_const.h.
| #define DS_SVC_OPT_SEARCHALIASES MAKE_PARAM_ID(15, DS_BOOL_TYPE) |
Indicates that search results which are aliases should be dereferenced so that the aliased entry is returned.
- Since:
- DSAPI_VERSION 2009
Definition at line 482 of file dsapi_const.h.
| #define DS_EXT_OPT_USEALIASONUPDATE MAKE_PARAM_ID(16, DS_BOOL_TYPE) |
Indicates that aliases should be dereferenced for Add, Remove and Modify operations. This option has no effect for LDAP connections.
- Since:
- DSAPI_VERSION 2009
Definition at line 487 of file dsapi_const.h.
| #define DS_SVC_PASSWORDPOLICY MAKE_PARAM_ID(17, DS_BOOL_TYPE) |
Indicates that the current account's password policy status should be returned. This option has no effect for DAP connections.
- Since:
- DSAPI_VERSION 2020
Definition at line 492 of file dsapi_const.h.
