librpc/idl/fsrvp.idl

   1 #include "idl_types.h"
   2
   3 /*
   4  * File Server Remote VSS Protocol Definitions
   5  */
   6
   7 import "misc.idl";
   8
   9 [ uuid("a8e0653c-2744-4389-a61d-7373df8b2292"),
  10   version(1.0),
  11   endpoint("ncacn_np:[\\pipe\\FssagentRpc]"),
  12   helpstring("File Server Remote VSS Protocol"),
  13   pointer_default(unique)
  14 ] interface FileServerVssAgent
  15 {
  16         const uint32 FSRVP_E_BAD_STATE = 0x80042301;
  17         const uint32 FSRVP_E_SHADOW_COPY_SET_IN_PROGRESS = 0x80042316;
  18         const uint32 FSRVP_E_NOT_SUPPORTED = 0x8004230C;
  19         const uint32 FSRVP_E_WAIT_TIMEOUT = 0x00000102;
  20         const uint32 FSRVP_E_WAIT_FAILED = 0xFFFFFFFF;
  21         const uint32 FSRVP_E_OBJECT_ALREADY_EXISTS = 0x8004230D;
  22         const uint32 FSRVP_E_OBJECT_NOT_FOUND = 0x80042308;
  23         const uint32 FSRVP_E_BAD_ID = 0x80042302;       /* wire, not documented */
  24
  25         /* TODO move these to generic herror defines or COM in orpc.idl */
  26         const uint32 E_ACCESSDENIED = 0x80070005;
  27         const uint32 E_INVALIDARG = 0x80070057;
  28         const uint32 E_OUTOFMEMORY = 0x80000002;
  29
  30         typedef struct {
  31                 GUID ShadowCopySetId;
  32                 GUID ShadowCopyId;
  33                 [string,charset(UTF16)] uint16 *ShareNameUNC;
  34                 [string,charset(UTF16)] uint16 *ShadowCopyShareName;
  35                 NTTIME tstamp;
  36         } fssagent_share_mapping_1;
  37
  38         typedef union {
  39                 [case(1)] fssagent_share_mapping_1 *ShareMapping1;
  40                 [default];
  41         } fssagent_share_mapping;
  42
  43         const uint32 FSRVP_RPC_VERSION_1 = 0x000000001;
  44         DWORD fss_GetSupportedVersion(
  45                 [in] uint8 magic[52],           /* wire */
  46                 [out] uint32 *MinVersion,
  47                 [out] uint32 *MaxVersion);
  48
  49         const uint32 ATTR_PERSISTENT = 0x00000001;
  50         const uint32 ATTR_NO_AUTO_RECOVERY = 0x00000002;
  51         const uint32 ATTR_NO_AUTO_RELEASE = 0x00000008;
  52         const uint32 ATTR_NO_WRITERS = 0x00000010;
  53         const uint32 ATTR_FILE_SHARE = 0x04000000;
  54         const uint32 ATTR_AUTO_RECOVERY = 0x00400000;
  55
  56         const uint32 FSRVP_CTX_BACKUP = 0x00000000;
  57         const uint32 FSRVP_CTX_FILE_SHARE_BACKUP = 0x00000010;
  58         const uint32 FSRVP_CTX_NAS_ROLLBACK = 0x00000019;
  59         const uint32 FSRVP_CTX_APP_ROLLBACK = 0x00000009;
  60         DWORD fss_SetContext(
  61                 [in] uint32 Context);
  62
  63         DWORD fss_StartShadowCopySet(
  64                 [in] GUID ClientShadowCopySetId,
  65                 [out] GUID *pShadowCopySetId);
  66
  67         DWORD fss_AddToShadowCopySet(
  68                 [in] GUID ClientShadowCopyId,
  69                 [in] GUID ShadowCopySetId,
  70                 [in] [string,charset(UTF16)] uint16 *ShareName,
  71                 [out] GUID *pShadowCopyId);
  72
  73         DWORD fss_CommitShadowCopySet(
  74                 [in] GUID ShadowCopySetId,
  75                 [in] uint32 TimeOutInMilliseconds);
  76
  77         DWORD fss_ExposeShadowCopySet(
  78                 [in] GUID ShadowCopySetId,
  79                 [in] uint32 TimeOutInMilliseconds);
  80
  81         DWORD fss_RecoveryCompleteShadowCopySet(
  82                 [in] GUID ShadowCopySetId);
  83
  84         DWORD fss_AbortShadowCopySet(
  85                 [in] GUID ShadowCopySetId);
  86
  87         DWORD fss_IsPathSupported(
  88                 [in] [string,charset(UTF16)] uint16 *ShareName,
  89                 [in] uint8 magic[52],                           /* wire */
  90                 [out] boolean32 *SupportedByThisProvider,
  91                 [out] [string,charset(UTF16)] uint16 **OwnerMachineName);
  92
  93         DWORD fss_IsPathShadowCopied(
  94                 [in] [string,charset(UTF16)] uint16 *ShareName,
  95                 [out] boolean32 *ShadowCopyPresent,
  96                 [out] int32 *ShadowCopyCompatibility);
  97
  98         DWORD fss_GetShareMapping(
  99                 [in] GUID ShadowCopyId,
 100                 [in] GUID ShadowCopySetId,
 101                 [in] [string,charset(UTF16)] uint16 *ShareName,
 102                 [in] uint32 Level,
 103                 [out,switch_is(Level)] fssagent_share_mapping *ShareMapping);
 104
 105         DWORD fss_DeleteShareMapping(
 106                 [in] GUID ShadowCopySetId,
 107                 [in] GUID ShadowCopyId,
 108                 [in] [string,charset(UTF16)] uint16 *ShareName);
 109
 110         DWORD fss_PrepareShadowCopySet(
 111                 [in] GUID ShadowCopySetId,
 112                 [in] uint32 TimeOutInMilliseconds);
 113 }