From f40550335019aad82180f813f6299d440f4a5977 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Fri, 5 Mar 2010 15:54:31 +0100 Subject: s3-rpc_server: Document rpc_pipe_open_internal. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Günther Deschner --- source3/rpc_server/srv_pipe_hnd.c | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) 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_. + * + * @param[in] dispatch The corresponding autogenerated dispatch function + * rpc__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, -- cgit