hhctrl.ocx: Use document title for subtopics in the index.
[wine] / include / npapi.h
1 /*
2  * Copyright (C) 2004 Juan Lang
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
17  */
18 #ifndef __WINE_NPAPI_H__
19 #define __WINE_NPAPI_H__
20
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24
25 /* capabilities */
26 #define WNNC_SPEC_VERSION          0x00000001
27 #define WNNC_SPEC_VERSION51        0x00050001
28 #define WNNC_NET_TYPE              0x00000002
29 #define WNNC_NET_NONE              0x00000000
30
31 #define WNNC_DRIVER_VERSION        0x00000003
32
33 #define WNNC_USER                  0x00000004
34 #define WNNC_USR_GETUSER           0x00000001
35
36 #define WNNC_CONNECTION            0x00000006
37 #define WNNC_CON_ADDCONNECTION     0x00000001
38 #define WNNC_CON_CANCELCONNECTION  0x00000002
39 #define WNNC_CON_GETCONNECTIONS    0x00000004
40 #define WNNC_CON_ADDCONNECTION3    0x00000008
41 #define WNNC_CON_GETPERFORMANCE    0x00000040
42 #define WNNC_CON_DEFER             0x00000080
43
44 #define WNNC_DIALOG                0x00000008
45 #define WNNC_DLG_DEVICEMODE        0x00000001
46 #define WNNC_DLG_PROPERTYDIALOG    0x00000020
47 #define WNNC_DLG_SEARCHDIALOG      0x00000040
48 #define WNNC_DLG_FORMATNETWORKNAME 0x00000080
49 #define WNNC_DLG_PERMISSIONEDITOR  0x00000100
50 #define WNNC_DLG_GETRESOURCEPARENT 0x00000200
51 #define WNNC_DLG_GETRESOURCEINFORMATION 0x00000800
52
53 #define WNNC_ADMIN                 0x00000009
54 #define WNNC_ADM_GETDIRECTORYTYPE  0x00000001
55 #define WNNC_ADM_DIRECTORYNOTIFY   0x00000002
56
57 #define WNNC_ENUMERATION           0x0000000b
58 #define WNNC_ENUM_GLOBAL           0x00000001
59 #define WNNC_ENUM_LOCAL            0x00000002
60 #define WNNC_ENUM_CONTEXT          0x00000004
61
62 #define WNNC_START                 0x0000000c
63 #define WNNC_WAIT_FOR_START        0x00000001
64
65 typedef DWORD (APIENTRY *PF_NPGetCaps)(DWORD ndex);
66
67 /* get user */
68 typedef DWORD (APIENTRY *PF_NPGetUser)(LPWSTR lpName, LPWSTR lpUserName,
69  LPDWORD lpnBufferLen);
70
71 /* enumeration-related */
72 typedef DWORD (APIENTRY *PF_NPOpenEnum)(DWORD dwScope, DWORD dwType, DWORD dwUsage,
73  LPNETRESOURCEW lpNetResource, LPHANDLE lphEnum);
74 typedef DWORD (APIENTRY *PF_NPEnumResource)(HANDLE hEnum, LPDWORD lpcCount,
75  LPVOID lpBuffer, LPDWORD lpBufferSize);
76 typedef DWORD (APIENTRY *PF_NPCloseEnum)(HANDLE hEnum);
77 typedef DWORD (APIENTRY *PF_NPGetResourceInformation)(LPNETRESOURCEW lpNetResource,
78  LPVOID lpBuffer, LPDWORD lpcbBuffer, LPWSTR* lplpSystem);
79
80 /* connection-related */
81 typedef DWORD (APIENTRY *PF_NPAddConnection)(LPNETRESOURCEW lpNetResource,
82  LPWSTR lpPassword, LPWSTR lpUserName);
83 typedef DWORD (APIENTRY *PF_NPAddConnection3)(HWND hwndOwner,
84  LPNETRESOURCEW lpNetResource, LPWSTR lpPassword, LPWSTR lpUserName,
85  DWORD dwFlags);
86 typedef DWORD (APIENTRY *PF_NPCancelConnection)(LPWSTR lpName, BOOL fForce);
87 typedef DWORD (APIENTRY *PF_NPGetConnection)(LPWSTR lpLocalName,
88  LPWSTR lpRemoteName, LPDWORD lpnBufferLen);
89
90 /* network name manipulation */
91 typedef DWORD (APIENTRY *PF_NPGetUniversalName)(LPWSTR lpLocalPath,
92  DWORD dwInfoLevel, LPVOID lpBuffer, LPDWORD lpnBufferSize);
93 typedef DWORD (APIENTRY *PF_NPFormatNetworkName)(LPWSTR lpRemoteName,
94  LPWSTR lpFormattedName, LPDWORD lpnLength, DWORD dwFlags,
95  DWORD dwAveCharPerLine);
96
97 /* dialogs */
98 typedef DWORD (APIENTRY *PF_NPDeviceMode)(HWND hParent);
99
100 /* search dialog */
101 #define WNSRCH_REFRESH_FIRST_LEVEL 0x00000001
102
103 typedef DWORD (APIENTRY *PF_NPSearchDialog)(HWND hwndParent,
104  LPNETRESOURCEW lpNetResource, LPVOID lpBuffer, DWORD cbBuffer,
105  LPDWORD lpnFlags);
106
107 /* property dialog */
108
109 #define WNTYPE_DRIVE   1
110 #define WNTYPE_FILE    2
111 #define WNTYPE_PRINTER 3
112 #define WNTYPE_COMM    4
113
114 #define WNPS_FILE 0
115 #define WNPS_DIR  1
116 #define WNPS_MULT 2
117
118 typedef DWORD (APIENTRY *PF_NPGetPropertyText)(DWORD iButton, DWORD nPropSel,
119  LPWSTR lpName, LPWSTR lpButtonName, DWORD nButtonNameLen, DWORD nType);
120
121 typedef DWORD (APIENTRY *PF_NPPropertyDialog)(HWND hwndParent, DWORD iButtonDlg,
122  DWORD nPropSel, LPWSTR lpFileName, DWORD nType);
123
124 /* admin */
125 #define WNDT_NORMAL  0
126 #define WNDT_NETWORK 1
127
128 #define WNDN_MKDIR 1
129 #define WNDN_RMDIR 2
130 #define WNDN_MVDIR 3
131
132 typedef DWORD (APIENTRY *PF_NPGetDirectoryType)(LPWSTR lpName, LPINT lpType,
133  BOOL bFlushCache);
134 typedef DWORD (APIENTRY *PF_NPDirectoryNotify)(HWND hwnd, LPWSTR lpDir,
135  DWORD dwOper);
136
137 /* permission editor dialogs */
138 #define WNPERMC_PERM  0x00000001
139 #define WNPERMC_AUDIT 0x00000002
140 #define WNPERMC_OWNER 0x00000004
141
142 typedef DWORD (APIENTRY *PF_NPFMXGetPermCaps)(LPWSTR lpDriveName);
143
144 #define WNPERM_DLG_PERM  0
145 #define WNPERM_DLG_AUDIT 1
146 #define WNPERM_DLG_OWNER 2
147
148 typedef DWORD (APIENTRY *PF_NPFMXEditPerm)(LPWSTR lpDriveName, HWND hwndFMX,
149  DWORD nDialogType);
150
151 typedef DWORD (APIENTRY *PF_NPFMXGetPermHelp)(LPWSTR lpDriveName,
152  DWORD nDialogType, BOOL fDirectory, LPVOID lpFileNameBuffer,
153  LPDWORD lpBufferSize, LPDWORD lpnHelpContext);
154
155 VOID WINAPI WNetSetLastErrorA(DWORD err, LPSTR lpError, LPSTR lpProviders);
156 VOID WINAPI WNetSetLastErrorW(DWORD err, LPWSTR lpError, LPWSTR lpProviders);
157 #define WNetSetLastError WINELIB_NAME_AW(WNetSetLastError)
158
159 /* provider classes */
160 #define WN_NETWORK_CLASS         0x00000001
161 #define WN_CREDENTIAL_CLASS      0x00000002
162 #define WN_PRIMARY_AUTHENT_CLASS 0x00000004
163 #define WN_SERVICE_CLASS         0x00000008
164
165 #define WN_VALID_LOGON_ACCOUNT   0x00000001
166 #define WN_NT_PASSWORD_CHANGED   0x00000002
167
168 /* notifications */
169 typedef DWORD (APIENTRY *PF_NPLogonNotify)(PLUID lpLogonId,
170  LPCWSTR lpAuthentInfoType, LPVOID lpAuthentInfo,
171  LPCWSTR lpPreviousAuthentInfoType, LPVOID lpPreviousAuthentInfo,
172  LPWSTR lpStationName, LPVOID StationHandle, LPWSTR *lpLogonScript);
173 typedef DWORD (APIENTRY *PF_NPPasswordChangeNotify)(LPCWSTR lpAuthentInfoType,
174  LPVOID lpAuthentInfo, LPCWSTR lpPreviousAuthentInfoType,
175  LPVOID lpPreviousAuthentInfo, LPWSTR lpStationName, LPVOID StationHandle,
176  DWORD dwChangeInfo);
177
178 #define NOTIFY_PRE  0x00000001
179 #define NOTIFY_POST 0x00000002
180
181 typedef struct _NOTIFYINFO
182 {
183     DWORD  dwNotifyStatus;
184     DWORD  dwOperationStatus;
185     LPVOID lpContext;
186 } NOTIFYINFO, *LPNOTIFYINFO;
187
188 /* FIXME: NetResource is declared as a NETRESOURCE in psdk, not a NETRESOURCEW,
189  * but how can the type change in a service provider?  Defaulting to wide-char
190  * for consistency with the rest of the api.
191  */
192 typedef struct _NOTIFYADD
193 {
194     HWND         hwndOwner;
195     NETRESOURCEW NetResource;
196     DWORD        dwAddFlags;
197 } NOTIFYADD, *LPNOTIFYADD;
198
199 /* FIXME: lpName and lpProvider are declared as LPTSTRs in psdk, but again
200  * for consistency with rest of api defaulting to LPWSTRs.
201  */
202 typedef struct _NOTIFYCANCEL
203 {
204     LPWSTR lpName;
205     LPWSTR lpProvider;
206     DWORD  dwFlags;
207     BOOL   fForce;
208 } NOTIFYCANCEL, *LPNOTIFYCANCEL;
209
210 typedef DWORD (APIENTRY *PF_AddConnectNotify)(LPNOTIFYINFO lpNotifyInfo,
211  LPNOTIFYADD lpAddInfo);
212 typedef DWORD (APIENTRY *PF_CancelConnectNotify)(LPNOTIFYINFO lpNotifyInfo,
213  LPNOTIFYADD lpAddInfo);
214
215 #ifdef __cplusplus
216 }
217 #endif
218
219 #endif /* ndef __WINE_NPAPI_H__ */