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_UNSUPPORTED_CONTEXT = 0x8004231B;
  24         const uint32 FSRVP_E_BAD_ID = 0x80042302;       /* wire, not documented */
  25
  26         /* TODO move these to generic herror defines or COM in orpc.idl */
  27         const uint32 E_ACCESSDENIED = 0x80070005;
  28         const uint32 E_INVALIDARG = 0x80070057;
  29         const uint32 E_OUTOFMEMORY = 0x80000002;
  30
  31         typedef struct {
  32                 GUID ShadowCopySetId;
  33                 GUID ShadowCopyId;
  34                 [string,charset(UTF16)] uint16 *ShareNameUNC;
  35                 [string,charset(UTF16)] uint16 *ShadowCopyShareName;
  36                 NTTIME tstamp;
  37         } fssagent_share_mapping_1;
  38
  39         typedef union {
  40                 [case(1)] fssagent_share_mapping_1 *ShareMapping1;
  41                 [default];
  42         } fssagent_share_mapping;
  43
  44         const uint32 FSRVP_RPC_VERSION_1 = 0x000000001;
  45         DWORD fss_GetSupportedVersion(
  46                 [in] uint8 magic[52],           /* wire */
  47                 [out] uint32 *MinVersion,
  48                 [out] uint32 *MaxVersion);
  49
  50         const uint32 ATTR_PERSISTENT = 0x00000001;
  51         const uint32 ATTR_NO_AUTO_RECOVERY = 0x00000002;
  52         const uint32 ATTR_NO_AUTO_RELEASE = 0x00000008;
  53         const uint32 ATTR_NO_WRITERS = 0x00000010;
  54         const uint32 ATTR_FILE_SHARE = 0x04000000;
  55         const uint32 ATTR_AUTO_RECOVERY = 0x00400000;
  56
  57         const uint32 FSRVP_CTX_BACKUP = 0x00000000;
  58         const uint32 FSRVP_CTX_FILE_SHARE_BACKUP = 0x00000010;
  59         const uint32 FSRVP_CTX_NAS_ROLLBACK = 0x00000019;
  60         const uint32 FSRVP_CTX_APP_ROLLBACK = 0x00000009;
  61         DWORD fss_SetContext(
  62                 [in] uint32 Context);
  63
  64         DWORD fss_StartShadowCopySet(
  65                 [in] GUID ClientShadowCopySetId,
  66                 [out] GUID *pShadowCopySetId);
  67
  68         DWORD fss_AddToShadowCopySet(
  69                 [in] GUID ClientShadowCopyId,
  70                 [in] GUID ShadowCopySetId,
  71                 [in] [string,charset(UTF16)] uint16 *ShareName,
  72                 [out] GUID *pShadowCopyId);
  73
  74         DWORD fss_CommitShadowCopySet(
  75                 [in] GUID ShadowCopySetId,
  76                 [in] uint32 TimeOutInMilliseconds);
  77
  78         DWORD fss_ExposeShadowCopySet(
  79                 [in] GUID ShadowCopySetId,
  80                 [in] uint32 TimeOutInMilliseconds);
  81
  82         DWORD fss_RecoveryCompleteShadowCopySet(
  83                 [in] GUID ShadowCopySetId);
  84
  85         DWORD fss_AbortShadowCopySet(
  86                 [in] GUID ShadowCopySetId);
  87
  88         DWORD fss_IsPathSupported(
  89                 [in] [string,charset(UTF16)] uint16 *ShareName,
  90                 [in] uint8 magic[52],                           /* wire */
  91                 [out] boolean32 *SupportedByThisProvider,
  92                 [out] [string,charset(UTF16)] uint16 **OwnerMachineName);
  93
  94         DWORD fss_IsPathShadowCopied(
  95                 [in] [string,charset(UTF16)] uint16 *ShareName,
  96                 [out] boolean32 *ShadowCopyPresent,
  97                 [out] int32 *ShadowCopyCompatibility);
  98
  99         DWORD fss_GetShareMapping(
 100                 [in] GUID ShadowCopyId,
 101                 [in] GUID ShadowCopySetId,
 102                 [in] [string,charset(UTF16)] uint16 *ShareName,
 103                 [in] uint32 Level,
 104                 [out,switch_is(Level)] fssagent_share_mapping *ShareMapping);
 105
 106         DWORD fss_DeleteShareMapping(
 107                 [in] GUID ShadowCopySetId,
 108                 [in] GUID ShadowCopyId,
 109                 [in] [string,charset(UTF16)] uint16 *ShareName);
 110
 111         DWORD fss_PrepareShadowCopySet(
 112                 [in] GUID ShadowCopySetId,
 113                 [in] uint32 TimeOutInMilliseconds);
 114 }