Summary: Isode provides a number of APIs which allow integrators and product developers to build components that allow client programs to connect to, query and modify data in the directory.
dsapi_const.h
Go to the documentation of this file.
1 /* Emacs mode: -*- C -*- */
2 
3 /*
4  * Copyright (c) 2004-2016, Isode Limited, London, England.
5  * All rights reserved.
6  *
7  * Acquisition and use of this software and related materials for any
8  * purpose requires a written licence agreement from Isode Limited, or
9  * a written licence from an organisation licenced by Isode Limited to
10  * grant such a licence.
11  *
12  */
13 
14 /*
15  * dsapi_const.h
16  *
17  * Symbolic constants.
18  *
19  */
20 
21 /*
22  *
23  *
24  * @VERSION@
25  */
26 
27 #ifndef ISODE_DSAPI_CONST_H
28 #define ISODE_DSAPI_CONST_H
29 
34 /* API Version. */
35 #define DSAPI_VERSION 2047
36 
38 /* Generic parameter representation. */
40 #ifndef PRIVATE_DEFINITION
41 #define DS_INT_TYPE 0x01000000
42 
43 #define DS_STR_TYPE 0x02000000
44 
45 #define DS_BOOL_TYPE 0x04000000
46 
47 #define DS_BYTES_TYPE 0x08000000
48 
50 /* Get parameter type from ID (see dsapi_const.h for parameter IDs). */
51 #define DS_PARAM_TYPE_MASK 0xff000000
52 
53 #define PARAMTYPE(id) ( id & DS_PARAM_TYPE_MASK )
54 
55 /* Add typing bits to a parameter ID value. */
56 #define MAKE_PARAM_ID(val, param_type) ( val | param_type )
57 
58 #endif
59 
66 typedef enum {
97  DS_E_BADDN = 10,
129 } DS_Status;
130 
138 typedef enum {
139  DS_E_SUCCESS = 0,
140  /*< Successful operation. */
141 
181 } DS_ErrorType;
182 
190 typedef enum {
313 } DS_ErrorValue;
314 
326 #define DS_SVC_OPT_PREFERCHAIN MAKE_PARAM_ID(1, DS_BOOL_TYPE)
327 
328 #define DS_SVC_OPT_CHAININGPROHIBIT MAKE_PARAM_ID(2, DS_BOOL_TYPE)
329 
331 #define DS_SVC_OPT_LOCALSCOPE MAKE_PARAM_ID(3, DS_BOOL_TYPE)
332 
334 #define DS_SVC_OPT_DONTUSECOPY MAKE_PARAM_ID(4, DS_BOOL_TYPE)
335 
337 #define DS_SVC_OPT_DONTDEREFALIAS MAKE_PARAM_ID(5, DS_BOOL_TYPE)
338 
340 #define DS_SVC_OPT_SUBENTRIES MAKE_PARAM_ID(6, DS_BOOL_TYPE)
341 
343 #define DS_SVC_OPT_COPYSHALLDO MAKE_PARAM_ID(7, DS_BOOL_TYPE)
344 
348 #define DS_SVC_PRIORITY MAKE_PARAM_ID(8, DS_INT_TYPE)
349 
351 #define DS_SVC_TIMELIMIT MAKE_PARAM_ID(9, DS_INT_TYPE)
352 
354 #define DS_SVC_SIZELIMIT MAKE_PARAM_ID(10, DS_INT_TYPE)
355 
357 #define DS_EXT_OPT_MANAGEDSAIT MAKE_PARAM_ID(11, DS_BOOL_TYPE)
358 
360 #define DS_SEC_SIGNED MAKE_PARAM_ID(12, DS_BOOL_TYPE)
361 
364 #define DS_SEC_ENCRYPTED MAKE_PARAM_ID(13, DS_BOOL_TYPE)
365 
367 #define DS_SVC_OPT_ATTRSONLY MAKE_PARAM_ID(14, DS_BOOL_TYPE)
368 
372 #define DS_SVC_OPT_SEARCHALIASES MAKE_PARAM_ID(15, DS_BOOL_TYPE)
373 
377 #define DS_EXT_OPT_USEALIASONUPDATE MAKE_PARAM_ID(16, DS_BOOL_TYPE)
378 
382 #define DS_SVC_PASSWORDPOLICY MAKE_PARAM_ID(17, DS_BOOL_TYPE)
383 
387 #define DS_SVC_OPT_PAGESIZE MAKE_PARAM_ID(18, DS_INT_TYPE)
388 
392 #define DS_SEC_DISABLEVERIFICATION MAKE_PARAM_ID(19, DS_BOOL_TYPE)
393 
397 #define DS_SVC_OPT_TXNID MAKE_PARAM_ID(20, DS_BYTES_TYPE)
398 
411 typedef enum {
444 
447 #endif /* ISODE_DSAPI_CONST_H */
DS_ErrorValue
Definition: dsapi_const.h:190
DS_ErrorType
Definition: dsapi_const.h:138
DS_PasswordPolicyError
Definition: dsapi_const.h:411
DS_Status
Definition: dsapi_const.h:66