source4/librpc/idl/winreg.idl

   1 #include "idl_types.h"
   2
   3 /*
   4   winreg interface definition
   5 */
   6
   7 [ uuid("338cd001-2244-31f1-aaaa-900038001003"),
   8   version(1.0),
   9   endpoint("ncacn_np:[\\pipe\\winreg]","ncacn_ip_tcp:","ncalrpc:"),
  10   pointer_default(unique),
  11   helpstring("Remote Registry Service"),
  12   depends(lsa)
  13 ] interface winreg
  14 {
  15         typedef struct {
  16                 [value(strlen_m_term(r->name)*2)] uint16 name_len;
  17                 [value(r->name_len)]              uint16 name_size;
  18                 unistr *name;
  19         } winreg_String;
  20
  21         typedef struct {
  22                 uint16 unknown0;
  23                 uint16 unknown1;
  24         } winreg_OpenUnknown;
  25
  26         /******************/
  27         /* Function: 0x00 */
  28         WERROR winreg_OpenHKCR(
  29                 [in]      winreg_OpenUnknown *unknown,
  30                 [in]      uint32 access_required,
  31                 [out,ref] policy_handle *handle
  32         );
  33
  34         /******************/
  35         /* Function: 0x01 */
  36         WERROR winreg_OpenHKCU(
  37                 [in]      winreg_OpenUnknown *unknown,
  38                 [in]      uint32 access_required,
  39                 [out,ref] policy_handle *handle
  40         );
  41
  42         /******************/
  43         /* Function: 0x02 */
  44         WERROR winreg_OpenHKLM(
  45                 [in]      winreg_OpenUnknown *unknown,
  46                 [in]      uint32 access_required,
  47                 [out,ref] policy_handle *handle
  48         );
  49
  50         /******************/
  51         /* Function: 0x03 */
  52         WERROR winreg_OpenHKPD(
  53                 [in]      winreg_OpenUnknown *unknown,
  54                 [in]      uint32 access_required,
  55                 [out,ref] policy_handle *handle
  56         );
  57
  58         /******************/
  59         /* Function: 0x04 */
  60         WERROR winreg_OpenHKU(
  61                 [in]      winreg_OpenUnknown *unknown,
  62                 [in]      uint32 access_required,
  63                 [out,ref] policy_handle *handle
  64         );
  65
  66         /******************/
  67         /* Function: 0x05 */
  68         WERROR winreg_CloseKey(
  69                 [in,out,ref] policy_handle *handle
  70         );
  71
  72         /******************/
  73         /* Function: 0x06 */
  74         WERROR winreg_CreateKey(
  75                 [in,out,ref] policy_handle *handle,
  76                 [in] winreg_String key,
  77                 [in] winreg_String class,
  78                 [in] uint32 options,
  79                 [in] uint32 access_mask,
  80                 [in,out,ref] uint32 *action_taken,
  81                 [in] sec_desc_buf *sec_desc
  82         );
  83
  84         /******************/
  85         /* Function: 0x07 */
  86         WERROR winreg_DeleteKey(
  87                 [in,ref] policy_handle *handle,
  88                 [in]     winreg_String key
  89         );
  90
  91         /******************/
  92         /* Function: 0x08 */
  93         WERROR winreg_DeleteValue(
  94                 [in,ref] policy_handle *handle,
  95                 [in]     winreg_String value
  96         );
  97
  98         typedef struct {
  99                 uint32 low;
 100                 uint32 high;
 101         } winreg_Time;
 102
 103         typedef struct {
 104                 uint32 unknown;
 105                 winreg_String key_name;
 106         } winreg_EnumKeyNameRequest;
 107
 108         typedef struct {
 109                 uint32 unknown1;
 110                 uint32 unknown2;
 111                 lstring name;
 112         } winreg_EnumKeyNameResponse;
 113
 114         /******************/
 115         /* Function: 0x09 */
 116         WERROR winreg_EnumKey(
 117                 [in,ref]    policy_handle *handle,
 118                 [in] uint32 enum_index,
 119                 [in,out]    uint16 key_name_len,
 120                 [in,out]    uint16 unknown,
 121                 [in]        winreg_EnumKeyNameRequest *in_name,
 122                 [out]       winreg_EnumKeyNameResponse *out_name,
 123                 [in,out]    winreg_String *class,
 124                 [in,out]    winreg_Time *last_changed_time
 125         );
 126
 127         /******************/
 128         /* Function: 0x0a */
 129
 130         /*
 131            this is equivalent IDL to a winreg_String, but we need to
 132            have absolute control over the length/size fields as the
 133            server looks at those to see what size buffer we have, so
 134            we can't use the automatic unistr handing in pidl.
 135         */
 136         typedef struct {
 137                 uint16 length;
 138                 uint16 size;
 139                 [size_is(size/2),length_is(length/2)] uint16 *name;
 140         } winreg_EnumValueString;
 141
 142         WERROR winreg_EnumValue(
 143                 [in,ref] policy_handle *handle,
 144                 [in]     uint32 enum_index,
 145                 [in]     winreg_EnumValueString name_in,
 146                 [out]    winreg_String name_out,
 147                 [in,out] uint32 *type,
 148                 [in,out,size_is(*size),length_is(*length)] uint8 *value,
 149                 [in,out] uint32 *size,
 150                 [in,out] uint32 *length
 151         );
 152
 153         /******************/
 154         /* Function: 0x0b */
 155         WERROR winreg_FlushKey(
 156                 [in,ref] policy_handle *handle
 157         );
 158
 159         typedef struct {
 160                 [size_is(size),length_is(len)] uint8 *data;
 161                 uint32 size;
 162                 uint32 len;
 163         } KeySecurityData;
 164
 165         /******************/
 166         /* Function: 0x0c */
 167         WERROR winreg_GetKeySecurity(
 168                 [in,ref] policy_handle *handle,
 169                 [in] uint32 access_mask,
 170                 [in,out,ref] KeySecurityData *data
 171         );
 172
 173         /******************/
 174         /* Function: 0x0d */
 175         WERROR winreg_LoadKey(
 176                 [in,ref] policy_handle *handle,
 177                 [in] winreg_String *keyname,
 178                 [in] winreg_String *filename
 179         );
 180
 181         /******************/
 182         /* Function: 0x0e */
 183         WERROR winreg_NotifyChangeKeyValue(
 184         );
 185
 186         /******************/
 187         /* Function: 0x0f */
 188         WERROR winreg_OpenKey(
 189                 [in,ref] policy_handle *handle,
 190                 [in] winreg_String keyname,
 191                 [in] uint32 unknown,
 192                 [in] uint32 access_mask,
 193                 [out,ref] policy_handle *handle
 194         );
 195
 196         /******************/
 197         /* Function: 0x10 */
 198         WERROR winreg_QueryInfoKey(
 199                 [in,ref] policy_handle *handle,
 200                 [in] winreg_String class,
 201                 [out] winreg_String class,
 202                 [out] uint32 num_subkeys,
 203                 [out] uint32 max_subkeylen,
 204                 [out] uint32 max_subkeysize,
 205                 [out] uint32 num_values,
 206                 [out] uint32 max_valnamelen,
 207                 [out] uint32 max_valbufsize,
 208                 [out] uint32 secdescsize,
 209                 [out] winreg_Time last_changed_time
 210         );
 211
 212         /******************/
 213         /* Function: 0x11 */
 214         WERROR winreg_QueryValue(
 215                 [in,ref] policy_handle *handle,
 216                 [in] winreg_String value_name,
 217                 [in,out] uint32 *type,
 218                 [in,out,size_is(*size),length_is(*length)] uint8 *data,
 219                 [in,out] uint32 *size,
 220                 [in,out] uint32 *length
 221         );
 222
 223         /******************/
 224         /* Function: 0x12 */
 225         WERROR winreg_ReplaceKey(
 226         );
 227
 228         /******************/
 229         /* Function: 0x13 */
 230         WERROR winreg_RestoreKey(
 231         );
 232
 233         /******************/
 234         /* Function: 0x14 */
 235         WERROR winreg_SaveKey(
 236         );
 237
 238         /******************/
 239         /* Function: 0x15 */
 240         WERROR winreg_SetKeySecurity(
 241                 [in,ref] policy_handle *handle,
 242                 [in] uint32 access_mask,
 243                 [in,out,ref] KeySecurityData *data
 244         );
 245
 246         /******************/
 247         /* Function: 0x16 */
 248         WERROR winreg_SetValue(
 249                 [in,ref]           policy_handle *handle,
 250                 [in]               winreg_String name,
 251                 [in]               uint32 type,
 252                 [in,size_is(size)] uint8  *data,
 253                 [in]               uint32 size
 254         );
 255
 256         /******************/
 257         /* Function: 0x17 */
 258         WERROR winreg_UnLoadKey(
 259         );
 260
 261         /******************/
 262         /* Function: 0x18 */
 263         WERROR winreg_InitiateSystemShutdown(
 264                 [in]    uint16 *hostname,
 265                 [in]    winreg_String *message,
 266                 [in]    uint32 timeout,
 267                 [in]    uint8 force_apps,
 268                 [in]    uint8 reboot
 269         );
 270
 271         /******************/
 272         /* Function: 0x19 */
 273         WERROR winreg_AbortSystemShutdown(
 274                 [in]    uint16 *server
 275         );
 276
 277         /******************/
 278         /* Function: 0x1a */
 279         WERROR winreg_GetVersion(
 280                 [in,ref] policy_handle *handle,
 281                 [out]    uint32 version
 282         );
 283
 284         /******************/
 285         /* Function: 0x1b */
 286         WERROR winreg_OpenHKCC(
 287                 [in]      winreg_OpenUnknown *unknown,
 288                 [in]      uint32 access_required,
 289                 [out,ref] policy_handle *handle
 290         );
 291
 292         /******************/
 293         /* Function: 0x1c */
 294         WERROR winreg_OpenHKDD(
 295                 [in]      winreg_OpenUnknown *unknown,
 296                 [in]      uint32 access_required,
 297                 [out,ref] policy_handle *handle
 298         );
 299
 300         typedef struct {
 301                 winreg_String *name;
 302                 uint32 type;
 303                 uint32 offset;
 304                 uint32 length;
 305         } QueryMultipleValue;
 306
 307         /******************/
 308         /* Function: 0x1d */
 309         WERROR winreg_QueryMultipleValues(
 310                 [in,ref] policy_handle *key_handle,
 311                 [in,out,size_is(num_values),length_is(num_values),ref] QueryMultipleValue *values,
 312         [in] uint32 num_values,
 313         [in,out,size_is(*buffer_size),length_is(*buffer_size)] uint8 *buffer,
 314         [in,out,ref] uint32 *buffer_size
 315         );
 316
 317         /******************/
 318         /* Function: 0x1e */
 319         WERROR winreg_InitiateSystemShutdownEx(
 320                 );
 321
 322         /******************/
 323         /* Function: 0x1f */
 324         WERROR winreg_SaveKeyEx(
 325         );
 326
 327         /******************/
 328         /* Function: 0x20 */
 329         WERROR winreg_OpenHKPT(
 330                 [in]      winreg_OpenUnknown *unknown,
 331                 [in]      uint32 access_required,
 332                 [out,ref] policy_handle *handle
 333         );
 334
 335         /******************/
 336         /* Function: 0x21 */
 337         WERROR winreg_OpenHKPN(
 338                 [in]      winreg_OpenUnknown *unknown,
 339                 [in]      uint32 access_required,
 340                 [out,ref] policy_handle *handle
 341         );
 342
 343         /******************/
 344         /* Function: 0x22 */
 345         WERROR winreg_QueryMultipleValues2(
 346         );
 347 }