source3/libads/ads_ldap_protos.h: fix licence/copyright
[samba.git] / source3 / libads / ads_status.h
1 #ifndef _LIBADS_ADS_STATUS_H_
2 #define _LIBADS_ADS_STATUS_H_
3
4 /* there are 5 possible types of errors the ads subsystem can produce */
5 enum ads_error_type {ENUM_ADS_ERROR_KRB5, ENUM_ADS_ERROR_GSS,
6                      ENUM_ADS_ERROR_LDAP, ENUM_ADS_ERROR_SYSTEM, ENUM_ADS_ERROR_NT};
7
8 typedef struct {
9         enum ads_error_type error_type;
10         union err_state{
11                 int rc;
12                 NTSTATUS nt_status;
13         } err;
14         /* For error_type = ENUM_ADS_ERROR_GSS minor_status describe GSS API error */
15         /* Where rc represents major_status of GSS API error */
16         int minor_status;
17 } ADS_STATUS;
18
19 /* macros to simplify error returning */
20 #define ADS_ERROR(rc) ADS_ERROR_LDAP(rc)
21 #define ADS_ERROR_LDAP(rc) ads_build_error(ENUM_ADS_ERROR_LDAP, rc, 0)
22 #define ADS_ERROR_SYSTEM(rc) ads_build_error(ENUM_ADS_ERROR_SYSTEM, rc?rc:EINVAL, 0)
23 #define ADS_ERROR_KRB5(rc) ads_build_error(ENUM_ADS_ERROR_KRB5, rc, 0)
24 #define ADS_ERROR_GSS(rc, minor) ads_build_error(ENUM_ADS_ERROR_GSS, rc, minor)
25 #define ADS_ERROR_NT(rc) ads_build_nt_error(ENUM_ADS_ERROR_NT,rc)
26
27 #define ADS_ERR_OK(status) ((status.error_type == ENUM_ADS_ERROR_NT) ? NT_STATUS_IS_OK(status.err.nt_status):(status.err.rc == 0))
28 #define ADS_SUCCESS ADS_ERROR(0)
29
30 #define ADS_ERROR_HAVE_NO_MEMORY(x) do { \
31         if (!(x)) {\
32                 return ADS_ERROR(LDAP_NO_MEMORY);\
33         }\
34 } while (0)
35
36 /* The following definitions come from libads/ads_status.c  */
37
38 ADS_STATUS ads_build_error(enum ads_error_type etype,
39                            int rc, int minor_status);
40 ADS_STATUS ads_build_nt_error(enum ads_error_type etype,
41                            NTSTATUS nt_status);
42 NTSTATUS ads_ntstatus(ADS_STATUS status);
43 const char *ads_errstr(ADS_STATUS status);
44 NTSTATUS gss_err_to_ntstatus(uint32 maj, uint32 min);
45
46 #endif /* _LIBADS_ADS_STATUS_H_ */