docs: explain where the defaults for these printing parameters comes from
[Samba.git] / source3 / lib / netapi / netapi.h
blobc273ae052d387c1e8aaa531028e76627fa7301f6
1 /*
2 * Unix SMB/CIFS implementation.
3 * NetApi Support
4 * Copyright (C) Guenther Deschner 2007-2009
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
20 #ifndef __LIB_NETAPI_H__
21 #define __LIB_NETAPI_H__
23 #ifdef __cplusplus
24 extern "C" {
25 #endif /* __cplusplus */
27 /****************************************************************
28 NET_API_STATUS
29 ****************************************************************/
30 typedef enum {
31 NET_API_STATUS_SUCCESS = 0
32 } NET_API_STATUS;
34 #define ERROR_MORE_DATA ( 234L )
36 #define ENCRYPTED_PWLEN ( 16 )
38 /****************************************************************
39 ****************************************************************/
41 #ifndef _HEADER_misc
43 struct GUID {
44 uint32_t time_low;
45 uint16_t time_mid;
46 uint16_t time_hi_and_version;
47 uint8_t clock_seq[2];
48 uint8_t node[6];
51 #endif /* _HEADER_misc */
53 #ifndef _HEADER_libnetapi
55 #ifndef MAXSUBAUTHS
56 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
57 #endif
59 struct domsid {
60 uint8_t sid_rev_num;
61 uint8_t num_auths;
62 uint8_t id_auth[6];
63 uint32_t sub_auths[MAXSUBAUTHS];
66 struct DOMAIN_CONTROLLER_INFO {
67 const char * domain_controller_name;
68 const char * domain_controller_address;
69 uint32_t domain_controller_address_type;
70 struct GUID domain_guid;
71 const char * domain_name;
72 const char * dns_forest_name;
73 uint32_t flags;
74 const char * dc_site_name;
75 const char * client_site_name;
78 /* bitmap NetJoinFlags */
79 #define NETSETUP_JOIN_DOMAIN ( 0x00000001 )
80 #define NETSETUP_ACCT_CREATE ( 0x00000002 )
81 #define NETSETUP_ACCT_DELETE ( 0x00000004 )
82 #define NETSETUP_WIN9X_UPGRADE ( 0x00000010 )
83 #define NETSETUP_DOMAIN_JOIN_IF_JOINED ( 0x00000020 )
84 #define NETSETUP_JOIN_UNSECURE ( 0x00000040 )
85 #define NETSETUP_MACHINE_PWD_PASSED ( 0x00000080 )
86 #define NETSETUP_DEFER_SPN_SET ( 0x00000100 )
87 #define NETSETUP_JOIN_DC_ACCOUNT ( 0x00000200 )
88 #define NETSETUP_JOIN_WITH_NEW_NAME ( 0x00000400 )
89 #define NETSETUP_INSTALL_INVOCATION ( 0x00040000 )
90 #define NETSETUP_IGNORE_UNSUPPORTED_FLAGS ( 0x10000000 )
92 #define FILTER_TEMP_DUPLICATE_ACCOUNT ( 0x0001 )
93 #define FILTER_NORMAL_ACCOUNT ( 0x0002 )
94 #define FILTER_INTERDOMAIN_TRUST_ACCOUNT ( 0x0008 )
95 #define FILTER_WORKSTATION_TRUST_ACCOUNT ( 0x0010 )
96 #define FILTER_SERVER_TRUST_ACCOUNT ( 0x0020 )
98 #define TIMEQ_FOREVER ( (uint32_t)-1L )
100 enum NETSETUP_JOIN_STATUS {
101 NetSetupUnknownStatus=0,
102 NetSetupUnjoined=1,
103 NetSetupWorkgroupName=2,
104 NetSetupDomainName=3
107 struct SERVER_INFO_100 {
108 uint32_t sv100_platform_id;
109 const char * sv100_name;
112 struct SERVER_INFO_101 {
113 uint32_t sv101_platform_id;
114 const char * sv101_name;
115 uint32_t sv101_version_major;
116 uint32_t sv101_version_minor;
117 uint32_t sv101_type;
118 const char * sv101_comment;
121 struct SERVER_INFO_102 {
122 uint32_t sv102_platform_id;
123 const char * sv102_name;
124 uint32_t sv102_version_major;
125 uint32_t sv102_version_minor;
126 uint32_t sv102_type;
127 const char * sv102_comment;
128 uint32_t sv102_users;
129 uint32_t sv102_disc;
130 uint8_t sv102_hidden;
131 uint32_t sv102_announce;
132 uint32_t sv102_anndelta;
133 uint32_t sv102_licenses;
134 const char * sv102_userpath;
137 struct SERVER_INFO_402 {
138 uint32_t sv402_ulist_mtime;
139 uint32_t sv402_glist_mtime;
140 uint32_t sv402_alist_mtime;
141 const char * sv402_alerts;
142 uint32_t sv402_security;
143 uint32_t sv402_numadmin;
144 uint32_t sv402_lanmask;
145 const char * sv402_guestacct;
146 uint32_t sv402_chdevs;
147 uint32_t sv402_chdevq;
148 uint32_t sv402_chdevjobs;
149 uint32_t sv402_connections;
150 uint32_t sv402_shares;
151 uint32_t sv402_openfiles;
152 uint32_t sv402_sessopens;
153 uint32_t sv402_sessvcs;
154 uint32_t sv402_sessreqs;
155 uint32_t sv402_opensearch;
156 uint32_t sv402_activelocks;
157 uint32_t sv402_numreqbuf;
158 uint32_t sv402_sizreqbuf;
159 uint32_t sv402_numbigbuf;
160 uint32_t sv402_numfiletasks;
161 uint32_t sv402_alertsched;
162 uint32_t sv402_erroralert;
163 uint32_t sv402_logonalert;
164 uint32_t sv402_accessalert;
165 uint32_t sv402_diskalert;
166 uint32_t sv402_netioalert;
167 uint32_t sv402_maxauditsz;
168 const char * sv402_srvheuristics;
171 struct SERVER_INFO_403 {
172 uint32_t sv403_ulist_mtime;
173 uint32_t sv403_glist_mtime;
174 uint32_t sv403_alist_mtime;
175 const char * sv403_alerts;
176 uint32_t sv403_security;
177 uint32_t sv403_numadmin;
178 uint32_t sv403_lanmask;
179 const char * sv403_guestacct;
180 uint32_t sv403_chdevs;
181 uint32_t sv403_chdevq;
182 uint32_t sv403_chdevjobs;
183 uint32_t sv403_connections;
184 uint32_t sv403_shares;
185 uint32_t sv403_openfiles;
186 uint32_t sv403_sessopens;
187 uint32_t sv403_sessvcs;
188 uint32_t sv403_sessreqs;
189 uint32_t sv403_opensearch;
190 uint32_t sv403_activelocks;
191 uint32_t sv403_numreqbuf;
192 uint32_t sv403_sizreqbuf;
193 uint32_t sv403_numbigbuf;
194 uint32_t sv403_numfiletasks;
195 uint32_t sv403_alertsched;
196 uint32_t sv403_erroralert;
197 uint32_t sv403_logonalert;
198 uint32_t sv403_accessalert;
199 uint32_t sv403_diskalert;
200 uint32_t sv403_netioalert;
201 uint32_t sv403_maxauditsz;
202 const char * sv403_srvheuristics;
203 uint32_t sv403_auditedevents;
204 uint32_t sv403_autoprofile;
205 const char * sv403_autopath;
208 struct SERVER_INFO_502 {
209 uint32_t sv502_sessopens;
210 uint32_t sv502_sessvcs;
211 uint32_t sv502_opensearch;
212 uint32_t sv502_sizreqbuf;
213 uint32_t sv502_initworkitems;
214 uint32_t sv502_maxworkitems;
215 uint32_t sv502_rawworkitems;
216 uint32_t sv502_irpstacksize;
217 uint32_t sv502_maxrawbuflen;
218 uint32_t sv502_sessusers;
219 uint32_t sv502_sessconns;
220 uint32_t sv502_maxpagedmemoryusage;
221 uint32_t sv502_maxnonpagedmemoryusage;
222 uint8_t sv502_enablesoftcompat;
223 uint8_t sv502_enableforcedlogoff;
224 uint8_t sv502_timesource;
225 uint8_t sv502_acceptdownlevelapis;
226 uint8_t sv502_lmannounce;
229 struct SERVER_INFO_503 {
230 uint32_t sv503_sessopens;
231 uint32_t sv503_sessvcs;
232 uint32_t sv503_opensearch;
233 uint32_t sv503_sizreqbuf;
234 uint32_t sv503_initworkitems;
235 uint32_t sv503_maxworkitems;
236 uint32_t sv503_rawworkitems;
237 uint32_t sv503_irpstacksize;
238 uint32_t sv503_maxrawbuflen;
239 uint32_t sv503_sessusers;
240 uint32_t sv503_sessconns;
241 uint32_t sv503_maxpagedmemoryusage;
242 uint32_t sv503_maxnonpagedmemoryusage;
243 uint8_t sv503_enablesoftcompat;
244 uint8_t sv503_enableforcedlogoff;
245 uint8_t sv503_timesource;
246 uint8_t sv503_acceptdownlevelapis;
247 uint8_t sv503_lmannounce;
248 const char * sv503_domain;
249 uint32_t sv503_maxcopyreadlen;
250 uint32_t sv503_maxcopywritelen;
251 uint32_t sv503_minkeepsearch;
252 uint32_t sv503_maxkeepsearch;
253 uint32_t sv503_minkeepcomplsearch;
254 uint32_t sv503_maxkeepcomplsearch;
255 uint32_t sv503_threadcountadd;
256 uint32_t sv503_numblockthreads;
257 uint32_t sv503_scavtimeout;
258 uint32_t sv503_minrcvqueue;
259 uint32_t sv503_minfreeworkitems;
260 uint32_t sv503_xactmemsize;
261 uint32_t sv503_threadpriority;
262 uint32_t sv503_maxmpxct;
263 uint32_t sv503_oplockbreakwait;
264 uint32_t sv503_oplockbreakresponsewait;
265 uint8_t sv503_enableoplocks;
266 uint8_t sv503_enableoplockforceclose;
267 uint8_t sv503_enablefcbopens;
268 uint8_t sv503_enableraw;
269 uint8_t sv503_enablesharednetdrives;
270 uint32_t sv503_minfreeconnections;
271 uint32_t sv503_maxfreeconnections;
274 struct SERVER_INFO_599 {
275 uint32_t sv599_sessopens;
276 uint32_t sv599_sessvcs;
277 uint32_t sv599_opensearch;
278 uint32_t sv599_sizreqbuf;
279 uint32_t sv599_initworkitems;
280 uint32_t sv599_maxworkitems;
281 uint32_t sv599_rawworkitems;
282 uint32_t sv599_irpstacksize;
283 uint32_t sv599_maxrawbuflen;
284 uint32_t sv599_sessusers;
285 uint32_t sv599_sessconns;
286 uint32_t sv599_maxpagedmemoryusage;
287 uint32_t sv599_maxnonpagedmemoryusage;
288 uint8_t sv599_enablesoftcompat;
289 uint8_t sv599_enableforcedlogoff;
290 uint8_t sv599_timesource;
291 uint8_t sv599_acceptdownlevelapis;
292 uint8_t sv599_lmannounce;
293 const char * sv599_domain;
294 uint32_t sv599_maxcopyreadlen;
295 uint32_t sv599_maxcopywritelen;
296 uint32_t sv599_minkeepsearch;
297 uint32_t sv599_maxkeepsearch;
298 uint32_t sv599_minkeepcomplsearch;
299 uint32_t sv599_maxkeepcomplsearch;
300 uint32_t sv599_threadcountadd;
301 uint32_t sv599_numblockthreads;
302 uint32_t sv599_scavtimeout;
303 uint32_t sv599_minrcvqueue;
304 uint32_t sv599_minfreeworkitems;
305 uint32_t sv599_xactmemsize;
306 uint32_t sv599_threadpriority;
307 uint32_t sv599_maxmpxct;
308 uint32_t sv599_oplockbreakwait;
309 uint32_t sv599_oplockbreakresponsewait;
310 uint8_t sv599_enableoplocks;
311 uint8_t sv599_enableoplockforceclose;
312 uint8_t sv599_enablefcbopens;
313 uint8_t sv599_enableraw;
314 uint8_t sv599_enablesharednetdrives;
315 uint32_t sv599_minfreeconnections;
316 uint32_t sv599_maxfreeconnections;
317 uint32_t sv599_initsesstable;
318 uint32_t sv599_initconntable;
319 uint32_t sv599_initfiletable;
320 uint32_t sv599_initsearchtable;
321 uint32_t sv599_alertschedule;
322 uint32_t sv599_errorthreshold;
323 uint32_t sv599_networkerrorthreshold;
324 uint32_t sv599_diskspacethreshold;
325 uint32_t sv599_reserved;
326 uint32_t sv599_maxlinkdelay;
327 uint32_t sv599_minlinkthroughput;
328 uint32_t sv599_linkinfovalidtime;
329 uint32_t sv599_scavqosinfoupdatetime;
330 uint32_t sv599_maxworkitemidletime;
333 struct SERVER_INFO_598 {
334 uint32_t sv598_maxrawworkitems;
335 uint32_t sv598_maxthreadsperqueue;
336 uint32_t sv598_producttype;
337 uint32_t sv598_serversize;
338 uint32_t sv598_connectionlessautodisc;
339 uint32_t sv598_sharingviolationretries;
340 uint32_t sv598_sharingviolationdelay;
341 uint32_t sv598_maxglobalopensearch;
342 uint32_t sv598_removeduplicatesearches;
343 uint32_t sv598_lockviolationoffset;
344 uint32_t sv598_lockviolationdelay;
345 uint32_t sv598_mdlreadswitchover;
346 uint32_t sv598_cachedopenlimit;
347 uint32_t sv598_otherqueueaffinity;
348 uint8_t sv598_restrictnullsessaccess;
349 uint8_t sv598_enablewfw311directipx;
350 uint32_t sv598_queuesamplesecs;
351 uint32_t sv598_balancecount;
352 uint32_t sv598_preferredaffinity;
353 uint32_t sv598_maxfreerfcbs;
354 uint32_t sv598_maxfreemfcbs;
355 uint32_t sv598_maxfreelfcbs;
356 uint32_t sv598_maxfreepagedpoolchunks;
357 uint32_t sv598_minpagedpoolchunksize;
358 uint32_t sv598_maxpagedpoolchunksize;
359 uint8_t sv598_sendsfrompreferredprocessor;
360 uint32_t sv598_cacheddirectorylimit;
361 uint32_t sv598_maxcopylength;
362 uint8_t sv598_enablecompression;
363 uint8_t sv598_autosharewks;
364 uint8_t sv598_autoshareserver;
365 uint8_t sv598_enablesecuritysignature;
366 uint8_t sv598_requiresecuritysignature;
367 uint32_t sv598_minclientbuffersize;
368 struct GUID sv598_serverguid;
369 uint32_t sv598_ConnectionNoSessionsTimeout;
370 uint32_t sv598_IdleThreadTimeOut;
371 uint8_t sv598_enableW9xsecuritysignature;
372 uint8_t sv598_enforcekerberosreauthentication;
373 uint8_t sv598_disabledos;
374 uint32_t sv598_lowdiskspaceminimum;
375 uint8_t sv598_disablestrictnamechecking;
378 struct SERVER_INFO_1005 {
379 const char * sv1005_comment;
382 struct SERVER_INFO_1107 {
383 uint32_t sv1107_users;
386 struct SERVER_INFO_1010 {
387 int32_t sv1010_disc;
390 struct SERVER_INFO_1016 {
391 uint8_t sv1016_hidden;
394 struct SERVER_INFO_1017 {
395 uint32_t sv1017_announce;
398 struct SERVER_INFO_1018 {
399 uint32_t sv1018_anndelta;
402 struct SERVER_INFO_1501 {
403 uint32_t sv1501_sessopens;
406 struct SERVER_INFO_1502 {
407 uint32_t sv1502_sessvcs;
410 struct SERVER_INFO_1503 {
411 uint32_t sv1503_opensearch;
414 struct SERVER_INFO_1506 {
415 uint32_t sv1506_maxworkitems;
418 struct SERVER_INFO_1509 {
419 uint32_t sv1509_maxrawbuflen;
422 struct SERVER_INFO_1510 {
423 uint32_t sv1510_sessusers;
426 struct SERVER_INFO_1511 {
427 uint32_t sv1511_sessconns;
430 struct SERVER_INFO_1512 {
431 uint32_t sv1512_maxnonpagedmemoryusage;
434 struct SERVER_INFO_1513 {
435 uint32_t sv1513_maxpagedmemoryusage;
438 struct SERVER_INFO_1514 {
439 uint8_t sv1514_enablesoftcompat;
442 struct SERVER_INFO_1515 {
443 uint8_t sv1515_enableforcedlogoff;
446 struct SERVER_INFO_1516 {
447 uint8_t sv1516_timesource;
450 struct SERVER_INFO_1518 {
451 uint8_t sv1518_lmannounce;
454 struct SERVER_INFO_1520 {
455 uint32_t sv1520_maxcopyreadlen;
458 struct SERVER_INFO_1521 {
459 uint32_t sv1521_maxcopywritelen;
462 struct SERVER_INFO_1522 {
463 uint32_t sv1522_minkeepsearch;
466 struct SERVER_INFO_1523 {
467 uint32_t sv1523_maxkeepsearch;
470 struct SERVER_INFO_1524 {
471 uint32_t sv1524_minkeepcomplsearch;
474 struct SERVER_INFO_1525 {
475 uint32_t sv1525_maxkeepcomplsearch;
478 struct SERVER_INFO_1528 {
479 uint32_t sv1528_scavtimeout;
482 struct SERVER_INFO_1529 {
483 uint32_t sv1529_minrcvqueue;
486 struct SERVER_INFO_1530 {
487 uint32_t sv1530_minfreeworkitems;
490 struct SERVER_INFO_1533 {
491 uint32_t sv1533_maxmpxct;
494 struct SERVER_INFO_1534 {
495 uint32_t sv1534_oplockbreakwait;
498 struct SERVER_INFO_1535 {
499 uint32_t sv1535_oplockbreakresponsewait;
502 struct SERVER_INFO_1536 {
503 uint8_t sv1536_enableoplocks;
506 struct SERVER_INFO_1537 {
507 uint8_t sv1537_enableoplockforceclose;
510 struct SERVER_INFO_1538 {
511 uint8_t sv1538_enablefcbopens;
514 struct SERVER_INFO_1539 {
515 uint8_t sv1539_enableraw;
518 struct SERVER_INFO_1540 {
519 uint8_t sv1540_enablesharednetdrives;
522 struct SERVER_INFO_1541 {
523 uint8_t sv1541_minfreeconnections;
526 struct SERVER_INFO_1542 {
527 uint8_t sv1542_maxfreeconnections;
530 struct SERVER_INFO_1543 {
531 uint32_t sv1543_initsesstable;
534 struct SERVER_INFO_1544 {
535 uint32_t sv1544_initconntable;
538 struct SERVER_INFO_1545 {
539 uint32_t sv1545_initfiletable;
542 struct SERVER_INFO_1546 {
543 uint32_t sv1546_initsearchtable;
546 struct SERVER_INFO_1547 {
547 uint32_t sv1547_alertschedule;
550 struct SERVER_INFO_1548 {
551 uint32_t sv1548_errorthreshold;
554 struct SERVER_INFO_1549 {
555 uint32_t sv1549_networkerrorthreshold;
558 struct SERVER_INFO_1550 {
559 uint32_t sv1550_diskspacethreshold;
562 struct SERVER_INFO_1552 {
563 uint32_t sv1552_maxlinkdelay;
566 struct SERVER_INFO_1553 {
567 uint32_t sv1553_minlinkthroughput;
570 struct SERVER_INFO_1554 {
571 uint32_t sv1554_linkinfovalidtime;
574 struct SERVER_INFO_1555 {
575 uint32_t sv1555_scavqosinfoupdatetime;
578 struct SERVER_INFO_1556 {
579 uint32_t sv1556_maxworkitemidletime;
582 struct SERVER_INFO_1557 {
583 uint32_t sv1557_maxrawworkitems;
586 struct SERVER_INFO_1560 {
587 uint32_t sv1560_producttype;
590 struct SERVER_INFO_1561 {
591 uint32_t sv1561_serversize;
594 struct SERVER_INFO_1562 {
595 uint32_t sv1562_connectionlessautodisc;
598 struct SERVER_INFO_1563 {
599 uint32_t sv1563_sharingviolationretries;
602 struct SERVER_INFO_1564 {
603 uint32_t sv1564_sharingviolationdelay;
606 struct SERVER_INFO_1565 {
607 uint32_t sv1565_maxglobalopensearch;
610 struct SERVER_INFO_1566 {
611 uint8_t sv1566_removeduplicatesearches;
614 struct SERVER_INFO_1567 {
615 uint32_t sv1567_lockviolationretries;
618 struct SERVER_INFO_1568 {
619 uint32_t sv1568_lockviolationoffset;
622 struct SERVER_INFO_1569 {
623 uint32_t sv1569_lockviolationdelay;
626 struct SERVER_INFO_1570 {
627 uint32_t sv1570_mdlreadswitchover;
630 struct SERVER_INFO_1571 {
631 uint32_t sv1571_cachedopenlimit;
634 struct SERVER_INFO_1572 {
635 uint32_t sv1572_criticalthreads;
638 struct SERVER_INFO_1573 {
639 uint32_t sv1573_restrictnullsessaccess;
642 struct SERVER_INFO_1574 {
643 uint32_t sv1574_enablewfw311directipx;
646 struct SERVER_INFO_1575 {
647 uint32_t sv1575_otherqueueaffinity;
650 struct SERVER_INFO_1576 {
651 uint32_t sv1576_queuesamplesecs;
654 struct SERVER_INFO_1577 {
655 uint32_t sv1577_balancecount;
658 struct SERVER_INFO_1578 {
659 uint32_t sv1578_preferredaffinity;
662 struct SERVER_INFO_1579 {
663 uint32_t sv1579_maxfreerfcbs;
666 struct SERVER_INFO_1580 {
667 uint32_t sv1580_maxfreemfcbs;
670 struct SERVER_INFO_1581 {
671 uint32_t sv1581_maxfreemlcbs;
674 struct SERVER_INFO_1582 {
675 uint32_t sv1582_maxfreepagedpoolchunks;
678 struct SERVER_INFO_1583 {
679 uint32_t sv1583_minpagedpoolchunksize;
682 struct SERVER_INFO_1584 {
683 uint32_t sv1584_maxpagedpoolchunksize;
686 struct SERVER_INFO_1585 {
687 uint8_t sv1585_sendsfrompreferredprocessor;
690 struct SERVER_INFO_1586 {
691 uint32_t sv1586_maxthreadsperqueue;
694 struct SERVER_INFO_1587 {
695 uint32_t sv1587_cacheddirectorylimit;
698 struct SERVER_INFO_1588 {
699 uint32_t sv1588_maxcopylength;
702 struct SERVER_INFO_1590 {
703 uint32_t sv1590_enablecompression;
706 struct SERVER_INFO_1591 {
707 uint32_t sv1591_autosharewks;
710 struct SERVER_INFO_1592 {
711 uint32_t sv1592_autosharewks;
714 struct SERVER_INFO_1593 {
715 uint32_t sv1593_enablesecuritysignature;
718 struct SERVER_INFO_1594 {
719 uint32_t sv1594_requiresecuritysignature;
722 struct SERVER_INFO_1595 {
723 uint32_t sv1595_minclientbuffersize;
726 struct SERVER_INFO_1596 {
727 uint32_t sv1596_ConnectionNoSessionsTimeout;
730 struct SERVER_INFO_1597 {
731 uint32_t sv1597_IdleThreadTimeOut;
734 struct SERVER_INFO_1598 {
735 uint32_t sv1598_enableW9xsecuritysignature;
738 struct SERVER_INFO_1599 {
739 uint8_t sv1598_enforcekerberosreauthentication;
742 struct SERVER_INFO_1600 {
743 uint8_t sv1598_disabledos;
746 struct SERVER_INFO_1601 {
747 uint32_t sv1598_lowdiskspaceminimum;
750 struct SERVER_INFO_1602 {
751 uint8_t sv_1598_disablestrictnamechecking;
754 struct USER_INFO_0 {
755 const char * usri0_name;
758 #define USER_PRIV_GUEST ( 0 )
759 #define USER_PRIV_USER ( 1 )
760 #define USER_PRIV_ADMIN ( 2 )
762 struct USER_INFO_1 {
763 const char * usri1_name;
764 const char * usri1_password;
765 uint32_t usri1_password_age;
766 uint32_t usri1_priv;
767 const char * usri1_home_dir;
768 const char * usri1_comment;
769 uint32_t usri1_flags;
770 const char * usri1_script_path;
773 #define AF_OP_PRINT ( 0x1 )
774 #define AF_OP_COMM ( 0x2 )
775 #define AF_OP_SERVER ( 0x4 )
776 #define AF_OP_ACCOUNTS ( 0x8 )
778 struct USER_INFO_2 {
779 const char * usri2_name;
780 const char * usri2_password;
781 uint32_t usri2_password_age;
782 uint32_t usri2_priv;
783 const char * usri2_home_dir;
784 const char * usri2_comment;
785 uint32_t usri2_flags;
786 const char * usri2_script_path;
787 uint32_t usri2_auth_flags;
788 const char * usri2_full_name;
789 const char * usri2_usr_comment;
790 const char * usri2_parms;
791 const char * usri2_workstations;
792 uint32_t usri2_last_logon;
793 uint32_t usri2_last_logoff;
794 uint32_t usri2_acct_expires;
795 uint32_t usri2_max_storage;
796 uint32_t usri2_units_per_week;
797 uint8_t *usri2_logon_hours;/* [unique] */
798 uint32_t usri2_bad_pw_count;
799 uint32_t usri2_num_logons;
800 const char * usri2_logon_server;
801 uint32_t usri2_country_code;
802 uint32_t usri2_code_page;
805 struct USER_INFO_3 {
806 const char * usri3_name;
807 uint32_t usri3_password_age;
808 uint32_t usri3_priv;
809 const char * usri3_home_dir;
810 const char * usri3_comment;
811 uint32_t usri3_flags;
812 const char * usri3_script_path;
813 uint32_t usri3_auth_flags;
814 const char * usri3_full_name;
815 const char * usri3_usr_comment;
816 const char * usri3_parms;
817 const char * usri3_workstations;
818 uint32_t usri3_last_logon;
819 uint32_t usri3_last_logoff;
820 uint32_t usri3_acct_expires;
821 uint32_t usri3_max_storage;
822 uint32_t usri3_units_per_week;
823 uint8_t *usri3_logon_hours;/* [unique] */
824 uint32_t usri3_bad_pw_count;
825 uint32_t usri3_num_logons;
826 const char * usri3_logon_server;
827 uint32_t usri3_country_code;
828 uint32_t usri3_code_page;
829 uint32_t usri3_user_id;
830 uint32_t usri3_primary_group_id;
831 const char * usri3_profile;
832 const char * usri3_home_dir_drive;
833 uint32_t usri3_password_expired;
836 struct USER_INFO_4 {
837 const char * usri4_name;
838 const char * usri4_password;
839 uint32_t usri4_password_age;
840 uint32_t usri4_priv;
841 const char * usri4_home_dir;
842 const char * usri4_comment;
843 uint32_t usri4_flags;
844 const char * usri4_script_path;
845 uint32_t usri4_auth_flags;
846 const char * usri4_full_name;
847 const char * usri4_usr_comment;
848 const char * usri4_parms;
849 const char * usri4_workstations;
850 uint32_t usri4_last_logon;
851 uint32_t usri4_last_logoff;
852 uint32_t usri4_acct_expires;
853 uint32_t usri4_max_storage;
854 uint32_t usri4_units_per_week;
855 uint8_t *usri4_logon_hours;/* [unique] */
856 uint32_t usri4_bad_pw_count;
857 uint32_t usri4_num_logons;
858 const char * usri4_logon_server;
859 uint32_t usri4_country_code;
860 uint32_t usri4_code_page;
861 struct domsid *usri4_user_sid;/* [unique] */
862 uint32_t usri4_primary_group_id;
863 const char * usri4_profile;
864 const char * usri4_home_dir_drive;
865 uint32_t usri4_password_expired;
868 struct USER_INFO_10 {
869 const char * usri10_name;
870 const char * usri10_comment;
871 const char * usri10_usr_comment;
872 const char * usri10_full_name;
875 struct USER_INFO_11 {
876 const char * usri11_name;
877 const char * usri11_comment;
878 const char * usri11_usr_comment;
879 const char * usri11_full_name;
880 uint32_t usri11_priv;
881 uint32_t usri11_auth_flags;
882 uint32_t usri11_password_age;
883 const char * usri11_home_dir;
884 const char * usri11_parms;
885 uint32_t usri11_last_logon;
886 uint32_t usri11_last_logoff;
887 uint32_t usri11_bad_pw_count;
888 uint32_t usri11_num_logons;
889 const char * usri11_logon_server;
890 uint32_t usri11_country_code;
891 const char * usri11_workstations;
892 uint32_t usri11_max_storage;
893 uint32_t usri11_units_per_week;
894 uint8_t *usri11_logon_hours;/* [unique] */
895 uint32_t usri11_code_page;
898 struct USER_INFO_20 {
899 const char * usri20_name;
900 const char * usri20_full_name;
901 const char * usri20_comment;
902 uint32_t usri20_flags;
903 uint32_t usri20_user_id;
906 struct USER_INFO_21 {
907 uint8_t *usri21_password;
910 struct USER_INFO_22 {
911 const char * usri22_name;
912 uint8_t *usri22_password;
913 uint32_t usri22_password_age;
914 uint32_t usri22_priv;
915 const char * usri22_home_dir;
916 const char * usri22_comment;
917 uint32_t usri22_flags;
918 uint32_t usri22_script_path;
919 uint32_t usri22_auth_flags;
920 const char * usri22_full_name;
921 const char * usri22_usr_comment;
922 const char * usri22_parms;
923 const char * usri22_workstations;
924 uint32_t usri22_last_logon;
925 uint32_t usri22_last_logoff;
926 uint32_t usri22_acct_expires;
927 uint32_t usri22_max_storage;
928 uint32_t usri22_units_per_week;
929 uint8_t *usri22_logon_hours;/* [unique] */
930 uint32_t usri22_bad_pw_count;
931 uint32_t usri22_num_logons;
932 const char * usri22_logon_server;
933 uint32_t usri22_country_code;
934 uint32_t usri22_code_page;
937 struct USER_INFO_23 {
938 const char * usri23_name;
939 const char * usri23_full_name;
940 const char * usri23_comment;
941 uint32_t usri23_flags;
942 struct domsid *usri23_user_sid;/* [unique] */
945 struct USER_INFO_1003 {
946 const char * usri1003_password;
949 struct USER_INFO_1005 {
950 uint32_t usri1005_priv;
953 struct USER_INFO_1006 {
954 const char * usri1006_home_dir;
957 struct USER_INFO_1007 {
958 const char * usri1007_comment;
961 struct USER_INFO_1008 {
962 uint32_t usri1008_flags;
965 struct USER_INFO_1009 {
966 const char * usri1009_script_path;
969 struct USER_INFO_1010 {
970 uint32_t usri1010_auth_flags;
973 struct USER_INFO_1011 {
974 const char * usri1011_full_name;
977 struct USER_INFO_1012 {
978 const char * usri1012_usr_comment;
981 struct USER_INFO_1013 {
982 const char * usri1013_parms;
985 struct USER_INFO_1014 {
986 const char * usri1014_workstations;
989 struct USER_INFO_1017 {
990 uint32_t usri1017_acct_expires;
993 struct USER_INFO_1018 {
994 uint32_t usri1018_max_storage;
997 struct USER_INFO_1020 {
998 uint32_t usri1020_units_per_week;
999 uint8_t *usri1020_logon_hours;/* [unique] */
1002 struct USER_INFO_1023 {
1003 const char * usri1023_logon_server;
1006 struct USER_INFO_1024 {
1007 uint32_t usri1024_country_code;
1010 struct USER_INFO_1025 {
1011 uint32_t usri1025_code_page;
1014 struct USER_INFO_1051 {
1015 uint32_t usri1051_primary_group_id;
1018 struct USER_INFO_1052 {
1019 const char * usri1052_profile;
1022 struct USER_INFO_1053 {
1023 const char * usri1053_home_dir_drive;
1026 struct USER_MODALS_INFO_0 {
1027 uint32_t usrmod0_min_passwd_len;
1028 uint32_t usrmod0_max_passwd_age;
1029 uint32_t usrmod0_min_passwd_age;
1030 uint32_t usrmod0_force_logoff;
1031 uint32_t usrmod0_password_hist_len;
1034 struct USER_MODALS_INFO_1 {
1035 uint32_t usrmod1_role;
1036 const char * usrmod1_primary;
1039 struct USER_MODALS_INFO_2 {
1040 const char * usrmod2_domain_name;
1041 struct domsid *usrmod2_domain_id;/* [unique] */
1044 struct USER_MODALS_INFO_3 {
1045 uint32_t usrmod3_lockout_duration;
1046 uint32_t usrmod3_lockout_observation_window;
1047 uint32_t usrmod3_lockout_threshold;
1050 struct USER_MODALS_INFO_1001 {
1051 uint32_t usrmod1001_min_passwd_len;
1054 struct USER_MODALS_INFO_1002 {
1055 uint32_t usrmod1002_max_passwd_age;
1058 struct USER_MODALS_INFO_1003 {
1059 uint32_t usrmod1003_min_passwd_age;
1062 struct USER_MODALS_INFO_1004 {
1063 uint32_t usrmod1004_force_logoff;
1066 struct USER_MODALS_INFO_1005 {
1067 uint32_t usrmod1005_password_hist_len;
1070 struct USER_MODALS_INFO_1006 {
1071 uint32_t usrmod1006_role;
1074 struct USER_MODALS_INFO_1007 {
1075 const char * usrmod1007_primary;
1078 struct NET_DISPLAY_USER {
1079 const char * usri1_name;
1080 const char * usri1_comment;
1081 uint32_t usri1_flags;
1082 const char * usri1_full_name;
1083 uint32_t usri1_user_id;
1084 uint32_t usri1_next_index;
1087 struct NET_DISPLAY_MACHINE {
1088 const char * usri2_name;
1089 const char * usri2_comment;
1090 uint32_t usri2_flags;
1091 uint32_t usri2_user_id;
1092 uint32_t usri2_next_index;
1095 struct NET_DISPLAY_GROUP {
1096 const char * grpi3_name;
1097 const char * grpi3_comment;
1098 uint32_t grpi3_group_id;
1099 uint32_t grpi3_attributes;
1100 uint32_t grpi3_next_index;
1103 struct GROUP_INFO_0 {
1104 const char * grpi0_name;
1107 struct GROUP_INFO_1 {
1108 const char * grpi1_name;
1109 const char * grpi1_comment;
1112 struct GROUP_INFO_2 {
1113 const char * grpi2_name;
1114 const char * grpi2_comment;
1115 uint32_t grpi2_group_id;
1116 uint32_t grpi2_attributes;
1119 struct GROUP_INFO_3 {
1120 const char * grpi3_name;
1121 const char * grpi3_comment;
1122 struct domsid * grpi3_group_sid;
1123 uint32_t grpi3_attributes;
1126 struct GROUP_INFO_1002 {
1127 const char * grpi1002_comment;
1130 struct GROUP_INFO_1005 {
1131 uint32_t grpi1005_attributes;
1134 struct GROUP_USERS_INFO_0 {
1135 const char * grui0_name;
1138 struct GROUP_USERS_INFO_1 {
1139 const char * grui1_name;
1140 uint32_t grui1_attributes;
1143 struct LOCALGROUP_INFO_0 {
1144 const char * lgrpi0_name;
1147 struct LOCALGROUP_INFO_1 {
1148 const char * lgrpi1_name;
1149 const char * lgrpi1_comment;
1152 struct LOCALGROUP_INFO_1002 {
1153 const char * lgrpi1002_comment;
1156 enum SID_NAME_USE {
1157 SidTypeUser=1,
1158 SidTypeGroup=2,
1159 SidTypeDomain=3,
1160 SidTypeAlias=4,
1161 SidTypeWellKnownGroup=5,
1162 SidTypeDeletedAccount=6,
1163 SidTypeInvalid=7,
1164 SidTypeUnknown=8,
1165 SidTypeComputer=9,
1166 SidTypeLabel=10
1169 struct LOCALGROUP_MEMBERS_INFO_0 {
1170 struct domsid *lgrmi0_sid;/* [unique] */
1173 struct LOCALGROUP_MEMBERS_INFO_1 {
1174 struct domsid *lgrmi1_sid;/* [unique] */
1175 enum SID_NAME_USE lgrmi1_sidusage;
1176 const char * lgrmi1_name;
1179 struct LOCALGROUP_MEMBERS_INFO_2 {
1180 struct domsid *lgrmi2_sid;/* [unique] */
1181 enum SID_NAME_USE lgrmi2_sidusage;
1182 const char * lgrmi2_domainandname;
1185 struct LOCALGROUP_MEMBERS_INFO_3 {
1186 const char * lgrmi3_domainandname;
1189 struct LOCALGROUP_USERS_INFO_0 {
1190 const char * lgrui0_name;
1193 struct TIME_OF_DAY_INFO {
1194 uint32_t tod_elapsedt;
1195 uint32_t tod_msecs;
1196 uint32_t tod_hours;
1197 uint32_t tod_mins;
1198 uint32_t tod_secs;
1199 uint32_t tod_hunds;
1200 int32_t tod_timezone;
1201 uint32_t tod_tinterval;
1202 uint32_t tod_day;
1203 uint32_t tod_month;
1204 uint32_t tod_year;
1205 uint32_t tod_weekday;
1208 struct SHARE_INFO_0 {
1209 const char * shi0_netname;
1212 struct SHARE_INFO_1 {
1213 const char * shi1_netname;
1214 uint32_t shi1_type;
1215 const char * shi1_remark;
1218 struct SHARE_INFO_2 {
1219 const char * shi2_netname;
1220 uint32_t shi2_type;
1221 const char * shi2_remark;
1222 uint32_t shi2_permissions;
1223 uint32_t shi2_max_uses;
1224 uint32_t shi2_current_uses;
1225 const char * shi2_path;
1226 const char * shi2_passwd;
1229 struct SHARE_INFO_501 {
1230 const char * shi501_netname;
1231 uint32_t shi501_type;
1232 const char * shi501_remark;
1233 uint32_t shi501_flags;
1236 struct SHARE_INFO_502 {
1237 const char * shi502_netname;
1238 uint32_t shi502_type;
1239 const char * shi502_remark;
1240 uint32_t shi502_permissions;
1241 uint32_t shi502_max_uses;
1242 uint32_t shi502_current_uses;
1243 const char * shi502_path;
1244 const char * shi502_passwd;
1245 uint32_t shi502_reserved;
1246 struct security_descriptor * shi502_security_descriptor;
1249 struct SHARE_INFO_1004 {
1250 const char * shi1004_remark;
1253 struct SHARE_INFO_1005 {
1254 uint32_t shi1005_flags;
1257 struct SHARE_INFO_1006 {
1258 uint32_t shi1006_max_uses;
1261 struct FILE_INFO_2 {
1262 uint32_t fi2_id;
1265 struct FILE_INFO_3 {
1266 uint32_t fi3_id;
1267 uint32_t fi3_permissions;
1268 uint32_t fi3_num_locks;
1269 const char * fi3_pathname;
1270 const char * fi3_username;
1273 struct NETLOGON_INFO_1 {
1274 uint32_t netlog1_flags;
1275 NET_API_STATUS netlog1_pdc_connection_status;
1278 struct NETLOGON_INFO_2 {
1279 uint32_t netlog2_flags;
1280 NET_API_STATUS netlog2_pdc_connection_status;
1281 const char * netlog2_trusted_dc_name;
1282 NET_API_STATUS netlog2_tc_connection_status;
1285 struct NETLOGON_INFO_3 {
1286 uint32_t netlog1_flags;
1287 uint32_t netlog3_logon_attempts;
1288 uint32_t netlog3_reserved1;
1289 uint32_t netlog3_reserved2;
1290 uint32_t netlog3_reserved3;
1291 uint32_t netlog3_reserved4;
1292 uint32_t netlog3_reserved5;
1295 struct NETLOGON_INFO_4 {
1296 const char * netlog4_trusted_dc_name;
1297 const char * netlog4_trusted_domain_name;
1300 #define DS_PDC_FLAG ( 0x00000001 )
1301 #define DS_GC_FLAG ( 0x00000004 )
1302 #define DS_LDAP_FLAG ( 0x00000008 )
1303 #define DS_DS_FLAG ( 0x00000010 )
1304 #define DS_KDC_FLAG ( 0x00000020 )
1305 #define DS_TIMESERV_FLAG ( 0x00000040 )
1306 #define DS_CLOSEST_FLAG ( 0x00000080 )
1307 #define DS_WRITABLE_FLAG ( 0x00000100 )
1308 #define DS_GOOD_TIMESERV_FLAG ( 0x00000200 )
1309 #define DS_NDNC_FLAG ( 0x00000400 )
1310 #define DS_SELECT_SECRET_DOMAIN_6_FLAG ( 0x00000800 )
1311 #define DS_FULL_SECRET_DOMAIN_6_FLAG ( 0x00001000 )
1312 #define DS_DNS_CONTROLLER_FLAG ( 0x20000000 )
1313 #define DS_DNS_DOMAIN_FLAG ( 0x40000000 )
1314 #define DS_DNS_FOREST_FLAG ( 0x80000000 )
1316 #endif /* _HEADER_libnetapi */
1318 #ifndef _HEADER_netlogon
1320 #define NETLOGON_CONTROL_QUERY ( 0x00000001 )
1321 #define NETLOGON_CONTROL_REPLICATE ( 0x00000002 )
1322 #define NETLOGON_CONTROL_SYNCHRONIZE ( 0x00000003 )
1323 #define NETLOGON_CONTROL_PDC_REPLICATE ( 0x00000004 )
1324 #define NETLOGON_CONTROL_REDISCOVER ( 0x00000005 )
1325 #define NETLOGON_CONTROL_TC_QUERY ( 0x00000006 )
1326 #define NETLOGON_CONTROL_TRANSPORT_NOTIFY ( 0x00000007 )
1327 #define NETLOGON_CONTROL_FIND_USER ( 0x00000008 )
1328 #define NETLOGON_CONTROL_CHANGE_PASSWORD ( 0x00000009 )
1329 #define NETLOGON_CONTROL_TC_VERIFY ( 0x0000000A )
1330 #define NETLOGON_CONTROL_FORCE_DNS_REG ( 0x0000000B )
1331 #define NETLOGON_CONTROL_QUERY_DNS_REG ( 0x0000000C )
1332 #define NETLOGON_CONTROL_BACKUP_CHANGE_LOG ( 0x0000FFFC )
1333 #define NETLOGON_CONTROL_TRUNCATE_LOG ( 0x0000FFFD )
1334 #define NETLOGON_CONTROL_SET_DBFLAG ( 0x0000FFFE )
1335 #define NETLOGON_CONTROL_BREAKPOINT ( 0x0000FFFF )
1337 #define DS_FORCE_REDISCOVERY ( 0x00000001 )
1338 #define DS_DIRECTORY_SERVICE_REQUIRED ( 0x00000010 )
1339 #define DS_DIRECTORY_SERVICE_PREFERRED ( 0x00000020 )
1340 #define DS_GC_SERVER_REQUIRED ( 0x00000040 )
1341 #define DS_PDC_REQUIRED ( 0x00000080 )
1342 #define DS_BACKGROUND_ONLY ( 0x00000100 )
1343 #define DS_IP_REQUIRED ( 0x00000200 )
1344 #define DS_KDC_REQUIRED ( 0x00000400 )
1345 #define DS_TIMESERV_REQUIRED ( 0x00000800 )
1346 #define DS_WRITABLE_REQUIRED ( 0x00001000 )
1347 #define DS_GOOD_TIMESERV_PREFERRED ( 0x00002000 )
1348 #define DS_AVOID_SELF ( 0x00004000 )
1349 #define DS_ONLY_LDAP_NEEDED ( 0x00008000 )
1350 #define DS_IS_FLAT_NAME ( 0x00010000 )
1351 #define DS_IS_DNS_NAME ( 0x00020000 )
1352 #define DS_TRY_NEXTCLOSEST_SITE ( 0x00040000 )
1353 #define DS_DIRECTORY_SERVICE_6_REQUIRED ( 0x00080000 )
1354 #define DS_WEB_SERVICE_REQUIRED ( 0x00100000 )
1355 #define DS_RETURN_DNS_NAME ( 0x40000000 )
1356 #define DS_RETURN_FLAT_NAME ( 0x80000000 )
1358 #endif /* _HEADER_netlogon */
1360 /****************************************************************
1361 ****************************************************************/
1363 struct libnetapi_ctx {
1364 char *debuglevel;
1365 char *error_string;
1366 char *username;
1367 char *workgroup;
1368 char *password;
1369 char *krb5_cc_env;
1370 int use_kerberos;
1371 int use_ccache;
1372 int disable_policy_handle_cache;
1374 void *private_data;
1377 /****************************************************************
1378 ****************************************************************/
1380 NET_API_STATUS libnetapi_init(struct libnetapi_ctx **ctx);
1382 /****************************************************************
1383 ****************************************************************/
1385 NET_API_STATUS libnetapi_free(struct libnetapi_ctx *ctx);
1387 /****************************************************************
1388 ****************************************************************/
1390 NET_API_STATUS libnetapi_getctx(struct libnetapi_ctx **ctx);
1392 /****************************************************************
1393 ****************************************************************/
1395 NET_API_STATUS libnetapi_set_debuglevel(struct libnetapi_ctx *ctx,
1396 const char *debuglevel);
1398 /****************************************************************
1399 ****************************************************************/
1401 NET_API_STATUS libnetapi_set_username(struct libnetapi_ctx *ctx,
1402 const char *username);
1404 /****************************************************************
1405 ****************************************************************/
1407 NET_API_STATUS libnetapi_set_password(struct libnetapi_ctx *ctx,
1408 const char *password);
1410 /****************************************************************
1411 ****************************************************************/
1413 NET_API_STATUS libnetapi_set_workgroup(struct libnetapi_ctx *ctx,
1414 const char *workgroup);
1416 /****************************************************************
1417 ****************************************************************/
1419 NET_API_STATUS libnetapi_set_use_kerberos(struct libnetapi_ctx *ctx);
1421 /****************************************************************
1422 ****************************************************************/
1424 NET_API_STATUS libnetapi_set_use_ccache(struct libnetapi_ctx *ctx);
1426 /****************************************************************
1427 Return a specific libnetapi error as a string, caller must free with NetApiBufferFree
1428 ****************************************************************/
1430 char *libnetapi_errstr(NET_API_STATUS status);
1432 /****************************************************************
1433 Return the last libnetapi error as a string, caller must free with NetApiBufferFree
1434 ctx is optional
1435 ****************************************************************/
1437 char *libnetapi_get_error_string(struct libnetapi_ctx *ctx,
1438 NET_API_STATUS status);
1440 /****************************************************************
1441 NetApiBufferAllocate
1442 ****************************************************************/
1444 NET_API_STATUS NetApiBufferAllocate(uint32_t byte_count,
1445 void **buffer);
1447 /****************************************************************
1448 NetApiBufferFree
1449 ****************************************************************/
1451 NET_API_STATUS NetApiBufferFree(void *buffer);
1453 /************************************************************//**
1455 * ConvertSidToStringSid
1457 * @brief Convert a domain sid into a string
1459 * @param[in] sid A pointer to a sid structure
1460 * @param[in,out] sid_string A pointer that holds a pointer to a sid string. Caller
1461 * needs to free with free(3)
1462 * @return bool
1463 ***************************************************************/
1465 int ConvertSidToStringSid(const struct domsid *sid,
1466 char **sid_string);
1468 /************************************************************//**
1470 * ConvertStringSidToSid
1472 * @brief Convert a string into a domain sid
1474 * @param[in] sid_string A pointer to a sid string.
1475 * @param[in,out] sid A pointer that holds a pointer to a sid structure.
1476 * Caller needs to free with free(3)
1477 * @return bool
1478 ***************************************************************/
1480 int ConvertStringSidToSid(const char *sid_string,
1481 struct domsid **sid);
1483 /************************************************************//**
1485 * NetJoinDomain
1487 * @brief Join a computer to a domain or workgroup
1489 * @param[in] server The server name to connect to
1490 * @param[in] domain The domain or workgroup to join
1491 * @param[in] account_ou The organizational Unit to create the computer account
1492 * in (AD only)
1493 * @param[in] account The domain account used for joining a domain
1494 * @param[in] password The domain account's password used for joining a domain
1495 * @param[in] join_flags Bitmask field to define specific join features
1496 * @return NET_API_STATUS
1498 * example netdomjoin/netdomjoin.c
1499 ***************************************************************/
1501 NET_API_STATUS NetJoinDomain(const char * server /* [in] */,
1502 const char * domain /* [in] [ref] */,
1503 const char * account_ou /* [in] */,
1504 const char * account /* [in] */,
1505 const char * password /* [in] */,
1506 uint32_t join_flags /* [in] */);
1508 /************************************************************//**
1510 * NetUnjoinDomain
1512 * @brief Unjoin a computer from a domain or workgroup
1514 * @param[in] server_name The server name to connect to
1515 * @param[in] account The domain account used for unjoining a domain
1516 * @param[in] password The domain account's password used for unjoining a domain
1517 * @param[in] unjoin_flags Bitmask field to define specific unjoin features
1518 * @return NET_API_STATUS
1520 ***************************************************************/
1522 NET_API_STATUS NetUnjoinDomain(const char * server_name /* [in] */,
1523 const char * account /* [in] */,
1524 const char * password /* [in] */,
1525 uint32_t unjoin_flags /* [in] */);
1527 /************************************************************//**
1529 * NetGetJoinInformation
1531 * @brief Unjoin a computer from a domain or workgroup
1533 * @param[in] server_name The server name to connect to
1534 * @param[out] name_buffer Returns the name of the workgroup or domain
1535 * @param[out] name_type Returns the type of that name
1536 * @return NET_API_STATUS
1538 * example netdomjoin-gui/netdomjoin-gui.c
1540 ***************************************************************/
1542 NET_API_STATUS NetGetJoinInformation(const char * server_name /* [in] */,
1543 const char * *name_buffer /* [out] [ref] */,
1544 uint16_t *name_type /* [out] [ref] */);
1546 /************************************************************//**
1548 * NetGetJoinableOUs
1550 * @brief Query for the list of joinable organizational Units that can be used
1551 * for joining AD
1553 * @param[in] server_name The server name to connect to
1554 * @param[in] domain The AD domain to query
1555 * @param[in] account The domain account used for the query
1556 * @param[in] password The domain account's password used for the query
1557 * @param[out] ou_count The number of ous returned
1558 * @param[out] ous Returned string array containing the ous
1559 * @return NET_API_STATUS
1561 * example netdomjoin-gui/netdomjoin-gui.c
1563 ***************************************************************/
1565 NET_API_STATUS NetGetJoinableOUs(const char * server_name /* [in] */,
1566 const char * domain /* [in] [ref] */,
1567 const char * account /* [in] */,
1568 const char * password /* [in] */,
1569 uint32_t *ou_count /* [out] [ref] */,
1570 const char * **ous /* [out] [ref] */);
1572 /************************************************************//**
1574 * NetRenameMachineInDomain
1576 * @brief Rename a machine in a domain
1578 * @param[in] server_name The server name to connect to
1579 * @param[in] new_machine_name The new machine name
1580 * @param[in] account The domain account used for the query
1581 * @param[in] password The domain account's password used for the query
1582 * @param[in] rename_options Options used for the rename operation
1583 * @return NET_API_STATUS
1585 * example join/rename_machine.c
1587 ***************************************************************/
1589 NET_API_STATUS NetRenameMachineInDomain(const char * server_name /* [in] */,
1590 const char * new_machine_name /* [in] */,
1591 const char * account /* [in] */,
1592 const char * password /* [in] */,
1593 uint32_t rename_options /* [in] */);
1595 /************************************************************//**
1597 * NetServerGetInfo
1599 * @brief Get Information on a server
1601 * @param[in] server_name The server name to connect to
1602 * @param[in] level The level to define which information is requested
1603 * @param[out] buffer The returned buffer carrying the SERVER_INFO structure
1604 * @return NET_API_STATUS
1606 ***************************************************************/
1608 NET_API_STATUS NetServerGetInfo(const char * server_name /* [in] */,
1609 uint32_t level /* [in] */,
1610 uint8_t **buffer /* [out] [ref] */);
1612 /************************************************************//**
1614 * NetServerSetInfo
1616 * @brief Get Information on a server
1618 * @param[in] server_name The server name to connect to
1619 * @param[in] level The level to define which information is set
1620 * @param[in] buffer The buffer carrying the SERVER_INFO structure
1621 * @param[out] parm_error On failure returns the invalid SERVER_INFO member
1622 * @return NET_API_STATUS
1624 ***************************************************************/
1626 NET_API_STATUS NetServerSetInfo(const char * server_name /* [in] */,
1627 uint32_t level /* [in] */,
1628 uint8_t *buffer /* [in] [ref] */,
1629 uint32_t *parm_error /* [out] [ref] */);
1631 /************************************************************//**
1633 * NetWkstaGetInfo
1635 * @brief Get Information on a workstation
1637 * @param[in] wksta_name The workstation name to connect to
1638 * @param[in] level The level to define which information is requested
1639 * @param[out] buffer The returned buffer carrying the WKSTA_INFO structure
1640 * @return NET_API_STATUS
1642 ***************************************************************/
1644 NET_API_STATUS NetWkstaGetInfo(const char * wksta_name /* [in] */,
1645 uint32_t level /* [in] */,
1646 uint8_t **buffer /* [out] [ref] */);
1648 /************************************************************//**
1650 * NetGetDCName
1652 * @brief Query for the PDC for a given domain
1654 * @param[in] server_name The server name to connect to
1655 * @param[in] domain_name The name of the domain to lookup
1656 * @param[out] buffer The name of the domain to lookup
1657 * @return NET_API_STATUS
1659 * example getdc/getdc.c
1660 ***************************************************************/
1662 NET_API_STATUS NetGetDCName(const char * server_name /* [in] */,
1663 const char * domain_name /* [in] */,
1664 uint8_t **buffer /* [out] [ref] */);
1666 /************************************************************//**
1668 * NetGetAnyDCName
1670 * @brief Query for any DC for a given domain
1672 * @param[in] server_name The server name to connect to
1673 * @param[in] domain_name The name of the domain to lookup
1674 * @param[out] buffer The name of the domain to lookup
1675 * @return NET_API_STATUS
1677 * example getdc/getdc.c
1678 ***************************************************************/
1680 NET_API_STATUS NetGetAnyDCName(const char * server_name /* [in] */,
1681 const char * domain_name /* [in] */,
1682 uint8_t **buffer /* [out] [ref] */);
1685 /************************************************************//**
1687 * DsGetDcName
1689 * @brief Lookup a DC for a given domain and return information structure
1691 * @param[in] server_name The server name to connect to
1692 * @param[in] domain_name The name of the domain to lookup (cannot be NULL)
1693 * @param[in] domain_guid The GUID of the domain to lookup (optional)
1694 * @param[in] site_name The name of the site the DC should reside in
1695 * @param[in] flags A bitmask to request specific features supported by the DC
1696 * @param[out] dc_info Pointer to a DOMAIN_CONTROLLER_INFO structure
1697 * @return NET_API_STATUS
1699 * example dsgetdc/dsgetdc.c
1700 ***************************************************************/
1702 NET_API_STATUS DsGetDcName(const char * server_name /* [in] [unique] */,
1703 const char * domain_name /* [in] [ref] */,
1704 struct GUID *domain_guid /* [in] [unique] */,
1705 const char * site_name /* [in] [unique] */,
1706 uint32_t flags /* [in] */,
1707 struct DOMAIN_CONTROLLER_INFO **dc_info /* [out] [ref] */);
1709 /************************************************************//**
1711 * NetUserAdd
1713 * @brief Create a user on a given server
1715 * @param[in] server_name The server name to connect to
1716 * @param[in] level The level of the USER_INFO structure passed in (Currently
1717 * only level 1 is supported)
1718 * @param[in] buffer The buffer carrying the USER_INFO structure
1719 * @param[out] parm_error In case of error returns the failing member of the
1720 * structure
1721 * @return NET_API_STATUS
1723 * example user/user_add.c
1724 ***************************************************************/
1726 NET_API_STATUS NetUserAdd(const char * server_name /* [in] */,
1727 uint32_t level /* [in] */,
1728 uint8_t *buffer /* [in] [ref] */,
1729 uint32_t *parm_error /* [out] [ref] */);
1731 /************************************************************//**
1733 * NetUserDel
1735 * @brief Delete a user on a given server
1737 * @param[in] server_name The server name to connect to
1738 * @param[in] user_name The user account to delete
1739 * @return NET_API_STATUS
1741 * example user/user_del.c
1742 ***************************************************************/
1744 NET_API_STATUS NetUserDel(const char * server_name /* [in] */,
1745 const char * user_name /* [in] */);
1747 /************************************************************//**
1749 * NetUserEnum
1751 * @brief Enumerate accounts on a server
1753 * @param[in] server_name The server name to connect to
1754 * @param[in] level The enumeration level used for the query (Currently only
1755 * level 0 is supported)
1756 * @param[in] filter The account flags filter used for the query
1757 * @param[out] buffer The returned enumeration buffer
1758 * @param[in] prefmaxlen The requested maximal buffer size
1759 * @param[out] entries_read The number of returned entries
1760 * @param[out] total_entries The number of total entries
1761 * @param[in,out] resume_handle A handle passed in and returned for resuming
1762 * operations
1763 * @return NET_API_STATUS
1765 * example user/user_enum.c
1766 ***************************************************************/
1768 NET_API_STATUS NetUserEnum(const char * server_name /* [in] */,
1769 uint32_t level /* [in] */,
1770 uint32_t filter /* [in] */,
1771 uint8_t **buffer /* [out] [ref] */,
1772 uint32_t prefmaxlen /* [in] */,
1773 uint32_t *entries_read /* [out] [ref] */,
1774 uint32_t *total_entries /* [out] [ref] */,
1775 uint32_t *resume_handle /* [in,out] [ref] */);
1777 /************************************************************//**
1779 * NetUserChangePassword
1781 * @brief Change the password for a user on a given server or in a given domain
1783 * @param[in] domain_name The server or domain name to connect to
1784 * @param[in] user_name The user account to change the password for
1785 * @param[in] old_password The user account's old password
1786 * @param[in] new_password The user account's new password
1787 * @return NET_API_STATUS
1789 * example user/user_chgpwd.c
1790 ***************************************************************/
1792 NET_API_STATUS NetUserChangePassword(const char * domain_name /* [in] */,
1793 const char * user_name /* [in] */,
1794 const char * old_password /* [in] */,
1795 const char * new_password /* [in] */);
1797 /************************************************************//**
1799 * NetUserGetInfo
1801 * @brief Get User Information
1803 * @param[in] server_name The server name to connect to
1804 * @param[in] user_name The name of the user that is going to be queried
1805 * @param[in] level The level defining the requested USER_INFO_X structure
1806 * @param[out] buffer The buffer containing a USER_INFO_X structure
1807 * @return NET_API_STATUS
1809 * example user/user_getinfo.c
1810 ***************************************************************/
1812 NET_API_STATUS NetUserGetInfo(const char * server_name /* [in] */,
1813 const char * user_name /* [in] */,
1814 uint32_t level /* [in] */,
1815 uint8_t **buffer /* [out] [ref] */);
1817 /************************************************************//**
1819 * NetUserSetInfo
1821 * @brief Set User Information
1823 * @param[in] server_name The server name to connect to
1824 * @param[in] user_name The name of the user that is going to be modified
1825 * @param[in] level The level defining the requested USER_INFO_X structure
1826 * @param[in] buffer The buffer containing a USER_INFO_X structure
1827 * @param[out] parm_err The returned parameter error number if any
1828 * @return NET_API_STATUS
1830 * example user/user_setinfo.c
1831 ***************************************************************/
1833 NET_API_STATUS NetUserSetInfo(const char * server_name /* [in] */,
1834 const char * user_name /* [in] */,
1835 uint32_t level /* [in] */,
1836 uint8_t *buffer /* [in] [ref] */,
1837 uint32_t *parm_err /* [out] [ref] */);
1839 /************************************************************//**
1841 * NetUserModalsGet
1843 * @brief Get SAM domain and password information
1845 * @param[in] server_name The server name to connect to
1846 * @param[in] level The level defining which USER_MODALS_INFO_X buffer to query
1847 * @param[out] buffer The returned USER_MODALS_INFO_X buffer
1848 * @return NET_API_STATUS
1850 * example user/user_modalsget.c
1851 ***************************************************************/
1853 NET_API_STATUS NetUserModalsGet(const char * server_name /* [in] */,
1854 uint32_t level /* [in] */,
1855 uint8_t **buffer /* [out] [ref] */);
1857 /************************************************************//**
1859 * NetUserModalsSet
1861 * @brief Set SAM domain and password information
1863 * @param[in] server_name The server name to connect to
1864 * @param[in] level The level defining which USER_MODALS_INFO_X buffer to query
1865 * @param[out] buffer The buffer conntaing a USER_MODALS_INFO_X structure
1866 * @param[out] parm_err The returned parameter error number if any
1867 * @return NET_API_STATUS
1869 * example user/user_modalsset.c
1870 ***************************************************************/
1872 NET_API_STATUS NetUserModalsSet(const char * server_name /* [in] */,
1873 uint32_t level /* [in] */,
1874 uint8_t *buffer /* [in] [ref] */,
1875 uint32_t *parm_err /* [out] [ref] */);
1877 /************************************************************//**
1879 * NetUserGetGroups
1881 * @brief Enumerate grouplist of a user on a server
1883 * @param[in] server_name The server name to connect to
1884 * @param[in] user_name The user name to query
1885 * @param[in] level The enumeration level used for the query (Currently only
1886 * level 0 is supported)
1887 * @param[out] buffer The returned enumeration buffer
1888 * @param[in] prefmaxlen The requested maximal buffer size
1889 * @param[out] entries_read The number of returned entries
1890 * @param[out] total_entries The number of total entries
1891 * @return NET_API_STATUS
1893 * example user/user_getgroups.c
1894 ***************************************************************/
1896 NET_API_STATUS NetUserGetGroups(const char * server_name /* [in] */,
1897 const char * user_name /* [in] */,
1898 uint32_t level /* [in] */,
1899 uint8_t **buffer /* [out] [ref] */,
1900 uint32_t prefmaxlen /* [in] */,
1901 uint32_t *entries_read /* [out] [ref] */,
1902 uint32_t *total_entries /* [out] [ref] */);
1904 /************************************************************//**
1906 * NetUserSetGroups
1908 * @brief Set grouplist of a user on a server
1910 * @param[in] server_name The server name to connect to
1911 * @param[in] user_name The user name to query
1912 * @param[in] level The level defining the GROUP_USERS_INFO_X structures in the buffer
1913 * @param[in] buffer The buffer containing GROUP_USERS_INFO_X structures
1914 * @param[in] num_entries The number of X structures in the buffer
1915 * @return NET_API_STATUS
1917 * example user/user_setgroups.c
1918 ***************************************************************/
1920 NET_API_STATUS NetUserSetGroups(const char * server_name /* [in] */,
1921 const char * user_name /* [in] */,
1922 uint32_t level /* [in] */,
1923 uint8_t *buffer /* [in] [ref] */,
1924 uint32_t num_entries /* [in] */);
1926 /************************************************************//**
1928 * NetUserGetLocalGroups
1930 * @brief Enumerate local grouplist of a user on a server
1932 * @param[in] server_name The server name to connect to
1933 * @param[in] user_name The user name to query
1934 * @param[in] level The enumeration level used for the query
1935 * @param[in] flags The flags used for the query
1936 * @param[out] buffer The returned enumeration buffer
1937 * @param[in] prefmaxlen The requested maximal buffer size
1938 * @param[out] entries_read The number of returned entries
1939 * @param[out] total_entries The number of total entries
1940 * @return NET_API_STATUS
1942 * example user/user_getlocalgroups.c
1943 ***************************************************************/
1945 NET_API_STATUS NetUserGetLocalGroups(const char * server_name /* [in] */,
1946 const char * user_name /* [in] */,
1947 uint32_t level /* [in] */,
1948 uint32_t flags /* [in] */,
1949 uint8_t **buffer /* [out] [ref] */,
1950 uint32_t prefmaxlen /* [in] */,
1951 uint32_t *entries_read /* [out] [ref] */,
1952 uint32_t *total_entries /* [out] [ref] */);
1954 /************************************************************//**
1956 * NetQueryDisplayInformation
1958 * @brief Enumerate accounts on a server
1960 * @param[in] server_name The server name to connect to
1961 * @param[in] level The enumeration level used for the query
1962 * @param[in] idx The index to start the the display enumeration at
1963 * @param[in] entries_requested The number of entries requested
1964 * @param[in] prefmaxlen The requested maximal buffer size
1965 * @param[out] entries_read The number of returned entries
1966 * @param[out] buffer The returned display information buffer
1967 * @return NET_API_STATUS
1969 * example user/user_dispinfo.c
1970 ***************************************************************/
1972 NET_API_STATUS NetQueryDisplayInformation(const char * server_name /* [in] [unique] */,
1973 uint32_t level /* [in] */,
1974 uint32_t idx /* [in] */,
1975 uint32_t entries_requested /* [in] */,
1976 uint32_t prefmaxlen /* [in] */,
1977 uint32_t *entries_read /* [out] [ref] */,
1978 void **buffer /* [out] [noprint,ref] */);
1980 /************************************************************//**
1982 * NetGroupAdd
1984 * @brief Create Domain Group
1986 * @param[in] server_name The server name to connect to
1987 * @param[in] level The level used for the new group creation
1988 * @param[in] buf The buffer containing the group structure
1989 * @param[out] parm_err The returned parameter error number if any
1990 * @return NET_API_STATUS
1992 * example group/group_add.c
1993 ***************************************************************/
1995 NET_API_STATUS NetGroupAdd(const char * server_name /* [in] */,
1996 uint32_t level /* [in] */,
1997 uint8_t *buf /* [in] [ref] */,
1998 uint32_t *parm_err /* [out] [ref] */);
2000 /************************************************************//**
2002 * NetGroupDel
2004 * @brief Delete Domain Group
2006 * @param[in] server_name The server name to connect to
2007 * @param[in] group_name The name of the group that is going to be deleted
2008 * @return NET_API_STATUS
2010 * example group/group_del.c
2011 ***************************************************************/
2013 NET_API_STATUS NetGroupDel(const char * server_name /* [in] */,
2014 const char * group_name /* [in] */);
2016 /************************************************************//**
2018 * NetGroupEnum
2020 * @brief Enumerate groups on a server
2022 * @param[in] server_name The server name to connect to
2023 * @param[in] level The enumeration level used for the query (Currently only
2024 * level 0 is supported)
2025 * @param[out] buffer The returned enumeration buffer
2026 * @param[in] prefmaxlen The requested maximal buffer size
2027 * @param[out] entries_read The number of returned entries
2028 * @param[out] total_entries The number of total entries
2029 * @param[in,out] resume_handle A handle passed in and returned for resuming
2030 * operations
2031 * @return NET_API_STATUS
2033 * example group/group_enum.c
2034 ***************************************************************/
2036 NET_API_STATUS NetGroupEnum(const char * server_name /* [in] */,
2037 uint32_t level /* [in] */,
2038 uint8_t **buffer /* [out] [ref] */,
2039 uint32_t prefmaxlen /* [in] */,
2040 uint32_t *entries_read /* [out] [ref] */,
2041 uint32_t *total_entries /* [out] [ref] */,
2042 uint32_t *resume_handle /* [in,out] [ref] */);
2044 /************************************************************//**
2046 * NetGroupSetInfo
2048 * @brief Set Domain Group Information
2050 * @param[in] server_name The server name to connect to
2051 * @param[in] group_name The name of the group that is going to be modified
2052 * @param[in] level The level defining the structure type in buf
2053 * @param[in] buf The buffer containing a GROUP_INFO_X structure
2054 * @param[out] parm_err The returned parameter error number if any
2055 * @return NET_API_STATUS
2057 * example group/group_setinfo.c
2058 ***************************************************************/
2060 NET_API_STATUS NetGroupSetInfo(const char * server_name /* [in] */,
2061 const char * group_name /* [in] */,
2062 uint32_t level /* [in] */,
2063 uint8_t *buf /* [in] [ref] */,
2064 uint32_t *parm_err /* [out] [ref] */);
2066 /************************************************************//**
2068 * NetGroupGetInfo
2070 * @brief Get Domain Group Information
2072 * @param[in] server_name The server name to connect to
2073 * @param[in] group_name The name of the group that is going to be queried
2074 * @param[in] level The level defining the requested GROUP_INFO_X structure
2075 * @param[out] buf The buffer containing a GROUP_INFO_X structure
2076 * @return NET_API_STATUS
2078 * example group/group_getinfo.c
2079 ***************************************************************/
2081 NET_API_STATUS NetGroupGetInfo(const char * server_name /* [in] */,
2082 const char * group_name /* [in] */,
2083 uint32_t level /* [in] */,
2084 uint8_t **buf /* [out] [ref] */);
2086 /************************************************************//**
2088 * NetGroupAddUser
2090 * @brief Add existing User to existing Domain Group
2092 * @param[in] server_name The server name to connect to
2093 * @param[in] group_name The name of the group that is going to be modified
2094 * @param[in] user_name The name of the user that is going to be added to the
2095 * group
2096 * @return NET_API_STATUS
2098 * example group/group_adduser.c
2099 ***************************************************************/
2101 NET_API_STATUS NetGroupAddUser(const char * server_name /* [in] */,
2102 const char * group_name /* [in] */,
2103 const char * user_name /* [in] */);
2105 /************************************************************//**
2107 * NetGroupDelUser
2109 * @brief Remove User from Domain Group
2111 * @param[in] server_name The server name to connect to
2112 * @param[in] group_name The name of the group that is going to be modified
2113 * @param[in] user_name The name of the user that is going to be removed from
2114 * the group
2115 * @return NET_API_STATUS
2117 * example group/group_deluser.c
2118 ***************************************************************/
2120 NET_API_STATUS NetGroupDelUser(const char * server_name /* [in] */,
2121 const char * group_name /* [in] */,
2122 const char * user_name /* [in] */);
2124 /************************************************************//**
2126 * NetGroupGetUsers
2128 * @brief Get Users for a group on a server
2130 * @param[in] server_name The server name to connect to
2131 * @param[in] group_name The group name to enumerate users for
2132 * @param[in] level The enumeration level used for the query
2133 * @param[out] buffer The returned enumeration buffer
2134 * @param[in] prefmaxlen The requested maximal buffer size
2135 * @param[out] entries_read The number of returned entries
2136 * @param[out] total_entries The number of total entries
2137 * @param[in,out] resume_handle A handle passed in and returned for resuming
2138 * operations
2139 * @return NET_API_STATUS
2141 * example group/group_getusers.c
2142 ***************************************************************/
2144 NET_API_STATUS NetGroupGetUsers(const char * server_name /* [in] */,
2145 const char * group_name /* [in] */,
2146 uint32_t level /* [in] */,
2147 uint8_t **buffer /* [out] [ref] */,
2148 uint32_t prefmaxlen /* [in] */,
2149 uint32_t *entries_read /* [out] [ref] */,
2150 uint32_t *total_entries /* [out] [ref] */,
2151 uint32_t *resume_handle /* [in,out] [ref] */);
2153 /************************************************************//**
2155 * NetGroupSetUsers
2157 * @brief Set Users for a group on a server
2159 * @param[in] server_name The server name to connect to
2160 * @param[in] group_name The group name to enumerate users for
2161 * @param[in] level The enumeration level used for the query
2162 * @param[in] buffer The buffer containing a X structure
2163 * @param[in] num_entries The number of X entries in the buffer
2164 * @return NET_API_STATUS
2166 * example group/group_setusers.c
2167 ***************************************************************/
2169 NET_API_STATUS NetGroupSetUsers(const char * server_name /* [in] */,
2170 const char * group_name /* [in] */,
2171 uint32_t level /* [in] */,
2172 uint8_t *buffer /* [in] [ref] */,
2173 uint32_t num_entries /* [in] */);
2175 /************************************************************//**
2177 * NetLocalGroupAdd
2179 * @brief Create Local Group
2181 * @param[in] server_name The server name to connect to
2182 * @param[in] level The level used for the new group creation
2183 * @param[in] buf The buffer containing the group structure
2184 * @param[out] parm_err The returned parameter error number if any
2185 * @return NET_API_STATUS
2187 * example localgroup/localgroup_add.c
2188 ***************************************************************/
2190 NET_API_STATUS NetLocalGroupAdd(const char * server_name /* [in] */,
2191 uint32_t level /* [in] */,
2192 uint8_t *buf /* [in] [ref] */,
2193 uint32_t *parm_err /* [out] [ref] */);
2195 /************************************************************//**
2197 * NetLocalGroupDel
2199 * @brief Delete Local Group
2201 * @param[in] server_name The server name to connect to
2202 * @param[in] group_name The name of the group that is going to be deleted
2203 * @return NET_API_STATUS
2205 * example localgroup/localgroup_del.c
2206 ***************************************************************/
2209 NET_API_STATUS NetLocalGroupDel(const char * server_name /* [in] */,
2210 const char * group_name /* [in] */);
2212 /************************************************************//**
2214 * NetLocalGroupGetInfo
2216 * @brief Get Local Group Information
2218 * @param[in] server_name The server name to connect to
2219 * @param[in] group_name The name of the group that is going to be queried
2220 * @param[in] level The level defining the requested LOCALGROUP_INFO_X structure
2221 * @param[out] buf The buffer containing a LOCALGROUP_INFO_X structure
2222 * @return NET_API_STATUS
2224 * example localgroup/localgroup_getinfo.c
2225 ***************************************************************/
2227 NET_API_STATUS NetLocalGroupGetInfo(const char * server_name /* [in] */,
2228 const char * group_name /* [in] */,
2229 uint32_t level /* [in] */,
2230 uint8_t **buf /* [out] [ref] */);
2232 /************************************************************//**
2234 * NetLocalGroupSetInfo
2236 * @brief Set Local Group Information
2238 * @param[in] server_name The server name to connect to
2239 * @param[in] group_name The name of the group that is going to be modified
2240 * @param[in] level The level defining the requested LOCALGROUP_INFO_X structure
2241 * @param[in] buf The buffer containing a LOCALGROUP_INFO_X structure
2242 * @param[out] parm_err The returned parameter error number if any
2243 * @return NET_API_STATUS
2245 * example localgroup/localgroup_setinfo.c
2246 ***************************************************************/
2249 NET_API_STATUS NetLocalGroupSetInfo(const char * server_name /* [in] */,
2250 const char * group_name /* [in] */,
2251 uint32_t level /* [in] */,
2252 uint8_t *buf /* [in] [ref] */,
2253 uint32_t *parm_err /* [out] [ref] */);
2255 /************************************************************//**
2257 * NetLocalGroupEnum
2259 * @brief Enumerate local groups on a server
2261 * @param[in] server_name The server name to connect to
2262 * @param[in] level The enumeration level used for the query (Currently only
2263 * level 0 is supported)
2264 * @param[out] buffer The returned enumeration buffer
2265 * @param[in] prefmaxlen The requested maximal buffer size
2266 * @param[out] entries_read The number of returned entries
2267 * @param[out] total_entries The number of total entries
2268 * @param[in,out] resume_handle A handle passed in and returned for resuming
2269 * operations
2270 * @return NET_API_STATUS
2272 * example localgroup/localgroup_enum.c
2273 ***************************************************************/
2275 NET_API_STATUS NetLocalGroupEnum(const char * server_name /* [in] */,
2276 uint32_t level /* [in] */,
2277 uint8_t **buffer /* [out] [ref] */,
2278 uint32_t prefmaxlen /* [in] */,
2279 uint32_t *entries_read /* [out] [ref] */,
2280 uint32_t *total_entries /* [out] [ref] */,
2281 uint32_t *resume_handle /* [in,out] [ref] */);
2283 /************************************************************//**
2285 * NetLocalGroupAddMembers
2287 * @brief Add Members to a Local Group
2289 * @param[in] server_name The server name to connect to
2290 * @param[in] group_name The name of the group that is going to modified
2291 * @param[in] level The level defining the LOCALGROUP_MEMBERS_INFO_X structure
2292 * @param[in] buffer The buffer containing a LOCALGROUP_MEMBERS_INFO_X structure
2293 * @param[in] total_entries The number of LOCALGROUP_MEMBERS_INFO_X entries in
2294 * the buffer
2295 * @return NET_API_STATUS
2297 * example localgroup/localgroup_addmembers.c
2298 ***************************************************************/
2300 NET_API_STATUS NetLocalGroupAddMembers(const char * server_name /* [in] */,
2301 const char * group_name /* [in] */,
2302 uint32_t level /* [in] */,
2303 uint8_t *buffer /* [in] [ref] */,
2304 uint32_t total_entries /* [in] */);
2306 /************************************************************//**
2308 * NetLocalGroupDelMembers
2310 * @brief Delete Members from a Local Group
2312 * @param[in] server_name The server name to connect to
2313 * @param[in] group_name The name of the group that is going to modified
2314 * @param[in] level The level defining the LOCALGROUP_MEMBERS_INFO_X structure
2315 * @param[in] buffer The buffer containing a LOCALGROUP_MEMBERS_INFO_X structure
2316 * @param[in] total_entries The number of LOCALGROUP_MEMBERS_INFO_X entries in
2317 * the buffer
2318 * @return NET_API_STATUS
2320 * example localgroup/localgroup_delmembers.c
2321 ***************************************************************/
2323 NET_API_STATUS NetLocalGroupDelMembers(const char * server_name /* [in] */,
2324 const char * group_name /* [in] */,
2325 uint32_t level /* [in] */,
2326 uint8_t *buffer /* [in] [ref] */,
2327 uint32_t total_entries /* [in] */);
2329 /************************************************************//**
2331 * NetLocalGroupGetMembers
2333 * @brief Enumerate Members in a local group
2335 * @param[in] server_name The server name to connect to
2336 * @param[in] local_group_name The localgroup that is going to be queried
2337 * @param[in] level The level defining the LOCALGROUP_MEMBERS_INFO_X structure
2338 * @param[out] buffer The buffer containing a LOCALGROUP_MEMBERS_INFO_X
2339 * structure
2340 * @param[in] prefmaxlen The requested maximal buffer size
2341 * @param[out] entries_read The number of LOCALGROUP_MEMBERS_INFO_X entries in the buffer
2342 * @param[out] total_entries The total number of LOCALGROUP_MEMBERS_INFO_X entries for that group
2343 * @param[in,out] resume_handle A handle passed in and returned for resuming
2344 * operations
2345 * @return NET_API_STATUS
2347 * example localgroup/localgroup_getmembers.c
2348 ***************************************************************/
2350 NET_API_STATUS NetLocalGroupGetMembers(const char * server_name /* [in] */,
2351 const char * local_group_name /* [in] */,
2352 uint32_t level /* [in] */,
2353 uint8_t **buffer /* [out] [ref] */,
2354 uint32_t prefmaxlen /* [in] */,
2355 uint32_t *entries_read /* [out] [ref] */,
2356 uint32_t *total_entries /* [out] [ref] */,
2357 uint32_t *resume_handle /* [in,out] [ref] */);
2359 /************************************************************//**
2361 * NetLocalGroupSetMembers
2363 * @brief Set Members in a Local Group
2365 * @param[in] server_name The server name to connect to
2366 * @param[in] group_name The name of the group that is going to modified
2367 * @param[in] level The level defining the LOCALGROUP_MEMBERS_INFO_X structure
2368 * @param[in] buffer The buffer containing a LOCALGROUP_MEMBERS_INFO_X structure
2369 * @param[in] total_entries The number of LOCALGROUP_MEMBERS_INFO_X entries in
2370 * the buffer
2371 * @return NET_API_STATUS
2373 * example localgroup/localgroup_setmembers.c
2374 ***************************************************************/
2376 NET_API_STATUS NetLocalGroupSetMembers(const char * server_name /* [in] */,
2377 const char * group_name /* [in] */,
2378 uint32_t level /* [in] */,
2379 uint8_t *buffer /* [in] [ref] */,
2380 uint32_t total_entries /* [in] */);
2382 /************************************************************//**
2384 * NetRemoteTOD
2386 * @brief Query remote Time of Day
2388 * @param[in] server_name The server name to connect to
2389 * @param[out] buf The buffer containing a TIME_OF_DAY_INFO structure
2390 * @return NET_API_STATUS
2392 * example server/remote_tod.c
2393 ***************************************************************/
2395 NET_API_STATUS NetRemoteTOD(const char * server_name /* [in] */,
2396 uint8_t **buf /* [out] [ref] */);
2398 /************************************************************//**
2400 * NetShareAdd
2402 * @brief Add Share
2404 * @param[in] server_name The server name to connect to
2405 * @param[in] level The level defining the requested SHARE_INFO_X structure
2406 * @param[in] buffer The buffer containing a SHARE_INFO_X structure
2407 * @param[out] parm_err The returned parameter error number if any
2408 * @return NET_API_STATUS
2410 * example share/share_add.c
2411 ***************************************************************/
2413 NET_API_STATUS NetShareAdd(const char * server_name /* [in] */,
2414 uint32_t level /* [in] */,
2415 uint8_t *buffer /* [in] [ref] */,
2416 uint32_t *parm_err /* [out] [ref] */);
2418 /************************************************************//**
2420 * NetShareDel
2422 * @brief Delete Share
2424 * @param[in] server_name The server name to connect to
2425 * @param[in] net_name The name of the share to delete
2426 * @param[in] reserved
2427 * @return NET_API_STATUS
2429 * example share/share_del.c
2430 ***************************************************************/
2432 NET_API_STATUS NetShareDel(const char * server_name /* [in] */,
2433 const char * net_name /* [in] */,
2434 uint32_t reserved /* [in] */);
2436 /************************************************************//**
2438 * NetShareEnum
2440 * @brief Enumerate Shares
2442 * @param[in] server_name The server name to connect to
2443 * @param[in] level The level defining the SHARE_INFO_X structure
2444 * @param[out] buffer The buffer containing a SHARE_INFO_X structure
2445 * @param[in] prefmaxlen The requested maximal buffer size
2446 * @param[out] entries_read The number of SHARE_INFO_X entries in the buffer
2447 * @param[out] total_entries The total number of SHARE_INFO_X entries
2448 * @param[in,out] resume_handle A handle passed in and returned for resuming
2449 * operations
2450 * @return NET_API_STATUS
2452 * example share/share_enum.c
2453 ***************************************************************/
2455 NET_API_STATUS NetShareEnum(const char * server_name /* [in] */,
2456 uint32_t level /* [in] */,
2457 uint8_t **buffer /* [out] [ref] */,
2458 uint32_t prefmaxlen /* [in] */,
2459 uint32_t *entries_read /* [out] [ref] */,
2460 uint32_t *total_entries /* [out] [ref] */,
2461 uint32_t *resume_handle /* [in,out] [ref] */);
2463 /************************************************************//**
2465 * NetShareGetInfo
2467 * @brief Get Share Info
2469 * @param[in] server_name The server name to connect to
2470 * @param[in] net_name The name of the share to query
2471 * @param[in] level The level defining the SHARE_INFO_X structure
2472 * @param[out] buffer The buffer containing a SHARE_INFO_X structure
2473 * @return NET_API_STATUS
2475 * example share/share_getinfo.c
2476 ***************************************************************/
2478 NET_API_STATUS NetShareGetInfo(const char * server_name /* [in] */,
2479 const char * net_name /* [in] */,
2480 uint32_t level /* [in] */,
2481 uint8_t **buffer /* [out] [ref] */);
2483 /************************************************************//**
2485 * NetShareSetInfo
2487 * @brief Set Share Info
2489 * @param[in] server_name The server name to connect to
2490 * @param[in] net_name The name of the share to query
2491 * @param[in] level The level defining the SHARE_INFO_X structure
2492 * @param[in] buffer The buffer containing a SHARE_INFO_X structure
2493 * @param[out] parm_err The returned parameter error number if any
2494 * @return NET_API_STATUS
2496 * example share/share_setinfo.c
2497 ***************************************************************/
2499 NET_API_STATUS NetShareSetInfo(const char * server_name /* [in] */,
2500 const char * net_name /* [in] */,
2501 uint32_t level /* [in] */,
2502 uint8_t *buffer /* [in] [ref] */,
2503 uint32_t *parm_err /* [out] [ref] */);
2505 /************************************************************//**
2507 * NetFileClose
2509 * @brief Close a file
2511 * @param[in] server_name The server name to connect to
2512 * @param[in] fileid The fileid of the file that is going to be closed
2513 * @return NET_API_STATUS
2515 * example file/file_close.c
2516 ***************************************************************/
2518 NET_API_STATUS NetFileClose(const char * server_name /* [in] */,
2519 uint32_t fileid /* [in] */);
2521 /************************************************************//**
2523 * NetFileGetInfo
2525 * @brief Close a file
2527 * @param[in] server_name The server name to connect to
2528 * @param[in] fileid The fileid of the file that is going to be closed
2529 * @param[in] level The level of the FILE_INFO_X buffer
2530 * @param[out] buffer The buffer containing a FILE_INFO_X structure
2531 * @return NET_API_STATUS
2533 * example file/file_getinfo.c
2534 ***************************************************************/
2536 NET_API_STATUS NetFileGetInfo(const char * server_name /* [in] */,
2537 uint32_t fileid /* [in] */,
2538 uint32_t level /* [in] */,
2539 uint8_t **buffer /* [out] [ref] */);
2541 /************************************************************//**
2543 * NetFileEnum
2545 * @brief Enumerate Files
2547 * @param[in] server_name The server name to connect to
2548 * @param[in] base_path The
2549 * @param[in] user_name The
2550 * @param[in] level The level defining the FILE_INFO_X structure
2551 * @param[out] buffer The buffer containing a FILE_INFO_X structure
2552 * @param[in] prefmaxlen The requested maximal buffer size
2553 * @param[out] entries_read The number of FILE_INFO_X entries in the buffer
2554 * @param[out] total_entries The total number of FILE_INFO_X entries
2555 * @param[in,out] resume_handle A handle passed in and returned for resuming
2556 * operations
2557 * @return NET_API_STATUS
2559 * example file/file_enum.c
2560 ***************************************************************/
2562 NET_API_STATUS NetFileEnum(const char * server_name /* [in] */,
2563 const char * base_path /* [in] */,
2564 const char * user_name /* [in] */,
2565 uint32_t level /* [in] */,
2566 uint8_t **buffer /* [out] [ref] */,
2567 uint32_t prefmaxlen /* [in] */,
2568 uint32_t *entries_read /* [out] [ref] */,
2569 uint32_t *total_entries /* [out] [ref] */,
2570 uint32_t *resume_handle /* [in,out] [ref] */);
2572 /************************************************************//**
2574 * NetShutdownInit
2576 * @brief Start a machine shutdown
2578 * @param[in] server_name The server name to connect to
2579 * @param[in] message The message that is displayed before the shutdown
2580 * @param[in] timeout The amount of seconds to wait until shutting down
2581 * @param[in] force_apps Whether to close all applications before the shutdown
2582 * @param[in] do_reboot Whether to reboot after the shutdown
2583 * @return NET_API_STATUS
2585 * example shutdown/shutdown_init.c
2586 ***************************************************************/
2588 NET_API_STATUS NetShutdownInit(const char * server_name /* [in] */,
2589 const char * message /* [in] */,
2590 uint32_t timeout /* [in] */,
2591 uint8_t force_apps /* [in] */,
2592 uint8_t do_reboot /* [in] */);
2594 /************************************************************//**
2596 * NetShutdownAbort
2598 * @brief Abort an initiated machine shutdown
2600 * @param[in] server_name The server name to connect to
2601 * @return NET_API_STATUS
2603 * example shutdown/shutdown_abort.c
2604 ***************************************************************/
2606 NET_API_STATUS NetShutdownAbort(const char * server_name /* [in] */);
2608 /************************************************************//**
2610 * I_NetLogonControl
2612 * @brief Control various aspects of the NETLOGON service
2614 * @param[in] server_name The server name to connect to
2615 * @param[in] function_code The function code to call on the server
2616 * @param[in] query_level The level of the NETLOGON_INFO structure returned
2617 * @param[out] buffer The returned buffer containing the NETLOGON_INFO structure
2618 * @return NET_API_STATUS
2620 * example netlogon/netlogon_control.c
2621 ***************************************************************/
2623 NET_API_STATUS I_NetLogonControl(const char * server_name /* [in] */,
2624 uint32_t function_code /* [in] */,
2625 uint32_t query_level /* [in] */,
2626 uint8_t **buffer /* [out] [ref] */);
2628 /************************************************************//**
2630 * I_NetLogonControl2
2632 * @brief Control various aspects of the NETLOGON service
2634 * @param[in] server_name The server name to connect to
2635 * @param[in] function_code The function code to call on the server
2636 * @param[in] query_level The level of the NETLOGON_INFO structure returned
2637 * @param[in] data The buffer containing information related to the function code
2638 * @param[out] buffer The returned buffer containing the NETLOGON_INFO structure
2639 * @return NET_API_STATUS
2641 * example netlogon/netlogon_control2.c
2642 ***************************************************************/
2644 NET_API_STATUS I_NetLogonControl2(const char * server_name /* [in] */,
2645 uint32_t function_code /* [in] */,
2646 uint32_t query_level /* [in] */,
2647 uint8_t *data /* [in] [ref] */,
2648 uint8_t **buffer /* [out] [ref] */);
2650 #ifdef __cplusplus
2652 #endif /* __cplusplus */
2654 #endif /* __LIB_NETAPI_H__ */