2d21a901afa87456f46306914775ed83e1c5b718
[reactos.git] / reactos / w32api / include / objsel.h
1 /*
2 * objsel.h
3 *
4 * Object Picker Dialog
5 *
6 * THIS SOFTWARE IS NOT COPYRIGHTED
7 *
8 * This source code is offered for use in the public domain. You may
9 * use, modify or distribute it freely.
10 *
11 * This code is distributed in the hope that it will be useful but
12 * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
13 * DISCLAIMED. This includes but is not limited to warranties of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15 *
16 */
17 #ifndef __OBJSEL_H
18 #define __OBJSEL_H
19
20 #ifdef __cplusplus
21 extern "C" {
22 #endif
23
24 /* the PSDK headers defines it as EXTERN_C const GUID CLSID_DsObjectPicker = {...},
25 * but that's not a good idea when EXTERN_C is extern... */
26 #ifndef DEFINE_GUID
27 #include <initguid.h>
28 #endif
29
30 DEFINE_GUID(CLSID_DsObjectPicker, 0x17d6ccd8, 0x3b7b, 0x11d2, 0x00b9, 0xe0,0x00,0xc0,0x4f,0xd8,0xdb,0xf7);
31 DEFINE_GUID(IID_IDsObjectPicker, 0x0c87e64e, 0x3b7a, 0x11d2, 0x00b9, 0xe0,0x00,0xc0,0x4f,0xd8,0xdb,0xf7);
32
33 #define CFSTR_DSOP_DS_SELECTION_LIST TEXT("CFSTR_DSOP_DS_SELECTION_LIST")
34
35 /* up-level scope filters in the DSOP_UPLEVEL_FILTER_FLAGS structure */
36 #define DSOP_FILTER_INCLUDE_ADVANCED_VIEW (0x1)
37 #define DSOP_FILTER_USERS (0x2)
38 #define DSOP_FILTER_BUILTIN_GROUPS (0x4)
39 #define DSOP_FILTER_WELL_KNOWN_PRINCIPALS (0x8)
40 #define DSOP_FILTER_UNIVERSAL_GROUPS_DL (0x10)
41 #define DSOP_FILTER_UNIVERSAL_GROUPS_SE (0x20)
42 #define DSOP_FILTER_GLOBAL_GROUPS_DL (0x40)
43 #define DSOP_FILTER_GLOBAL_GROUPS_SE (0x80)
44 #define DSOP_FILTER_DOMAIN_LOCAL_GROUPS_DL (0x100)
45 #define DSOP_FILTER_DOMAIN_LOCAL_GROUPS_SE (0x200)
46 #define DSOP_FILTER_CONTACTS (0x400)
47 #define DSOP_FILTER_COMPUTERS (0x800)
48
49 typedef struct _DSOP_UPLEVEL_FILTER_FLAGS
50 {
51 ULONG flBothModes;
52 ULONG flMixedModeOnly;
53 ULONG flNativeModeOnly;
54 } DSOP_UPLEVEL_FILTER_FLAGS, *PDSOP_UPLEVEL_FILTER_FLAGS;
55
56 /* down-level scope filters in the DSOP_FILTER_FLAGS structure */
57 #define DSOP_DOWNLEVEL_FILTER_USERS (0x80000001)
58 #define DSOP_DOWNLEVEL_FILTER_LOCAL_GROUPS (0x80000002)
59 #define DSOP_DOWNLEVEL_FILTER_GLOBAL_GROUPS (0x80000004)
60 #define DSOP_DOWNLEVEL_FILTER_COMPUTERS (0x80000008)
61 #define DSOP_DOWNLEVEL_FILTER_WORLD (0x80000010)
62 #define DSOP_DOWNLEVEL_FILTER_AUTHENTICATED_USER (0x80000020)
63 #define DSOP_DOWNLEVEL_FILTER_ANONYMOUS (0x80000040)
64 #define DSOP_DOWNLEVEL_FILTER_BATCH (0x80000080)
65 #define DSOP_DOWNLEVEL_FILTER_CREATOR_OWNER (0x80000100)
66 #define DSOP_DOWNLEVEL_FILTER_CREATOR_GROUP (0x80000200)
67 #define DSOP_DOWNLEVEL_FILTER_DIALUP (0x80000400)
68 #define DSOP_DOWNLEVEL_FILTER_INTERACTIVE (0x80000800)
69 #define DSOP_DOWNLEVEL_FILTER_NETWORK (0x80001000)
70 #define DSOP_DOWNLEVEL_FILTER_SERVICE (0x80002000)
71 #define DSOP_DOWNLEVEL_FILTER_SYSTEM (0x80004000)
72 #define DSOP_DOWNLEVEL_FILTER_EXCLUDE_BUILTIN_GROUPS (0x80008000)
73 #define DSOP_DOWNLEVEL_FILTER_TERMINAL_SERVER (0x80010000)
74 #define DSOP_DOWNLEVEL_FILTER_ALL_WELLKNOWN_SIDS (0x80020000)
75 #define DSOP_DOWNLEVEL_FILTER_LOCAL_SERVICE (0x80040000)
76 #define DSOP_DOWNLEVEL_FILTER_NETWORK_SERVICE (0x80080000)
77 #define DSOP_DOWNLEVEL_FILTER_REMOTE_LOGON (0x80100000)
78
79 typedef struct _DSOP_FILTER_FLAGS
80 {
81 DSOP_UPLEVEL_FILTER_FLAGS Uplevel;
82 ULONG flDownlevel;
83 } DSOP_FILTER_FLAGS, *PDSOP_FILTER_FLAGS;
84
85 /* ADsPath format flags in the DSOP_SCOPE_INIT_INFO structure */
86 #define DSOP_SCOPE_FLAG_STARTING_SCOPE (0x1)
87 #define DSOP_SCOPE_FLAG_WANT_PROVIDER_WINNT (0x2)
88 #define DSOP_SCOPE_FLAG_WANT_PROVIDER_LDAP (0x4)
89 #define DSOP_SCOPE_FLAG_WANT_PROVIDER_GC (0x8)
90 #define DSOP_SCOPE_FLAG_WANT_SID_PATH (0x10)
91 #define DSOP_SCOPE_FLAG_WANT_DOWNLEVEL_BUILTIN_PATH (0x20)
92 #define DSOP_SCOPE_FLAG_DEFAULT_FILTER_USERS (0x40)
93 #define DSOP_SCOPE_FLAG_DEFAULT_FILTER_GROUPS (0x80)
94 #define DSOP_SCOPE_FLAG_DEFAULT_FILTER_COMPUTERS (0x100)
95 #define DSOP_SCOPE_FLAG_DEFAULT_FILTER_CONTACTS (0x200)
96
97 typedef struct _DSOP_SCOPE_INIT_INFO
98 {
99 ULONG cbSize;
100 ULONG flType;
101 ULONG flScope;
102 DSOP_FILTER_FLAGS FilterFlags;
103 PCWSTR pwzDcName;
104 PCWSTR pwzADsPath;
105 HRESULT hr;
106 } DSOP_SCOPE_INIT_INFO, *PDSOP_SCOPE_INIT_INFO;
107 typedef const DSOP_SCOPE_INIT_INFO *PCDSOP_SCOPE_INIT_INFO;
108
109 /* object picker options in the DSOP_INIT_INFO structure */
110 #define DSOP_FLAG_MULTISELECT (0x1)
111 #define DSOP_FLAG_SKIP_TARGET_COMPUTER_DC_CHECK (0x2)
112
113 typedef struct _DSOP_INIT_INFO
114 {
115 ULONG cbSize;
116 PCWSTR pwzTargetComputer;
117 ULONG cDsScopeInfos;
118 PDSOP_SCOPE_INIT_INFO aDsScopeInfos;
119 ULONG flOptions;
120 ULONG cAttributesToFetch;
121 PCWSTR *apwzAttributeNames;
122 } DSOP_INIT_INFO, *PDSOP_INIT_INFO;
123
124 typedef const DSOP_INIT_INFO *PCDSOP_INIT_INFO;
125
126 /* selection scope types in the DS_SELECTION structure */
127 #define DSOP_SCOPE_TYPE_TARGET_COMPUTER (0x1)
128 #define DSOP_SCOPE_TYPE_UPLEVEL_JOINED_DOMAIN (0x2)
129 #define DSOP_SCOPE_TYPE_DOWNLEVEL_JOINED_DOMAIN (0x4)
130 #define DSOP_SCOPE_TYPE_ENTERPRISE_DOMAIN (0x8)
131 #define DSOP_SCOPE_TYPE_GLOBAL_CATALOG (0x10)
132 #define DSOP_SCOPE_TYPE_EXTERNAL_UPLEVEL_DOMAIN (0x20)
133 #define DSOP_SCOPE_TYPE_EXTERNAL_DOWNLEVEL_DOMAIN (0x40)
134 #define DSOP_SCOPE_TYPE_WORKGROUP (0x80)
135 #define DSOP_SCOPE_TYPE_USER_ENTERED_UPLEVEL_SCOPE (0x100)
136 #define DSOP_SCOPE_TYPE_USER_ENTERED_DOWNLEVEL_SCOPE (0x200)
137
138 typedef struct _DS_SELECTION
139 {
140 PWSTR pwzName;
141 PWSTR pwzADsPath;
142 PWSTR pwzClass;
143 PWSTR pwzUPN;
144 VARIANT *pvarFetchedAttributes;
145 ULONG flScopeType;
146 } DS_SELECTION, *PDS_SELECTION;
147
148 typedef struct _DS_SELECTION_LIST
149 {
150 ULONG cItems;
151 ULONG cFetchedAttributes;
152 DS_SELECTION aDsSelection[ANYSIZE_ARRAY];
153 } DS_SELECTION_LIST, *PDS_SELECTION_LIST;
154
155 /*****************************************************************************
156 * IDsObjectPicker interface
157 */
158 #define INTERFACE IDsObjectPicker
159 DECLARE_INTERFACE_(IDsObjectPicker,IUnknown)
160 {
161 /*** IUnknown methods ***/
162 STDMETHOD_(HRESULT,QueryInterface)(THIS_ REFIID riid, void** ppvObject) PURE;
163 STDMETHOD_(ULONG,AddRef)(THIS) PURE;
164 STDMETHOD_(ULONG,Release)(THIS) PURE;
165 /*** IDsObjectPicker methods ***/
166 STDMETHOD_(HRESULT,Initialize)(THIS_ PDSOP_INIT_INFO pInitInfo) PURE;
167 STDMETHOD_(HRESULT,InvokeDialog)(THIS_ HWND hwndParent, IDataObject** ppdoSelections) PURE;
168 };
169 #undef INTERFACE
170
171
172 #ifdef __cplusplus
173 }
174 #endif
175 #endif /* __OBJSEL_H */