summaryrefslogtreecommitdiff
path: root/source3/rpc_server
diff options
context:
space:
mode:
authorAndreas Schneider <asn@redhat.com>2010-03-05 15:54:31 +0100
committerGünther Deschner <gd@samba.org>2010-03-05 21:25:54 +0100
commitf40550335019aad82180f813f6299d440f4a5977 (patch)
tree6540177be4eef36bb8afb2d1b24b6363c6249e00 /source3/rpc_server
parent58c9070746a3e0725f5d3a3ce6deda8fad0c5974 (diff)
downloadsamba-f40550335019aad82180f813f6299d440f4a5977.tar.gz
samba-f40550335019aad82180f813f6299d440f4a5977.tar.bz2
samba-f40550335019aad82180f813f6299d440f4a5977.zip
s3-rpc_server: Document rpc_pipe_open_internal.
Signed-off-by: Günther Deschner <gd@samba.org>
Diffstat (limited to 'source3/rpc_server')
-rw-r--r--source3/rpc_server/srv_pipe_hnd.c28
1 files changed, 27 insertions, 1 deletions
diff --git a/source3/rpc_server/srv_pipe_hnd.c b/source3/rpc_server/srv_pipe_hnd.c
index f5ea877a40..8d4e26bcab 100644
--- a/source3/rpc_server/srv_pipe_hnd.c
+++ b/source3/rpc_server/srv_pipe_hnd.c
@@ -1457,7 +1457,33 @@ NTSTATUS np_read_recv(struct tevent_req *req, ssize_t *nread,
}
/**
- * Create a new RPC client context which uses a local dispatch function.
+ * @brief Create a new RPC client context which uses a local dispatch function.
+ *
+ * @param[in] mem_ctx The memory context to use.
+ *
+ * @param[in] abstract_syntax Normally the syntax_id of the autogenerated
+ * ndr_table_<name>.
+ *
+ * @param[in] dispatch The corresponding autogenerated dispatch function
+ * rpc_<name>_dispatch.
+ *
+ * @param[in] serversupplied_info The server supplied authentication function.
+ *
+ * @param[out] presult A pointer to store the connected rpc client pipe.
+ *
+ * @return NT_STATUS_OK on success, a corresponding NT status if an
+ * error occured.
+ *
+ * @code
+ * struct rpc_pipe_client *winreg_pipe;
+ * NTSTATUS status;
+ *
+ * status = rpc_pipe_open_internal(tmp_ctx,
+ * &ndr_table_winreg.syntax_id,
+ * rpc_winreg_dispatch,
+ * p->server_info,
+ * &winreg_pipe);
+ * @endcode
*/
NTSTATUS rpc_pipe_open_internal(TALLOC_CTX *mem_ctx,
const struct ndr_syntax_id *abstract_syntax,