Messaging and Directory Server software used around the world in the Government, Military, Aviation and Commercial sectors. Section Contents Main Page Modules File List File Members

Documentation Isode Simple Directory API     dsapi_types.h File Reference Directory API type definitions and forward declarations of private types. More... #include <isode/ds/dsapi/dsapi_const.h> Go to the source code of this file. Typedefs typedef DS_Session  DS_Session typedef DS_AttrVal  DS_AttrVal typedef DS_Attr  DS_Attr typedef DS_Entry  DS_Entry typedef DS_Referral  DS_Referral typedef DS_ReferralAddress  DS_ReferralAddress typedef DS_DN  DS_DN typedef DS_Result  DS_Result typedef DS_Error  DS_Error typedef DS_Indication  DS_Indication typedef DS_Attr  DS_AttrList typedef DS_AttrVal  DS_AttrValList typedef DS_DN  DS_DNList typedef DS_Entry  DS_EntryList typedef DS_Referral  DS_ReferralList typedef DS_CommonArgs  DS_CommonArgs typedef IF_Dn  DS_InternalDN typedef DS_LDIF  DS_LDIF typedef DS_RanLDIF  DS_RanLDIF typedef DS_DNIndex  DS_DNIndex typedef DSHookAction  DS_ErrorHook (void *object, char *operation, DS_Status status, void *user)   Error callback hook function type. Enumerations enum   DSSearchScope { DSScopeBaseObject = 0, DSScopeOneLevel = 1, DSScopeSubtree = 2 } enum   DSLimitProblem { DSLimitNoProblem = 0, DSLimitTimeExceeded = 1, DSLimitSizeExceeded = 2, DSLimitAdminLimitExceeded = 3 } enum   DSModType { DSModAdd = 0, DSModDelete = 1, DSModReplace = 2 } enum   DSEntryType {   DSEntryNormal = 0, DSEntryModify = 1, DSEntryAdd = 2, DSEntryDelete = 3,   DSEntryRename = 4 } enum   DSHookAction { DSActionContinue = 0, DSActionAbort = 1 } Detailed Description Directory API type definitions and forward declarations of private types. Definition in file dsapi_types.h. Typedef Documentation typedef struct DS_Session DS_Session This represents a connection to a directory. See Session Management Examples: add.c, anonymous.c, async.c, delete.c, modify.c, read.c, and simple.c. Definition at line 79 of file dsapi_types.h. typedef struct DS_AttrVal DS_AttrVal This represents a value of an attribute. See Attribute Values Examples: async.c, and read.c. Definition at line 85 of file dsapi_types.h. typedef struct DS_Attr DS_Attr This represents an attribute of an entry. See Entry Attributes Examples: add.c, async.c, modify.c, and read.c. Definition at line 91 of file dsapi_types.h. typedef struct DS_Entry DS_Entry This represents a directory entry. See Directory Entries Examples: add.c, async.c, modify.c, and read.c. Definition at line 97 of file dsapi_types.h. typedef struct DS_Referral DS_Referral This represents information about a referral returned from the directory. See Directory Referrals Since: DSAPI_VERSION 2016 Definition at line 105 of file dsapi_types.h. typedef struct DS_ReferralAddress DS_ReferralAddress This represents information about a particular location where a referral may be followed. See Directory Referrals Since: DSAPI_VERSION 2016 Definition at line 113 of file dsapi_types.h. typedef struct DS_DN DS_DN This represents a single Distinguished Name. See Distinguished Names Examples: add.c, async.c, delete.c, modify.c, read.c, and simple.c. Definition at line 119 of file dsapi_types.h. typedef struct DS_Result DS_Result This represents an operation result returned by the directory. See Directory operation error types Definition at line 125 of file dsapi_types.h. typedef struct DS_Error DS_Error This represents an operation error returned by the directory. See Directory operation error types and Directory operation error values. Definition at line 131 of file dsapi_types.h. typedef struct DS_Indication DS_Indication This represents the result (or error) returned by a directory operation. See Handling Directory Operation Results Examples: add.c, async.c, delete.c, modify.c, and read.c. Definition at line 137 of file dsapi_types.h. typedef struct DS_Attr DS_AttrList This represents a list of attributes See Entry Attributes Examples: async.c, and read.c. Definition at line 143 of file dsapi_types.h. typedef struct DS_AttrVal DS_AttrValList This represents a list of values of an attribute See Attribute Values Examples: async.c, and read.c. Definition at line 149 of file dsapi_types.h. typedef struct DS_DN DS_DNList This represents a list of Distinguished Names. See Distinguished Names Definition at line 155 of file dsapi_types.h. typedef struct DS_Entry DS_EntryList This represents a list of entries See Directory Entries Examples: async.c, and read.c. Definition at line 161 of file dsapi_types.h. typedef struct DS_Referral DS_ReferralList This represents a list of referrals See Directory Referrals Since: DSAPI_VERSION 2016 Definition at line 168 of file dsapi_types.h. typedef struct DS_CommonArgs DS_CommonArgs This represents a list of common arguments for directory operations. See Common Arguments to Directory Operations Definition at line 174 of file dsapi_types.h. typedef struct IF_Dn DS_InternalDN This is an internal representation of a Distinguished Name, which may be needed when interfacing to other code. See Distinguished Names Definition at line 181 of file dsapi_types.h. typedef struct DS_LDIF DS_LDIF This represents LDIF input and/or output streams. See LDIF files Definition at line 187 of file dsapi_types.h. typedef DSHookAction DS_ErrorHook(void *object, char *operation, DS_Status status, void *user) Error callback hook function type. The exact values passed for 'object' and 'operation' will be documented in the function that accepts the callback function pointer. Parameters: object  The object that the original API call was made on. operation  A string name describing the operation attempted. status  The status returned by the problem operation user  The callback function's own user data pointer. Return values: DSActionContinue  Continue the operation DSActionAbort  Abort the operation Definition at line 254 of file dsapi_types.h. Enumeration Type Documentation enum DSSearchScope Values of the 'scope' parameter of directory search operations. Enumerator: DSScopeBaseObject  Search the base object only. DSScopeOneLevel  Search one level below the base object. DSScopeSubtree  Search the entire subtree below the base object. Definition at line 196 of file dsapi_types.h. { DSScopeBaseObject = 0, DSScopeOneLevel = 1, DSScopeSubtree = 2 } DSSearchScope; enum DSLimitProblem Indicates if a search operation was limited for some reason. Enumerator: DSLimitNoProblem  All results were received. DSLimitTimeExceeded  A time limit was reached. DSLimitSizeExceeded  Too many results. DSLimitAdminLimitExceeded  Administrative limit reached. Definition at line 205 of file dsapi_types.h. { DSLimitNoProblem = 0, DSLimitTimeExceeded = 1, DSLimitSizeExceeded = 2, DSLimitAdminLimitExceeded = 3 } DSLimitProblem; enum DSModType Modification types for attributes in change-entries. Enumerator: DSModAdd  Add modification. DSModDelete  Delete modification. DSModReplace  Replace modification. Definition at line 215 of file dsapi_types.h. { DSModAdd = 0, DSModDelete = 1, DSModReplace = 2 } DSModType; enum DSEntryType Types for entries. Enumerator: DSEntryNormal  Normal (plain) entry. DSEntryModify  Modify entry. DSEntryAdd  Add entry. DSEntryDelete  Delete entry. DSEntryRename  Rename (modify-DN) entry. Definition at line 224 of file dsapi_types.h. { DSEntryNormal = 0, DSEntryModify = 1, DSEntryAdd = 2, DSEntryDelete = 3, DSEntryRename = 4 } DSEntryType; enum DSHookAction Actions for hooks Enumerator: DSActionContinue  Continue with the operation. DSActionAbort  Abort the operation. Definition at line 235 of file dsapi_types.h. { DSActionContinue = 0, DSActionAbort = 1, } DSHookAction;

Copyright © 2008 Isode

privacy   feedback