summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Pool <mbp@samba.org>2001-11-15 06:03:22 +0000
committerMartin Pool <mbp@samba.org>2001-11-15 06:03:22 +0000
commitea40fa55f0c385dd714300a7dcf89393f831ca79 (patch)
treed9d66ee7df7627544b33c54375ef7b8a1af388a7
parent05903e9f8cc7b61576353bb274190d2530593437 (diff)
downloadsamba-ea40fa55f0c385dd714300a7dcf89393f831ca79.tar.gz
samba-ea40fa55f0c385dd714300a7dcf89393f831ca79.tar.bz2
samba-ea40fa55f0c385dd714300a7dcf89393f831ca79.zip
Doxygen demo for Tim.
(This used to be commit 5c892badbcad43b8a2e002d1a42483c402f2d3e9)
-rw-r--r--source3/libsmb/cli_lsarpc.c33
-rw-r--r--source3/rpc_parse/parse_prs.c11
2 files changed, 32 insertions, 12 deletions
diff --git a/source3/libsmb/cli_lsarpc.c b/source3/libsmb/cli_lsarpc.c
index f2fc167606..046422abc6 100644
--- a/source3/libsmb/cli_lsarpc.c
+++ b/source3/libsmb/cli_lsarpc.c
@@ -25,15 +25,28 @@
#include "includes.h"
-/* Opens a SMB connection to the lsa pipe */
-
+/** @defgroup rpc_client RPC Client
+ *
+ * @{
+ **/
+
+/**
+ * @file cli_lsarpc.c
+ *
+ * RPC client routines for the LSA RPC pipe. LSA means "local
+ * security authority", which is half of a password database.
+ **/
+
+/** Opens a SMB connection to the lsa pipe
+ *
+ * @param system_name NETBIOS name of the machine to connect to. */
struct cli_state *cli_lsa_initialise(struct cli_state *cli, char *system_name,
struct ntuser_creds *creds)
{
return cli_pipe_initialise(cli, system_name, PIPE_LSASS, creds);
}
-/* Open a LSA policy handle */
+/** Open a LSA policy handle */
NTSTATUS cli_lsa_open_policy(struct cli_state *cli, TALLOC_CTX *mem_ctx,
BOOL sec_qos, uint32 des_access, POLICY_HND *pol)
@@ -89,7 +102,7 @@ NTSTATUS cli_lsa_open_policy(struct cli_state *cli, TALLOC_CTX *mem_ctx,
return result;
}
-/* Open a LSA policy handle */
+/** Open a LSA policy handle */
NTSTATUS cli_lsa_open_policy2(struct cli_state *cli, TALLOC_CTX *mem_ctx,
BOOL sec_qos, uint32 des_access, POLICY_HND *pol)
@@ -147,7 +160,7 @@ NTSTATUS cli_lsa_open_policy2(struct cli_state *cli, TALLOC_CTX *mem_ctx,
return result;
}
-/* Close a LSA policy handle */
+/** Close a LSA policy handle */
NTSTATUS cli_lsa_close(struct cli_state *cli, TALLOC_CTX *mem_ctx,
POLICY_HND *pol)
@@ -195,7 +208,7 @@ NTSTATUS cli_lsa_close(struct cli_state *cli, TALLOC_CTX *mem_ctx,
return result;
}
-/* Lookup a list of sids */
+/** Lookup a list of sids */
NTSTATUS cli_lsa_lookup_sids(struct cli_state *cli, TALLOC_CTX *mem_ctx,
POLICY_HND *pol, int num_sids, DOM_SID *sids,
@@ -305,7 +318,7 @@ NTSTATUS cli_lsa_lookup_sids(struct cli_state *cli, TALLOC_CTX *mem_ctx,
return result;
}
-/* Lookup a list of names */
+/** Lookup a list of names */
NTSTATUS cli_lsa_lookup_names(struct cli_state *cli, TALLOC_CTX *mem_ctx,
POLICY_HND *pol, int num_names, char **names,
@@ -406,7 +419,7 @@ NTSTATUS cli_lsa_lookup_names(struct cli_state *cli, TALLOC_CTX *mem_ctx,
return result;
}
-/* Query info policy */
+/** Query info policy */
NTSTATUS cli_lsa_query_info_policy(struct cli_state *cli, TALLOC_CTX *mem_ctx,
POLICY_HND *pol, uint16 info_class,
@@ -493,7 +506,7 @@ NTSTATUS cli_lsa_query_info_policy(struct cli_state *cli, TALLOC_CTX *mem_ctx,
return result;
}
-/* Enumerate list of trusted domains */
+/** Enumerate list of trusted domains */
NTSTATUS cli_lsa_enum_trust_dom(struct cli_state *cli, TALLOC_CTX *mem_ctx,
POLICY_HND *pol, uint32 *enum_ctx,
@@ -591,3 +604,5 @@ NTSTATUS cli_lsa_enum_trust_dom(struct cli_state *cli, TALLOC_CTX *mem_ctx,
return result;
}
+
+/** @} **/
diff --git a/source3/rpc_parse/parse_prs.c b/source3/rpc_parse/parse_prs.c
index 7b38e82f5a..89b0db4609 100644
--- a/source3/rpc_parse/parse_prs.c
+++ b/source3/rpc_parse/parse_prs.c
@@ -61,9 +61,14 @@ void prs_debug(prs_struct *ps, int depth, char *desc, char *fn_name)
}
-/*******************************************************************
- Initialise a parse structure - malloc the data if requested.
- ********************************************************************/
+/**
+ * Initialise an expandable parse structure.
+ *
+ * @param size Initial buffer size. If >0, a new buffer will be
+ * created with malloc().
+ *
+ * @return False if allocation fails, otherwise True.
+ **/
BOOL prs_init(prs_struct *ps, uint32 size, TALLOC_CTX *ctx, BOOL io)
{
ZERO_STRUCTP(ps);