r871: add a comment about how samdb_set_password() works

[gd/samba-autobuild/.git] / source4 / rpc_server / samr / samr_password.c

diff --git a/source4/rpc_server/samr/samr_password.c b/source4/rpc_server/samr/samr_password.c
index bc31d82a6afc058bccfd4ac7ea94421985fc81b1..5b99e04fab98382418e369ee558150e0ec6382a6 100644 (file)
--- a/source4/rpc_server/samr/samr_password.c
+++ b/source4/rpc_server/samr/samr_password.c
@@ -261,6 +261,12 @@ BOOL samdb_password_complexity_ok(const char *pass)
 /*
   set the user password using plaintext, obeying any user or domain
   password restrictions
+
+  note that this function doesn't actually store the result in the
+  database, it just fills in the "mod" structure with ldb modify
+  elements to setup the correct change when samdb_replace() is
+  called. This allows the caller to combine the change with other
+  changes (as is needed by some of the set user info levels)
 */
 NTSTATUS samdb_set_password(void *ctx, TALLOC_CTX *mem_ctx,
                                   const char *user_dn, const char *domain_dn,