Directory Common Argument Parameter IDs

Macros

#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)
 
#define DS_SVC_OPT_PAGESIZE   MAKE_PARAM_ID(18, DS_INT_TYPE)
 
#define DS_SEC_DISABLEVERIFICATION   MAKE_PARAM_ID(19, DS_BOOL_TYPE)
 
#define DS_SVC_OPT_TXNID   MAKE_PARAM_ID(20, DS_BYTES_TYPE)
 

Detailed Description

See also
Common Arguments to Directory Operations

Macro Definition Documentation

◆ DS_SVC_OPT_PREFERCHAIN

#define DS_SVC_OPT_PREFERCHAIN   MAKE_PARAM_ID(1, DS_BOOL_TYPE)

Request chained operation (rather than referral) where necessary.

Definition at line 326 of file dsapi_const.h.

◆ DS_SVC_OPT_CHAININGPROHIBIT

#define DS_SVC_OPT_CHAININGPROHIBIT   MAKE_PARAM_ID(2, DS_BOOL_TYPE)

Prohibit the use of chaining in a distributed operation.

Definition at line 328 of file dsapi_const.h.

◆ DS_SVC_OPT_LOCALSCOPE

#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 331 of file dsapi_const.h.

◆ DS_SVC_OPT_DONTUSECOPY

#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 334 of file dsapi_const.h.

◆ DS_SVC_OPT_DONTDEREFALIAS

#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 337 of file dsapi_const.h.

◆ DS_SVC_OPT_SUBENTRIES

#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 340 of file dsapi_const.h.

◆ DS_SVC_OPT_COPYSHALLDO

#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 343 of file dsapi_const.h.

◆ DS_SVC_PRIORITY

#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 348 of file dsapi_const.h.

◆ DS_SVC_TIMELIMIT

#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 351 of file dsapi_const.h.

◆ DS_SVC_SIZELIMIT

#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 354 of file dsapi_const.h.

◆ DS_EXT_OPT_MANAGEDSAIT

#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 357 of file dsapi_const.h.

◆ DS_SEC_SIGNED

#define DS_SEC_SIGNED   MAKE_PARAM_ID(12, DS_BOOL_TYPE)

Indicates that the Directory operation should be cryptographically signed.

Definition at line 360 of file dsapi_const.h.

◆ DS_SEC_ENCRYPTED

#define DS_SEC_ENCRYPTED   MAKE_PARAM_ID(13, DS_BOOL_TYPE)

Indicates that the Directory operation should be encrypted.

Definition at line 364 of file dsapi_const.h.

◆ DS_SVC_OPT_ATTRSONLY

#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 367 of file dsapi_const.h.

◆ DS_SVC_OPT_SEARCHALIASES

#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 372 of file dsapi_const.h.

◆ DS_EXT_OPT_USEALIASONUPDATE

#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 377 of file dsapi_const.h.

◆ DS_SVC_PASSWORDPOLICY

#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 382 of file dsapi_const.h.

◆ DS_SVC_OPT_PAGESIZE

#define DS_SVC_OPT_PAGESIZE   MAKE_PARAM_ID(18, DS_INT_TYPE)

Indicates that a paged results search is being requested, with pages of the required size.

Since
DSAPI_VERSION 2031

Definition at line 387 of file dsapi_const.h.

◆ DS_SEC_DISABLEVERIFICATION

#define DS_SEC_DISABLEVERIFICATION   MAKE_PARAM_ID(19, DS_BOOL_TYPE)

Indicates that DSAPI's verification of the server certificate should be disabled when strong authentication is being performed.

Since
DSAPI_VERSION 2035

Definition at line 392 of file dsapi_const.h.

◆ DS_SVC_OPT_TXNID

#define DS_SVC_OPT_TXNID   MAKE_PARAM_ID(20, DS_BYTES_TYPE)

Indicates that an update operation is a part of a transcation, the bytes being the transaction identifier (as specified by the server).

Since
DSAPI_VERSION 2047

Definition at line 397 of file dsapi_const.h.

All rights reserved © 2002 - 2024 Isode Ltd.