source3/rpc_server/srv_spoolss_util.h

   1 /*
   2  *  Unix SMB/CIFS implementation.
   3  *
   4  *  SPOOLSS RPC Pipe server / winreg client routines
   5  *
   6  *  Copyright (c) 2010      Andreas Schneider <asn@samba.org>
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 3 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #ifndef _SRV_SPOOLSS_UITL_H
  23 #define _SRV_SPOOLSS_UITL_H
  24
  25 /**
  26  * @internal
  27  *
  28  * @brief Set printer data over the winreg pipe.
  29  *
  30  * @param[in]  p        The pipes structure to be able to open a new pipe.
  31  *
  32  * @param[in]  printer  The printer name.
  33  *
  34  * @param[in]  key      The key of the printer data to store the value.
  35  *
  36  * @param[in]  value    The value name to save.
  37  *
  38  * @param[in]  type     The type of the value to use.
  39  *
  40  * @param[in]  data     The data which sould be saved under the given value.
  41  *
  42  * @param[in]  data_size The size of the data.
  43  *
  44  * @return              On success WERR_OK, a corresponding DOS error is
  45  *                      something went wrong.
  46  */
  47 WERROR winreg_set_printer_dataex(struct pipes_struct *p,
  48                                  const char *printer,
  49                                  const char *key,
  50                                  const char *value,
  51                                  enum winreg_Type type,
  52                                  uint8_t *data,
  53                                  uint32_t data_size);
  54
  55 /**
  56  * @internal
  57  *
  58  * @brief Get printer data over a winreg pipe.
  59  *
  60  * @param[in]  p        The pipes structure to be able to open a new pipe.
  61  *
  62  * @param[in]  printer  The printer name.
  63  *
  64  * @param[in]  key      The key of the printer data to get the value.
  65  *
  66  * @param[in]  value    The name of the value to query.
  67  *
  68  * @param[in]  type     The type of the value to query.
  69  *
  70  * @param[out] data     A pointer to store the data.
  71  *
  72  * @param[out] data_size A pointer to store the size of the data.
  73  *
  74  * @return              On success WERR_OK, a corresponding DOS error is
  75  *                      something went wrong.
  76  */
  77 WERROR winreg_get_printer_dataex(struct pipes_struct *p,
  78                                  const char *printer,
  79                                  const char *key,
  80                                  const char *value,
  81                                  enum winreg_Type *type,
  82                                  uint8_t **data,
  83                                  uint32_t *data_size);
  84
  85 /**
  86  * @internal
  87  *
  88  * @brief Enumerate on the values of a given key and provide the data.
  89  *
  90  * @param[in]  p        The pipes structure to be able to open a new pipe.
  91  *
  92  * @param[in]  printer  The printer name.
  93  *
  94  * @param[in]  key      The key of the printer data to get the value.
  95  *
  96  * @param[out] pnum_values A pointer to store the number of values we found.
  97  *
  98  * @param[out] penum_values A pointer to store the values and its data.
  99  *
 100  * @return                   WERR_OK on success, the corresponding DOS error
 101  *                           code if something gone wrong.
 102  */
 103 WERROR winreg_enum_printer_dataex(struct pipes_struct *p,
 104                                   const char *printer,
 105                                   const char *key,
 106                                   uint32_t *pnum_values,
 107                                   struct spoolss_PrinterEnumValues **penum_values);
 108
 109 /**
 110  * @internal
 111  *
 112  * @brief Delete printer data over a winreg pipe.
 113  *
 114  * @param[in]  p        The pipes structure to be able to open a new pipe.
 115  *
 116  * @param[in]  printer  The printer name.
 117  *
 118  * @param[in]  key      The key of the printer data to delete.
 119  *
 120  * @param[in]  value    The name of the value to delete.
 121  *
 122  * @return              On success WERR_OK, a corresponding DOS error is
 123  *                      something went wrong.
 124  */
 125 WERROR winreg_delete_printer_dataex(struct pipes_struct *p,
 126                                     const char *printer,
 127                                     const char *key,
 128                                     const char *value);
 129
 130 /**
 131  * @internal
 132  *
 133  * @brief Enumerate on the subkeys of a given key and provide the data.
 134  *
 135  * @param[in]  p        The pipes structure to be able to open a new pipe.
 136  *
 137  * @param[in]  printer  The printer name.
 138  *
 139  * @param[in]  key      The key of the printer data to get the value.
 140  *
 141  * @param[out] pnum_subkeys A pointer to store the number of subkeys found.
 142  *
 143  * @param[in]  psubkeys A pointer to an array to store the names of the subkeys
 144  *                      found.
 145  *
 146  * @return              WERR_OK on success, the corresponding DOS error
 147  *                      code if something gone wrong.
 148  */
 149 WERROR winreg_enum_printer_key(struct pipes_struct *p,
 150                                const char *printer,
 151                                const char *key,
 152                                uint32_t *pnum_subkeys,
 153                                const char ***psubkeys);
 154
 155 /**
 156  * @internal
 157  *
 158  * @brief Delete a key with subkeys of a given printer.
 159  *
 160  * @param[in]  p        The pipes structure to be able to open a new pipe.
 161  *
 162  * @param[in]  printer  The printer name.
 163  *
 164  * @param[in]  key      The key of the printer to delete.
 165  *
 166  * @return              On success WERR_OK, a corresponding DOS error is
 167  *                      something went wrong.
 168  */
 169 WERROR winreg_delete_printer_key(struct pipes_struct *p,
 170                                  const char *printer,
 171                                  const char *key);
 172
 173 /**
 174  * @internal
 175  *
 176  * @brief This function adds a form to the list of available forms that can be
 177  * selected for the specified printer.
 178  *
 179  * @param[in]  p        The pipes structure to be able to open a new pipe.
 180  *
 181  * @param[in]  form     The form to add.
 182  *
 183  * @return              WERR_OK on success.
 184  *                      WERR_ALREADY_EXISTS if the form already exists or is a
 185  *                                          builtin form.
 186  *                      A corresponding DOS error is something went wrong.
 187  */
 188 WERROR winreg_printer_addform1(struct pipes_struct *p,
 189                                struct spoolss_AddFormInfo1 *form);
 190
 191 /*
 192  * @brief This function enumerates the forms supported by the specified printer.
 193  *
 194  * @param[in]  p        The pipes structure to be able to open a new pipe.
 195  *
 196  * @param[out] pnum_info A pointer to store the FormInfo count.
 197  *
 198  * @param[out] pinfo     A pointer to store an array with FormInfo.
 199  *
 200  * @return              On success WERR_OK, a corresponding DOS error is
 201  *                      something went wrong.
 202  */
 203 WERROR winreg_printer_enumforms1(struct pipes_struct *p,
 204                                  uint32_t *pnum_info,
 205                                  union spoolss_FormInfo **pinfo);
 206
 207 /**
 208  * @brief This function removes a form name from the list of supported forms.
 209  *
 210  * @param[in]  p        The pipes structure to be able to open a new pipe.
 211  *
 212  * @param[in]  form_name The name of the form to delete.
 213  *
 214  * @return              WERR_OK on success.
 215  *                      WERR_INVALID_PARAM if the form is a builtin form.
 216  *                      A corresponding DOS error is something went wrong.
 217  */
 218 WERROR winreg_printer_deleteform1(struct pipes_struct *p,
 219                                   const char *form_name);
 220
 221 /**
 222  * @brief This function sets the form information for the specified printer.
 223  *
 224  * If one provides both the name in the API call and inside the FormInfo
 225  * structure, then the form gets renamed.
 226  *
 227  * @param[in]  p        The pipes structure to be able to open a new pipe.
 228  *
 229  * @param[in]  form_name The name of the form to set or rename.
 230  *
 231  * @param[in]  form     The FormInfo structure to save.
 232  *
 233  * @return              WERR_OK on success.
 234  *                      WERR_INVALID_PARAM if the form is a builtin form.
 235  *                      A corresponding DOS error is something went wrong.
 236  */
 237 WERROR winreg_printer_setform1(struct pipes_struct *p,
 238                                const char *form_name,
 239                                struct spoolss_AddFormInfo1 *form);
 240
 241 /**
 242  * @brief This function retrieves information about a specified form.
 243  *
 244  * @param[in]  p        The pipes structure to be able to open a new pipe.
 245  *
 246  * @param[in]  form_name The name of the form to query.
 247  *
 248  * @param[out] form     A pointer to a form structure to fill out.
 249  *
 250  * @return              On success WERR_OK, a corresponding DOS error is
 251  *                      something went wrong.
 252  */
 253 WERROR winreg_printer_getform1(struct pipes_struct *p,
 254                                const char *form_name,
 255                                struct spoolss_FormInfo1 *form);
 256
 257 #endif /* _SRV_SPOOLSS_UITL_H */