src/pulsecore/cli-command.h

   1 #ifndef fooclicommandhfoo
   2 #define fooclicommandhfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of PulseAudio.
   8
   9   Copyright 2004-2006 Lennart Poettering
  10
  11   PulseAudio is free software; you can redistribute it and/or modify
  12   it under the terms of the GNU Lesser General Public License as published
  13   by the Free Software Foundation; either version 2 of the License,
  14   or (at your option) any later version.
  15
  16   PulseAudio is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with PulseAudio; if not, write to the Free Software
  23   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  24   USA.
  25 ***/
  26
  27 #include <pulsecore/strbuf.h>
  28 #include <pulsecore/core.h>
  29
  30 /* Execute a single CLI command. Write the results to the string
  31  * buffer *buf. If *fail is non-zero the function will return -1 when
  32  * one or more of the executed commands failed. *fail
  33  * may be modified by the function call. */
  34 int pa_cli_command_execute_line(pa_core *c, const char *s, pa_strbuf *buf, pa_bool_t *fail);
  35
  36 /* Execute a whole file of CLI commands */
  37 int pa_cli_command_execute_file(pa_core *c, const char *fn, pa_strbuf *buf, pa_bool_t *fail);
  38
  39 /* Execute a whole file of CLI commands */
  40 int pa_cli_command_execute_file_stream(pa_core *c, FILE *f, pa_strbuf *buf, pa_bool_t *fail);
  41
  42 /* Split the specified string into lines and run pa_cli_command_execute_line() for each. */
  43 int pa_cli_command_execute(pa_core *c, const char *s, pa_strbuf *buf, pa_bool_t *fail);
  44
  45 /* Same as pa_cli_command_execute_line() but also take ifstate var. */
  46 int pa_cli_command_execute_line_stateful(pa_core *c, const char *s, pa_strbuf *buf, pa_bool_t *fail, int *ifstate);
  47
  48 #endif