s3-rpc_server: Document rpc_pipe_open_internal.

Signed-off-by: Günther Deschner <gd@samba.org>

diff --git a/source3/rpc_server/srv_pipe_hnd.c b/source3/rpc_server/srv_pipe_hnd.c
index f5ea877a40b4210c67281f88936fb4f6aa567740..8d4e26bcab550d6dbd5765eb070dd8fa6a5772a0 100644 (file)
--- 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,