1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
|
<?xml version="1.0"?>
<doc>
<assembly>
<name>AlphaVSS.Common</name>
</assembly>
<members>
<member name="T:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata">
<summary>
A class that allows a requester to examine the metadata of a specific writer instance. This metadata may come from a
currently executing (live) writer, or it may have been stored as an XML document.
</summary>
<remarks>
A <see cref="T:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata"/> interface to a live writer's metadata is obtained by a call to
<see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterMetadata"/>.
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.LoadFromXml(System.String)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.LoadFromXml(System.String)"/> method loads an XML document that contains a writer's metadata document into a
<see cref="T:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata"/> instance.
</summary>
<param name="xml">String that contains an XML document that represents a writer's metadata document.</param>
<returns><see langword="true"/> if the XML document was successfully loaded, or <see langword="false"/> if the XML document could not
be loaded.</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.SaveAsXml">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.SaveAsXml"/> method saves the Writer Metadata Document that contains a writer's state information to a specified string.
This string can be saved as part of a backup operation.
</summary>
<returns>The Writer Metadata Document that contains a writer's state information.</returns>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.BackupSchema">
<summary>
The <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.BackupSchema"/> is examined by a requester to determine from the
Writer Metadata Document the types of backup operations that a given writer can participate in.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.AlternateLocationMappings">
<summary>
The alternate location mappings of the file sets.
</summary>
<value>A read-only list containing the alternate location mappings of the file sets.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.RestoreMethod">
<summary>
Information about how a writer wants its data to be restored.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Components">
<summary>
Obtains the Writer Metadata Documents the components supported by this writer.
</summary>
<value>the Writer Metadata Documents the components supported by this writer.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.ExcludeFiles">
<summary>Information about files that have been explicitly excluded from backup.</summary>
<value>a read-only list containing information about files that have been explicitly excluded from backup.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.InstanceId">
<summary>
The instance identifier of the writer
</summary>
<value>The instance id.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.WriterId">
<summary>The class ID of the writer</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.WriterName">
<summary>A string specifying the name of the writer</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Usage">
<summary>A <see cref="T:Alphaleonis.Win32.Vss.VssUsageType"/> enumeration value indicating how the data managed by the writer is used on the host system.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Source">
<summary>A <see cref="T:Alphaleonis.Win32.Vss.VssSourceType"/> enumeration value indicating the type of data managed by the writer.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.InstanceName">
<summary>
Gets the writer instance name.
</summary>
<remarks>
<note>
<para>
<b>Windows XP and Windows 2003:</b> This property is not supported until Windows 2003 SP1 and will always return
<see langword="null"/> on those systems.
</para>
</note>
</remarks>
<value>A string specifying the writer instance name.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Version">
<summary>
Gets the version information for a writer application.
</summary>
<value>The version information for a writer application.</value>
<remarks>
<para>
Only the <see cref="P:System.Version.Major"/> and <see cref="P:System.Version.Minor"/> properties of the <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Version"/> instance
are used by VSS.
</para>
<para>
<note><b>Windows XP and Windows 2003:</b> This property is not supported until Windows Vista, and will always return version 0.0.0.0</note>
</para>
</remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.ExcludeFromSnapshotFiles">
<summary>
Obtains information about file sets that have been explicitly excluded from a given shadow copy.
</summary>
<remarks>
<para>
The <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.ExcludeFromSnapshotFiles"/> property is intended to report information about file sets excluded from a
shadow copy. Requesters should not exclude files from backup based on the information returned by this method.
</para>
<para>
<note>
<para><b>Windows XP and Windows 2003:</b> This property is not supported until Windows Vista and will always return an empty list.</para>
</note>
</para>
</remarks>
<value>The exclude from snapshot files.</value>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException">
<summary>
Exception thrown to indicate that an unexpected error occurred during communication with writers.
</summary>
<remarks>
The error code is logged in the error log file.
</remarks>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssException">
<summary>
Base class for exceptions indicating an error occuring during a VSS operation.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssException"/> class with the specified error message.
</summary>
<param name="message">The error message.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssException"/> class with the specified error message
and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message.</param>
<param name="innerException">The inner exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssException"/> class with serialized data.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException">
<summary>
Exception thrown to indicate that the system was unable to freeze the Distributed Transaction Coordinator (DTC)
or the Kernel Transaction Manager (KTM).
</summary>
<remarks>
<note>
<b>Windows Server 2003 and Windows XP:</b> This exception is not supported until Windows Vista.
</note>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssRestoreSubcomponentInfo">
<summary>
Represents information about a Subcomponent associated with a given component.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssRestoreSubcomponentInfo.#ctor(System.String,System.String)">
<summary>
Initializes a new instance of <see cref="T:Alphaleonis.Win32.Vss.VssRestoreSubcomponentInfo"/>.
</summary>
<param name="logicalPath">The logical path of the Subcomponent. This can not be empty when working with Subcomponents.</param>
<param name="componentName">The name of the Subcomponent. This can not be empty.</param>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssRestoreSubcomponentInfo.LogicalPath">
<summary>The logical path of the Subcomponent. This can not be empty when working with Subcomponents.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssRestoreSubcomponentInfo.ComponentName">
<summary>The name of the Subcomponent. This can not be empty.</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.IVssWriterComponents">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.IVssWriterComponents"/> interface contains methods used to obtain and modify component information
(in the form of <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> instances) associated with a given writer but stored in a
requester's Backup Components Document.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWriterComponents.Components">
<summary>
A read-only collection of <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> instances to the a given writer's
components explicitly stored in the Backup Components Document.
</summary>
<value>A read-only collection of <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> instances to the a given writer's
components explicitly stored in the Backup Components Document. <note type="caution">This list
must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note>
</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWriterComponents.InstanceId">
<summary>
Identifier of the writer instance responsible for the components.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWriterComponents.WriterId">
<summary>
Identifier of the writer class responsible for the components.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssWriterNotRespondingException">
<summary>
Exception indicating that the writer is not responding.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssWriterException">
<summary>
Base class for exceptions thrown to indicate errors reported by VSS writers.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterException"/> class with the specified error message.
</summary>
<param name="message">The error message.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterException"/> class with the specified error message
and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message.</param>
<param name="innerException">The inner exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterException"/> class with serialized data.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterNotRespondingException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterNotRespondingException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterNotRespondingException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterNotRespondingException"/> class.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterNotRespondingException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterNotRespondingException"/> class.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterNotRespondingException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterNotRespondingException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is <see langword="null"/>.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException">
<summary>
Exception thrown to indicate that the writer infrastructure is not operating properly.
</summary>
<remarks>
Check that the Event Service and VSS have been started, and check for errors associated with those services in the error log.
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterInfrastructureException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterInfrastructureException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterInfrastructureException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterInfrastructureException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssVolumeInUseException">
<summary>
Exception indicating that the volume was in use and could not be locked.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssVolumeInUseException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeInUseException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssVolumeInUseException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeInUseException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssVolumeInUseException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeInUseException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssVolumeInUseException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeInUseException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssWriterRestore">
<summary>The <see cref="T:Alphaleonis.Win32.Vss.VssWriterRestore"/> enumeration is used by a writer to indicate to a requester the
conditions under which it will handle events generated during a restore operation.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterRestore.Undefined">
<summary>
<para>It is not known whether the writer will perform special operations during the restore operation.</para>
<para>This state indicates a writer error.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterRestore.Never">
<summary>The writer does not require restore events.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterRestore.IfReplaceFails">
<summary>
Indicates that the writer always expects to handle a <c>PreRestore</c> event, but expects to handle a
<c>PostRestore</c> event only if a restore fails when implementing either a
<see cref="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreIfNotThere"/> or
<see cref="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreIfCanReplace"/> restore method (<see cref="T:Alphaleonis.Win32.Vss.VssRestoreMethod"/>)
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterRestore.Always">
<summary>The writer always performs special operations during the restore operation.</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes">
<summary>
Allows additional attributes to be specified for a shadow copy. The context of a shadow copy (as set by the SetContext method in <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> method)
may be modified by a bitmask that contains a valid combination of <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/> and
<see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> enumeration values.
</summary>
<remarks>In the VSS API, these values are represented by the enumeration
<seealso cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> </remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Persistent">
<summary>The shadow copy is persistent across reboots.
This attribute is automatically set for <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> contexts of <c>AppRollback</c>
<c>ClientAccessible</c>, <c>ClientAccessibleWriters</c> and <c>NasRollback</c>.
This attribute should not be used explicitly by requesters when setting the context of a shadow copy.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.NoAutoRecovery">
<summary>
<para>Auto-recovery is disabled for the shadow copy.</para>
<para>A requester can modify a shadow copy context with a bitwise OR of this attribute. By doing this, the requester instructs
VSS to make the shadow copy read-only immediately after it is created, without allowing writers or other applications to update
components in the shadow copy.</para>
<para>Disabling auto-recovery can cause the shadow copy to be in an inconsistent state if any of its components are involved in
transactional database operations, such as transactional read and write operations managed by Transactional NTFS (TxF).
This is because disabling auto-recovery prevents incomplete transactions from being rolled back.</para>
<para>Disabling auto-recovery also prevents writers from excluding files from the shadow copy. </para>
<para><b>Windows Server 2003 and Windows XP:</b> This value is not supported until Windows Vista.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.ClientAccessible">
<summary>
<para>The specified shadow copy is a client-accessible copy, supports Shadow Copies for Shared Folders, and should not be exposed. </para>
<para>This attribute is automatically set for <c>ClientAccessible</c> and <c>ClientAccessibleWriters</c>.</para>
<para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.NoAutoRelease">
<summary>
<para>The shadow copy is not automatically deleted when the shadow copy requester process ends.
The shadow copy can be deleted only by a call to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DeleteSnapshot(System.Guid,System.Boolean)"/> or
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DeleteSnapshotSet(System.Guid,System.Boolean)"/>.</para>
<para>This attribute is automatically set for <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> contexts of <c>Rollback</c>,
<c>ClientAccessible</c>, <c>ClientAccessibleWriters</c> and <c>Rollback</c>.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.NoWriters">
<summary>
<para>No writers are involved in creating the shadow copy. </para>
<para>This attribute is automatically set for <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> contexts of <c>NasRollback</c>,
<c>FileShareBackup</c> and <c>ClientAccessible</c>.</para>
<para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Transportable">
<summary>
<para>The shadow copy is to be transported and therefore should not be surfaced locally. </para>
<para>This attribute can be used explicitly by requesters when setting the context of a shadow copy, if the provider for
shadow copy supports transportable shadow copies.</para>
<para><b>Windows Server 2003, Standard Edition, Windows Server 2003, Web Edition, and Windows XP:</b> This attribute is not supported.
All editions of Windows Server 2003 SP1 support this attribute.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.NotSurfaced">
<summary>
<para>The shadow copy is not currently exposed. </para>
<para>Unless the shadow copy is explicitly exposed or mounted, this attribute is set for all shadow copies.</para>
<para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.NotTransacted">
<summary>
<para>The shadow copy is not transacted.</para>
<para>A requester can modify a shadow copy context with a bitwise OR of this attribute. By doing this, the requester instructs VSS to
disable built-in integration between VSS and transaction and resource managers.</para>
<para>Setting this attribute guarantees that the requester will not receive <see cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException"/> errors. However, it may
cause unwanted consequences, such as the loss of transactional integrity or even data loss.</para>
<para><b>Windows Server 2003 and Windows XP:</b> This value is not supported until Windows Vista.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.HardwareAssisted">
<summary>
<para>Indicates that a given provider is a hardware-based provider. </para>
<para>This attribute is automatically set for hardware-based providers.</para>
<para>This enumeration value cannot be used to manually set the context (using the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetContext(Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes)"/> method)
of a shadow copy by a bit mask (or bitwise OR) of this enumeration value and a valid shadow copy context value from
<see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/>.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Differential">
<summary>
<para>Indicates that a given provider uses differential data or a copy-on-write mechanism to implement shadow copies. </para>
<para>A requester can modify a shadow copy context with a bitwise OR of this attribute. By doing this, the requester instructs providers
to create a shadow copy using a differential implementation. If no shadow copy provider installed on the system supports the
requested attributes, a <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/> error will be returned to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddToSnapshotSet(System.String,System.Guid)"/>.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Plex">
<summary>
<para>Indicates that a given provider uses a PLEX or mirrored split mechanism to implement shadow copies. </para>
<para>A requester can modify a shadow copy context with a bitwise OR of this attribute. By doing this, the requester instructs the providers to create a shadow copy using a PLEX implementation. If no shadow copy provider installed on the system supports the requested
attributes, a <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/> error will be returned to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddToSnapshotSet(System.String,System.Guid)"/>.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Imported">
<summary>
<para>The shadow copy of the volume was imported onto this machine using the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.ImportSnapshots"/> method
rather than created using the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DoSnapshotSet"/> method. </para>
<para>This attribute is automatically set if a shadow copy is imported.</para>
<para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.ExposedLocally">
<summary>
<para>The shadow copy is locally exposed. If this bit flag and the <c>ExposedRemotely</c> bit flag are not set,
the shadow copy is hidden. </para>
<para>The attribute is automatically added to a shadow copy context upon calling the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.ExposeSnapshot(System.Guid,System.String,Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes,System.String)"/>
method to expose a shadow copy locally.</para>
<para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.ExposedRemotely">
<summary>
<para>The shadow copy is remotely exposed. If this bit flag and the <c>ExposedLocally</c> bit flag are not set, the shadow copy is hidden. </para>
<para>The attribute is automatically added to a shadow copy context upon calling the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.ExposeSnapshot(System.Guid,System.String,Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes,System.String)"/>
method to expose a shadow copy locally.</para>
<para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.AutoRecover">
<summary>
<para>Indicates that the writer will need to auto-recover the component in <c>CVssWriter::OnPostSnapshot</c>. </para>
<para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.RollbackRecovery">
<summary>
<para>Indicates that the writer will need to auto-recover the component in <c>CVssWriter::OnPostSnapshot</c> if the shadow copy is being used
for rollback (for data mining, for example). </para>
<para>A requester would set this flag in the shadow copy context to indicate that the shadow copy is being created for a non-backup
purpose such as data mining.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.DelayedPostSnapshot">
<summary>
<para>Reserved for system use.</para>
<para><b>Windows Vista, Windows Server 2003, and Windows XP:</b> This value is not supported until Windows Server 2008.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.TxFRecovery">
<summary>
<para>Indicates that TxF recovery should be enforced during shadow copy creation.</para>
<para><b>Windows Vista, Windows Server 2003, and Windows XP:</b> This value is not supported until Windows Server 2008.</para>
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssComponentFlags">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.VssComponentFlags"/> enumeration is used by writers to indicate support for auto-recovery.
</summary>
<remarks>For more information see <see href="http://msdn.microsoft.com/en-us/library/aa384681(VS.85).aspx">MSDN documentation on VSS_COMPONENT_FLAGS Enumeration</see></remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssComponentFlags.None">
<summary>
This value is reserved for operating systems that do not support the <see cref="T:Alphaleonis.Win32.Vss.VssComponentFlags"/> enumeration.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssComponentFlags.BackupRecovery">
<summary>
<para>
The writer will need write access to this component after the shadow copy has been created.
</para>
<para>
This flag is incompatible with <see cref="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Transportable"/>.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssComponentFlags.RollbackRecovery">
<summary>
<para>
If this is a rollback shadow copy (<see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/> enumeration value of
<see cref="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.RollbackRecovery"/>), the writer for this component will need
write access to this component after the shadow copy has been created.
</para>
<para>
This flag is incompatible with <see cref="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Transportable"/>.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssComponentFlags.NotSystemState">
<summary>
<para>
This component is not part of system state.
</para>
<para>
<b>Windows Server 2003:</b> This value is not supported until Windows Vista.
</para>
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssWMRestoreMethod">
<summary>
Represents information about how a writer wants its data to be restored.
</summary>
<remarks>This class is a container for the data returned by <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.RestoreMethod"/>.</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWMRestoreMethod.#ctor(Alphaleonis.Win32.Vss.VssRestoreMethod,System.String,System.String,Alphaleonis.Win32.Vss.VssWriterRestore,System.Boolean,System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWMRestoreMethod"/> class.
</summary>
<param name="restoreMethod">The restore method.</param>
<param name="service">The service.</param>
<param name="userProcedure">The user procedure.</param>
<param name="writerRestore">The writer restore.</param>
<param name="rebootRequired">if set to <c>true</c> a reboot is required.</param>
<param name="mappings">The mappings.</param>
<remarks>This constructor is normally not used by application code. Rather instances of <see cref="T:Alphaleonis.Win32.Vss.VssWMRestoreMethod"/> are
returned by various query methods.</remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWMRestoreMethod.Method">
<summary>
A <see cref="T:Alphaleonis.Win32.Vss.VssRestoreMethod"/> value that specifies file overwriting, the use of alternate locations specifying the method that
will be used in the restore operation.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWMRestoreMethod.Service">
<summary>
If the value of <see cref="P:Alphaleonis.Win32.Vss.VssWMRestoreMethod.Method"/> is <see cref="F:Alphaleonis.Win32.Vss.VssRestoreMethod.StopRestoreStart"/>, a pointer to a string containing the name
of the service that is started and stopped. Otherwise, the value is <see langword="null"/>.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWMRestoreMethod.UserProcedure">
<summary>
Pointer to the URL of an HTML or XML document describing to the user how the restore is to be performed. The value may be <see langword="null" />.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWMRestoreMethod.WriterRestore">
<summary>
A <see cref="T:Alphaleonis.Win32.Vss.VssWriterRestore"/> value specifying whether the writer will be involved in restoring its data.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWMRestoreMethod.RebootRequired">
<summary>A <see langword="bool"/> indicating whether a reboot will be required after the restore operation is complete.</summary>
<value><see langword="true"/> if a reboot will be required and <see langword="false"/> if it will not.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWMRestoreMethod.MappingCount">
<summary>The number of alternate mappings associated with the writer.</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType">
<summary>
<para>
The <see cref="T:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType"/> enumeration is used by writers to indicate their support of certain backup
operations—such as incremental or differential backup—on the basis of file sets (a specified file or files).
</para>
<para>
File sets stored in the Writer Metadata Document are tagged with a bit mask (or bitwise OR) of <see cref="T:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType"/>
values indicating the following:
<list type="bullet">
<item>
<description>
Whether the writer and the requester have to
evaluate a given file set for participation in the specified type of backup operations
</description>
</item>
<item>
<description>
Whether backing up the specified file will require a shadow copy
</description>
</item>
</list>
</para>
</summary>
<remarks>
For more information see the MSDN documentation on
<see href="http://msdn.microsoft.com/en-us/library/aa384951(VS.85).aspx">VSS_FILE_SPEC_BACKUP_TYPE Enumeration</see>
</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.Unknown">
<summary>
Used on operating systems where this enumeration is not supported, i.e. Windows XP.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.FullBackupRequired">
<summary>
<para>
A file set tagged with this value must be involved in all types of backup operations.
</para>
<para>
A writer tags a file set with this value to indicate to the requester that it expects a copy of the
current version of the file set to be available following the restore of any backup operation
with a <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of
<see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Full"/>.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.DifferentialBackupRequired">
<summary>
A writer tags a file set with this value to indicate to the requester that it
expects a copy of the current version of the file set to be available following
the restore of any backup operation with a <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of
<see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Differential"/>.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.IncrementalBackupRequired">
<summary>
A writer tags a file set with this value to indicate to the requester that it
expects a copy of the current version of the file set to be available following the
restore of any backup operation with a
<see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/>.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.LogBackupRequired">
<summary>
A writer tags a file set with this value to indicate to the requester that it
expects a copy of the current version of the file set to be available following the
restore of any backup operation with a
<see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Log"/>.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.FullSnapshotRequired">
<summary>
A file set tagged with this value must be backed up from a shadow copy of a volume
(and never from the original volume) when participating in a backup operation with a
<see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Full"/>.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.DifferentialSnapshotRequired">
<summary>
A file set tagged with this value must be backed up from a shadow copy of a volume
(and never from the original volume) when participating in a backup operation with a
<see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Differential"/>.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.IncrementalSnapshotRequired">
<summary>
A file set tagged with this value must be backed up from a shadow copy of a volume
(and never from the original volume) when participating in a backup operation with a
<see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/>.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.LogSnapshotRequired">
<summary>
A file set tagged with this value must be backed up from a shadow copy of a volume
(and never from the original volume) when participating in a backup operation with a
<see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Log"/>.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.AllBackupRequired">
<summary>
The default file backup specification type. A file set tagged with this value must always participate in backup and restore operations.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.AllSnapshotRequired">
<summary>
The shadow copy requirement for backup. A file set tagged with this value must always be backed up
from a shadow copy of a volume (and never from the original volume) when participating in a backup operation.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssFileRestoreStatus">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.VssFileRestoreStatus"/> enumeration defines the set of statuses of a file restore operation performed on
the files managed by a selected component or component set.
</summary>
<remarks>
See MSDN documentation on <c>VSS_FILE_RESTORE_STATUS</c> for more information.
</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssFileRestoreStatus.Undefined">
<summary>
<para>
The restore state is undefined.
</para>
<para>
This value indicates an error, or indicates that a restore operation has not yet started.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssFileRestoreStatus.None">
<summary>
<para>
No files were restored.
</para>
<para>
This value indicates an error in restoration that did not leave any restored files on disk.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssFileRestoreStatus.All">
<summary>
All files were restored. This value indicates success and should be set for each component that was restored successfully.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssFileRestoreStatus.Failed">
<summary>
<para>
The restore process failed.
</para>
<para>
This value indicates an error in restoration that did leave some restored files on disk. This means the components on disk are now corrupt.
</para>
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssUtils">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.VssUtils"/> class is a static utility class for accessing the platform specific
instances of the various VSS interfaces in a platform-independent manner.
</summary>
<remarks>
Use the <see cref="M:Alphaleonis.Win32.Vss.VssUtils.LoadImplementation"/> under normal circumstances to load
the correct assembly and create an instance of <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/> from that assembly. If you have
specific requirements on how the assembly should be loaded, or the instance created you are not required to use
these methods but can use the methods in this class for accessing the suggested assembly name to load, and load it manually.
In this case you need to create an instance of the class called <c>Alphaleonis.Win32.Vss.VssImplementation</c> from the platform specific
assembly. This class implements the <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/> interface, and has a public parameterless constructor.
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUtils.GetPlatformSpecificAssemblyShortName">
<summary>
Gets the short name of the platform specific assembly for the platform on which the assembly
is currently executing.
</summary>
<returns>the short name of the platform specific assembly for the platform on which the assembly
is currently executing.</returns>
<exception cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">The operating system could not be detected or is unsupported.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUtils.GetPlatformSpecificAssemblyName">
<summary>
Gets the full name of the platform specific assembly for the platform on which the assembly is currently executing.
</summary>
<returns>The full name of the platform specific assembly for the platform on which the assembly is currently executing.</returns>
<exception cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">The operating system could not be detected or is unsupported.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUtils.LoadImplementation">
<summary>
Loads the assembly containing the correct implementation of the <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/> interface
for the operating system on which the assembly is currently executing.
</summary>
<overloads>
Loads the assembly containing the correct implementation of the <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/> interface
for the operating system on which the assembly is currently executing, optionally allowing the specification
of an <see cref="T:System.AppDomain"/> into which to load the assembly.
</overloads>
<remarks>
<para>
The assembly will be loaded into the same <see cref="T:System.AppDomain"/> as the calling assembly.
</para>
<para>
The assemblies are loaded using strong name lookup. They need to be present in the code base directory
of the executing assembly, or installed in the GAC for the lookup to succeed.
</para>
</remarks>
<returns>An newly created instance of <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/> suitable for the
operating system on which the assembly is currently executing.</returns>
<exception cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">The operating system could not be detected or is unsupported.</exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssRebootRequiredException">
<summary>
<para>Exception thrown to indicate that the provider encountered an error that requires the user to restart the computer.</para>
</summary>
<remarks>
<note><b>Windows Server 2003 and Windows XP:</b>This exception is not supported until Windows Vista.</note>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssRebootRequiredException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRebootRequiredException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssRebootRequiredException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRebootRequiredException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssRebootRequiredException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRebootRequiredException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssRebootRequiredException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRebootRequiredException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException">
<summary>
Exception thrown to indicate that the volume has been added to the maximum number of shadow copy sets.
The specified volume was not added to the shadow copy set.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssSnapshotCompatibility">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotCompatibility"/> enumeration indicates which volume control or file I/O operations are disabled for the
volume that has been shadow copied.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotCompatibility.None">
<summary>None of the other flags.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotCompatibility.DisableDefrag">
<summary>The provider managing the shadow copies for a specified volume does not support defragmentation operations on that volume.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotCompatibility.DisableContentIndex">
<summary>The provider managing the shadow copies for a specified volume does not support content index operations on that volume.</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssError">
<summary>
<para>
The <see cref="T:Alphaleonis.Win32.Vss.VssError"/> enumeration represents error- and success codes that may be
returned by some Vss methods.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.Success">
<summary>Indication of a successful operation.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.AsyncCanceled">
<summary>
The asynchronous operation was cancelled.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.AsyncFinished">
<summary>
The asynchronous operation was completed successfully.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.AsyncPending">
<summary>
The asynchronous operation is still running.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.Unexpected">
<summary>
Unexpected error. The error code is logged in the error log file.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.BadState">
<summary>
A method call was made when the object was in an incorrect state
for that method.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.ProviderAlreadyRegistered">
<summary>
The provider has already been registered.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.ProviderNotRegistered">
<summary>
The specified identifier does not correspond to a registered provider.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.ProviderVeto">
<summary>
The provider was unable to perform the request at this time. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.ProviderInUse">
<summary>
The shadow copy provider is currently in use and cannot be unregistered.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.ObjectNotFound">
<summary>
The specified object was not found.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.VolumeNotSupported">
<summary>
No VSS provider indicates that it supports the specified volume.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.VolumeNotSupportedByProvider">
<summary>
The volume is not supported by the specified provider.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.ObjectAlreadyExists">
<summary>
The object already exists.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.UnexpectedProviderError">
<summary>
The provider returned an unexpected error code. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.InvalidXmlDocument">
<summary>
The given XML document is invalid. It is either incorrectly-formed XML or it does not match the schema.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.MaximumNumberOfVolumesReached">
<summary>
The maximum number of volumes has been added to the shadow copy set. The specified volume was not added to the shadow copy set.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.UnexpectedWriterError">
<summary>
VSS encountered problems while sending events to writers.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.SnapshotSetInProgress">
<summary>
Another shadow copy creation is already in progress. Please wait a few moments and try again.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.MaximumNumberOfSnapshotsReached">
<summary>
The volume has been added to the maximum number of shadow copy sets. The specified volume was not added to the shadow copy set.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.WriterInfrastructureError">
<summary>
An error was detected in the Volume Shadow Copy Service (VSS). The problem occurred while trying to contact VSS writers.
Please verify that the Event System service and the VSS service are running and check for associated errors in the event logs.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.WriterNotResponding">
<summary>
A writer did not respond to a GatherWriterStatus call. The writer may either have terminated
or it may be stuck. Check the system and application event logs for more information.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.WriterAlreadySubscribed">
<summary>
The writer has already sucessfully called the Subscribe function. It cannot call
subscribe multiple times.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.UnsupportedContext">
<summary>
The shadow copy provider does not support the specified shadow copy type.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.VolumeInUse">
<summary>
The specified shadow copy storage association is in use and so can't be deleted.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.MaximumDiffareaAssociationsReached">
<summary>
Maximum number of shadow copy storage associations already reached.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.InsufficientStorage">
<summary>
The system or provider has insufficient storage space. If possible delete any old or unnecessary persistent shadow copies and try again.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.NoSnapshotsImported">
<summary>
No shadow copies were successfully imported.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.SomeSnapshotsNotImportedSuccess">
<summary>
Some shadow copies were not succesfully imported.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.SomeSnapshotsNotImportedError">
<summary>
Some shadow copies were not succesfully imported.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.MaximumNumberOfRemoteMachinesReached">
<summary>
The maximum number of remote machines for this operation has been reached.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.RemoteServerUnavailable">
<summary>
The remote server is unavailable.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.RemoteServerUnsupported">
<summary>
The remote server is running a version of the Volume Shadow Copy Service that does not
support remote shadow-copy creation.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.RevertInProgress">
<summary>
A revert is currently in progress for the specified volume. Another revert
cannot be initiated until the current revert completes.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.RevertVolumeLost">
<summary>
The volume being reverted was lost during revert.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.RebootRequired">
<summary>
<para>The provider encountered an error that requires the user to restart the computer.</para>
<para><b>Windows Server 2003 and Windows XP:</b>This value is not supported until Windows Vista.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.TransactionFreezeTimeout">
<summary>
<para>The system was unable to freeze the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).</para>
<para><b>Windows Server 2003 and Windows XP:</b>This value is not supported until Windows Vista.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.TransactionThawTimeout">
<summary>
<para>The system was unable to thaw the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).</para>
<para><b>Windows Server 2003 and Windows XP:</b>This value is not supported until Windows Vista.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.WriterErrorInconsistentSnapshot">
<summary>
The shadow copy contains only a subset of the volumes needed by the writer to correctly back
up the application component.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.WriterOutOfResources">
<summary>
The writer ran out of memory or other system resources. The recommended way to handle this error code is
to wait ten minutes and then repeat the operation, up to three times.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.WriterTimeout">
<summary>
The writer operation failed because of a time-out between the Freeze and Thaw events.
The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.WriterErrorRetryable">
<summary>
The writer failed due to an error that would likely not occur if the entire backup, restore, or shadow copy creation
process was restarted. The recommended way to handle this error code is to wait ten minutes and then repeat
the operation, up to three times.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.WriterErrorNonRetryable">
<summary>
The writer experienced a non-transient error. If the backup process is retried,
the error is likely to reoccur.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.WriterErrorRecoveryFailed">
<summary>
The writer experienced an error while trying to recover the shadow-copy volume.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.BreakRevertIdFailed">
<summary>
The shadow copy set break operation failed because the disk/partition identities could not be reverted.
The target identity already exists on the machine or cluster and must be masked before this operation can succeed.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.LegacyProvider">
<summary>
This version of the hardware provider does not support this operation.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.BreakFailFromProvider">
<summary>
At least one of the providers in this Shadow Copy Set failed the break operation for a snapshot.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.AsrDiskAssignmentFailed">
<summary>
There are too few disks on this computer or one or more of the disks is too small.
Add or change disks so they match the disks in the backup, and try the restore again.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.AsrDiskRecreationFailed">
<summary>
Windows cannot create a disk on this computer needed to restore from the backup.
Make sure the disks are properly connected, or add or change disks, and try the restore again.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.AsrNoArcPath">
<summary>
The computer needs to be restarted to finish preparing a hard disk for restore. To continue, restart your computer and run the restore again.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.AsrMissingDynamicDisk">
<summary>
The backup failed due to a missing disk for a dynamic volume. Please ensure the disk is online and retry the backup.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.AsrSharedCriticalDiskError">
<summary>
Automated System Recovery failed the shadow copy, because a selected critical volume is located on a cluster shared disk.
This is an unsupported configuration.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.AsrDatadiskRdisk0">
<summary>
A data disk is currently set as active in BIOS. Set some other disk as active or use the DiskPart utility to clean the
data disk, and then retry the restore operation.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.AsrRdisk0TooSmall">
<summary>
The disk that is set as active in BIOS is too small to recover the original system disk.
Replace the disk with a larger one and retry the restore operation.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.AsrCriticalDisksTooSmall">
<summary>
There is not enough disk space on the system to perform the restore operation.
Add another disk or replace one of the existing disks and retry the restore operation.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.WriterStatusNotAvailable">
<summary>
<para>
The writer status is not available for one or more writers. A writer may have reached the maximum number of available backup
and restore sessions.
</para>
<para>
<b>Windows Vista, Windows Server 2003, and Windows XP:</b> This value is not supported.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.FlushWritesTimeout">
<summary>
The system was unable to flush I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssError.HoldWritesTimeout">
<summary>
The system was unable to hold I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssWriterStatusInfo">
<summary>
Represenation of the status for a specific writer.
</summary>
<remarks>This class acts as a container for the information returned from
<see href="http://msdn.microsoft.com/en-us/library/aa382680(VS.85).aspx">IVssBackupComponents.GetWriterStatus</see> in the original
VSS API</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterStatusInfo.#ctor(System.Guid,System.Guid,System.String,Alphaleonis.Win32.Vss.VssWriterState,Alphaleonis.Win32.Vss.VssError,System.Nullable{System.Int32},System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusInfo"/> class.
</summary>
<param name="instanceId">The writer instance id.</param>
<param name="writerClassId">The writer class id.</param>
<param name="writerName">Name of the writer.</param>
<param name="state">The state.</param>
<param name="failure">The failure.</param>
<param name="applicationErrorCode">The application error code.</param>
<param name="applicationErrorMessage">The application error message.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterStatusInfo.#ctor(System.Guid,System.Guid,System.String,Alphaleonis.Win32.Vss.VssWriterState,Alphaleonis.Win32.Vss.VssError)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusInfo"/> class.
</summary>
<param name="instanceId">The writer instance id.</param>
<param name="writerId">The writer class id.</param>
<param name="writerName">Name of the writer.</param>
<param name="state">The state.</param>
<param name="failure">The failure.</param>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.InstanceId">
<summary>
The instance id of the writer.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.ClassId">
<summary>
The identifier of the writer class.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.Name">
<summary>
The name of the writer.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.State">
<summary>
A <see cref="T:Alphaleonis.Win32.Vss.VssWriterState"/> value containing the state of the writer.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.Failure">
<summary>
A <see cref="T:Alphaleonis.Win32.Vss.VssError"/> value indicating the failure code (if any) of the writer.
</summary>
<remarks>
<para>
The following are the supported values for <see cref="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.Failure"/>:
<list type="table">
<listheader>
<term>Value</term>
<description>Meaning</description>
</listheader>
<item>
<term><see cref="F:Alphaleonis.Win32.Vss.VssError.Success"/></term>
<description>The writer was successful.</description>
</item>
<item>
<term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterErrorInconsistentSnapshot"/></term>
<description>The shadow copy contains only a subset of the volumes needed by the writer to correctly back up the application component.</description>
</item>
<item>
<term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterOutOfResources"/></term>
<description>The writer ran out of memory or other system resources. The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.</description>
</item>
<item>
<term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterTimeout"/></term>
<description>The writer operation failed because of a time-out between the Freeze and Thaw events. The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.</description>
</item>
<item>
<term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterErrorRetryable"/></term>
<description>The writer failed due to an error that would likely not occur if the entire backup, restore, or shadow copy creation process was restarted. The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.</description>
</item>
<item>
<term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterErrorNonRetryable"/></term>
<description>The writer operation failed because of an error that might recur if another shadow copy is created.</description>
</item>
<item>
<term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterNotResponding"/></term>
<description>The writer is not responding.</description>
</item>
<item>
<term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterStatusNotAvailable"/></term>
<description>
<para>
The writer status is not available for one or more writers. A writer may have reached the maximum number of available backup and restore sessions.
</para>
<para>
<b>Windows Vista, Windows Server 2003 and Windows XP:</b> This value is not supported.
</para>
</description>
</item>
</list>
</para>
</remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.ApplicationErrorCode">
<summary>
Gets the return code that the writer passed for the <c>hrApplication</c> parameter of the <c>CVssWriterEx2::SetWriterFailureEx</c> method.
</summary>
<remarks>
<note>This property requires Windows 7 or Windows Server 2008 R2 and will be <see langword="null"/> on earlier operating systems.</note>
</remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.ApplicationErrorMessage">
<summary>
Gets the application failure message that the writer passed for the <c>wszApplicationMessage</c> parameter of the <c>SetWriterFailureEx</c> method.
</summary>
<remarks>
<note>This property requires Windows 7 or Windows Server 2008 R2 and will be <see langword="null"/> on earlier operating systems.</note>
</remarks>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssProtectionLevel">
<summary>
Defines the set of volume shadow copy protection levels.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionLevel.OriginalVolume">
<summary>
Specifies that I/O to the original volume must be maintained at the expense of shadow copies.
This is the default protection level. Shadow copies might be deleted if both of the following conditions occur:
<list type="bullet">
<item>
<description>
A write to the original volume occurs.
</description>
</item>
<item>
<description>
The integrity of the shadow copy cannot be maintained for some reason, such as a failure to
write to the shadow copy storage area or a failure to allocate sufficient memory.
</description>
</item>
</list>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionLevel.Snapshot">
<summary>
Specifies that shadow copies must be maintained at the expense of I/O to the original volume.
All I/O to the original volume will fail if both of the following conditions occur:
<list type="bullet">
<item>
<description>
A write to the original volume occurs.
</description>
</item>
<item>
<description>
The corresponding write to the shadow copy storage area cannot be completed for some reason,
such as a failure to write to the shadow copy storage area or a failure to allocate sufficient memory.
</description>
</item>
</list>
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssHardwareOptions">
<summary>
Defines shadow copy LUN flags.
</summary>
<remarks>
Only supported on Windows Server 2008.
</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.MaskLuns">
<summary>
The shadow copy LUN will be masked from the host.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.MakeReadWrite">
<summary>
The shadow copy LUN will be exposed to the host as a read-write volume.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.RevertIdentityAll">
<summary>
The disk identifiers of all of the shadow copy LUNs will be reverted to that of the
original LUNs. However, if any of the original LUNs are present on the system, the operation will
fail and none of the identifiers will be reverted.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.RevertIdentityNone">
<summary>
None of the disk identifiers of the shadow copy LUNs will be reverted.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.OnLunStateChangeNotifyReadWrite">
<summary>
The shadow copy LUNs will be converted permanently to read-write.
This flag is set only as a notification for the provider; no provider action is required.
For more information, see the <c>IVssHardwareSnapshotProviderEx::OnLunStateChange</c> method.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.OnLunStateChangeNotifyLunPreRecovery">
<summary>
The shadow copy LUNs will be converted temporarily to read-write and are about to undergo TxF recovery
or VSS auto-recovery. This flag is set only as a notification for the provider; no provider action is required.
For more information, see the <c>IVssHardwareSnapshotProviderEx::OnLunStateChange method</c>.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.OnLunStateChangeNotifyLunPostRecovery">
<summary>
The shadow copy LUNs have just undergone TxF recovery or VSS auto-recovery and have been converted back to
read-only. This flag is set only as a notification for the provider; no provider action is required.
For more information, see the <c>IVssHardwareSnapshotProviderEx::OnLunStateChange method</c>.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.OnLunStateChangeDoMaskLuns">
<summary>
The provider must mask shadow copy LUNs from this computer.
For more information, see the <c>IVssHardwareSnapshotProviderEx::OnLunStateChange method</c>.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.IVssSnapshotManagement">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.IVssSnapshotManagement"/> interface provides a method that returns an interface to further configure a shadow copy provider.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssSnapshotManagement.GetDifferentialSoftwareSnapshotManagementInterface">
<summary>
Gets an instance of the differential software snapshot management interface to further configure the system provider.
</summary>
<remarks>
<para>
<note>
<para>
<b>Windows XP:</b> This method is not supported until Windows 2003.
</para>
</note>
</para>
</remarks>
<returns>An instance of the differential software snapshot management interface to further configure the system provider.</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssSnapshotManagement.GetMinDiffAreaSize">
<summary>
Returns the current minimum size of the shadow copy storage area.
</summary>
<remarks>
<para>
The shadow copy storage area minimum size is a per-computer setting. Prior to Windows Server 2003 Service Pack 1 (SP1), this
was fixed at 100 MB. With Windows Server 2003 SP1, the shadow copy storage area has a minimum size of 300 MB and can be
increased in 300 MB increments up to 3000 MB (3 GB). This setting is stored in the <c>MinDiffAreaFileSize</c> value of type
<c>REG_DWORD</c> in <c>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\VolSnap</c> (the value is the size, in MB).
</para>
<para>
<note>
<para>
<b>Windows XP and Windows 2003:</b> This method is not supported until Windows 2003 SP1.
</para>
</note>
</para>
</remarks>
<returns>The current minimum size of the shadow copy storage area.</returns>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">
<summary>
Exception thrown to indicate that the requested object did not exists.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssObjectNotFoundException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssObjectNotFoundException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssObjectNotFoundException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssObjectNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException">
<summary>
Exception thrown to indicate The system was unable to flush I/O writes.
</summary>
<remarks>
This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException">
<summary>
Exception indicating that the resynchronization destination contained a volume that was not explicitly included.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnselectedVolumeException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnselectedVolumeException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException"/> class.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnselectedVolumeException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException"/> class.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnselectedVolumeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is <see langword="null"/>.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssRestoreTarget">
<summary>
<para>
The <see cref="T:Alphaleonis.Win32.Vss.VssRestoreTarget"/> enumeration is used by a writer at restore time to
indicate how all the files included in a selected component, and all the files in any
component set it defines, are to be restored.
</para>
<para>
Setting a restore target modifies or overrides the restore method set during backup (see <see cref="T:Alphaleonis.Win32.Vss.VssRestoreMethod"/>).
</para>
</summary>
<remarks>For more information see the MSDN documentation on the VSS_RESTORE_TARGET enumeration.</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreTarget.Undefined">
<summary>
<para>No target is defined.</para>
<para>This value indicates an error on the part of the writer.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreTarget.Original">
<summary>
<para>
This is the default restore target.
</para>
<para>
This value indicates that the restoration of the files included in a selected component
(or the component set defined by that component) should proceed according to the original
restore method specified at backup time by a <see cref="T:Alphaleonis.Win32.Vss.VssRestoreMethod"/> value.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreTarget.Alternate">
<summary>
<para>
The files are restored to a location determined from an existing alternate location mapping.
</para>
<para>
The restore target should be set to <see cref="F:Alphaleonis.Win32.Vss.VssRestoreTarget.Alternate"/> only when
alternate location mappings have been set for all the files managed by
a selected component or component set.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreTarget.Directed">
<summary>
<para>
Use directed targeting by the writer at restore time to restore a file.
</para>
<para>
Directed targeting allows a writer to control, on a file-by-file basis, how a file is
restored—indicating how much of a file is to be restored and into which files the backed-up file is to be restored.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreTarget.OriginalLocation">
<summary>
<para>
The files are restored to the location at which they were at backup time, even if the original restore
method that was specified at backup time was <see cref="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreToAlternateLocation"/>.
</para>
<para>
<b>Windows Server 2003 and Windows XP:</b> This value is not supported.
</para>
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.IVssComponent">
<summary>
<para>
Interface containing methods for examining and modifying information about components contained in a requester's Backup Components Document.
</para>
</summary>
<remarks>
<para>
<see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> objects can be obtained only for those components that have been explicitly added
to the Backup Components Document during a backup operation by the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>
method.
</para>
<para>
Information about components explicitly added during a restore operation using
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddRestoreSubcomponent(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String,System.String)"/> are not available through the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/>
interface.
</para>
<para>
For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa382871(VS.85).aspx">the MSDN documentation on
the IVssComponent Interface</see>.
</para>
</remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.AdditionalRestores">
<summary>
The <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.AdditionalRestores"/> is used by a writer during incremental or differential restore
operations to determine whether a given component will require additional restore operations to completely retrieve it,
but can also be called by a requester.
</summary>
<value>
If <see langword="true"/>, additional restores will occur for the
current component. If <see langword="false"/>, additional restores will not occur.
</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.BackupOptions">
<summary>
<para>
The backup options specified to the writer that manages the currently selected component or component set
by a requester using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetBackupOptions(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/>.
</para>
</summary>
<value>The backup options for the current writer.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.BackupStamp">
<summary>The backup stamp string stored by a writer for a given component.</summary>
<value>The backup stamp indicating the time at which the component was backed up.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.BackupSucceeded">
<summary>
The status of a complete attempt at backing up all the files of a selected component or component set as a
<see cref="T:Alphaleonis.Win32.Vss.VssFileRestoreStatus"/> enumeration.
</summary>
<value>
<see langword="true"/> if the backup was successful and <see langword="false"/> if it was not.
</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.ComponentName">
<summary>The logical name of this component.</summary>
<value>The logical name of this component.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.ComponentType">
<summary>The type of this component in terms of the <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.ComponentType"/> enumeration.</summary>
<value>The type of this component.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.FileRestoreStatus">
<summary>
The status of a completed attempt to restore all the files of a selected component or component set
as a <see cref="T:Alphaleonis.Win32.Vss.VssFileRestoreStatus"/> enumeration.
</summary>
<value>
A value of the <see cref="T:Alphaleonis.Win32.Vss.VssFileRestoreStatus"/> enumeration that specifies whether all files were successfully restored.
</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.LogicalPath">
<summary>The logical path of this component.</summary>
<value>The logical path of this component.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.PostRestoreFailureMsg">
<summary>The failure message generated by a writer while handling the <c>PostRestore</c> event if one was set.</summary>
<value>The failure message that describes an error that occurred while processing the <c>PostRestore</c> event.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.PreRestoreFailureMsg">
<summary>The failure message generated by a writer while handling the <c>PreRestore</c> event if one was set.</summary>
<value>The failure message that describes an error that occurred while processing the <c>PreRestore</c> event.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.PreviousBackupStamp">
<summary>
A previous backup stamp loaded by a requester in the Backup Components Document. The value is used by a writer when
deciding if files should participate in differential or incremental backup operation.
</summary>
<value>
The time stamp of a previous backup so that a differential or incremental backup can be correctly implemented.
</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.RestoreOptions">
<summary>The restore options specified to the current writer by a requester using
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRestoreOptions(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/>.</summary>
<value>The restore options of the writer.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.RestoreTarget">
<summary>The restore target (in terms of the <see cref="T:Alphaleonis.Win32.Vss.VssRestoreTarget"/> enumeration) for the current component. Can only be called during a restore operation.</summary>
<value>A value from the <see cref="T:Alphaleonis.Win32.Vss.VssRestoreTarget"/> enumeration containing the restore target information.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.IsSelectedForRestore">
<summary>Determines whether the current component has been selected to be restored.</summary>
<value>If the returned value of this parameter is <see langword="true"/>, the component has been selected to be restored. If <see langword="false"/>, it has not been selected.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.AlternateLocationMappings">
<summary>A collection of mapping information for the file set's alternate location for file restoration.</summary>
<value>A read-only list containing the alternate location to which files were actually restored. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note></value>
<remarks>See <see href="http://msdn.microsoft.com/en-us/library/aa383473(VS.85).aspx">the MSDN documentation on the IVssComponent::GetAlternateLocationMapping method</see> for more information.</remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.DirectedTargets">
<summary>
Information stored by a writer, at backup time, to the Backup Components Document to indicate that when a file is to be
restored, it (the source file) should be remapped. The file may be restored to a new restore target and/or ranges of its data
restored to different locations with the restore target.
</summary>
<value>A read-only list containing the directed targets of this component. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note></value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.NewTargets">
<summary>
The new file restoration locations for the selected component or component set.
</summary>
<value>A read-only list contianing the new file restoration locations for the selected component or component set. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note></value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.PartialFiles">
<summary>
Information about any partial files associated with this component.
</summary>
<value>A read-only list containing information about any partial files associated with this component. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note></value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.DifferencedFiles">
<summary>
Information about the file sets (specified file or files) to participate in an incremental or differential backup or restore as a
differenced file — that is, backup and restores associated with it are to be implemented as if entire files are copied to and from
backup media (as opposed to using partial files).
</summary>
<remarks><b>Windows XP:</b> This method requires Windows Server 2003 or later</remarks>
<value>
A read only list containing the diffrenced files associated with this component. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note>
</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.RestoreSubcomponents">
<summary>The subcomponents associated with this component.</summary>
<value>A read only list containing the subcomponents associated with this component. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note></value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.IsAuthoritativeRestore">
<summary>
Gets a value indicating whether a requester has marked the restore of a component as authoritative for a replicated data store.
</summary>
<value>
<see langword="true"/> if the restore is authoritative; otherwise, <see langword="false"/>.
</value>
<remarks>
<para>
A writer indicates that it supports authoritative restore by setting the
<see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.AuthoritativeRestore"/> flag in its backup schema mask.
</para>
<para>
For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa384610(VS.85).aspx">Setting VSS Restore Options.</see>
</para>
<para>
<note>
<para>
<b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see langword="false"/>
on unsupported operating systems.
</para>
</note>
</para>
</remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.PostSnapshotFailureMsg">
<summary>
Gets the <c>PostSnapshot</c> failure message string that a writer has set for a given component.
</summary>
<remarks>
<para>
Both writers and requesters can call this method.
</para>
<para>
<note>
<para>
<b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see langword="false"/>
on unsupported operating systems.
</para>
</note>
</para>
</remarks>
<value>A string containing the failure message that describes an error that occurred while processing a PostSnapshot event, or <see langword="null"/>
if no value was set or the method is not supported on the current operating system.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.PrepareForBackupFailureMsg">
<summary>
Gets the <c>PrepareForBackup</c> failure message string that a writer has set for a given component.
</summary>
<value>A string containing the failure message that describes an error that occurred while processing a PrepareForBackup event,
or <see langword="null"/> if no failure message was set for this component, or if the property is not supported on the
current operating system.</value>
<remarks>
<para>
Both writers and requesters can call this method.
</para>
<para>
<note>
<para>
<b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see langword="false"/>
on unsupported operating systems.
</para>
</note>
</para>
</remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.RestoreName">
<summary>
Obtains the logical name assigned to a component that is being restored.
</summary>
<value>
A string containing the restore name for the component, or <see langword="null"/> if the operation
is not supported on the current operating system.
</value>
<remarks>
<para>
The <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.RestoreName"/> property can only be accessed during a restore operation.
</para>
<para>
A writer indicates that it supports this method by setting the <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.RestoreRename"/>
flag in its backup schema mask.
</para>
<para>
For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa384610(VS.85).aspx">
Setting VSS Restore Options</see>.
</para>
<para>
<note>
<para>
<b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see langword="false"/>
on unsupported operating systems.
</para>
</note>
</para>
</remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.RollForwardRestorePoint">
<summary>
Obtains the restore point for a partial roll-forward operation.
</summary>
<value>
A string specifying the roll-forward restore point,
or <see langword="null"/> if the property is not supported in the current context.
</value>
<remarks>
<para>
The <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.RollForwardRestorePoint"/> property can only be accessed during a restore operation.
</para>
<para>
A writer indicates that it supports this method by setting the <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.RollForwardRestore"/>
flag in its backup schema mask.
</para>
<para>
For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa384610(VS.85).aspx">
Setting VSS Restore Options</see>.
</para>
<para>
<note>
<para>
<b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see cref="F:Alphaleonis.Win32.Vss.VssRollForwardType.Undefined"/>
on unsupported operating systems.
</para>
</note>
</para>
</remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.RollForwardType">
<summary>
Obtains the roll-forward operation type for a component.
</summary>
<value>
A <see cref="T:Alphaleonis.Win32.Vss.VssRollForwardType"/> enumeration value indicating the type of roll-forward operation to be performed,
or <see cref="F:Alphaleonis.Win32.Vss.VssRollForwardType.Undefined"/> if the property is not supported in the current context.
</value>
<remarks>
<para>
The <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.RollForwardType"/> property can only be accessed during a restore operation.
</para>
<para>
A writer indicates that it supports this method by setting the <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.RollForwardRestore"/>
flag in its backup schema mask.
</para>
<para>
For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa384610(VS.85).aspx">
Setting VSS Restore Options</see>.
</para>
<para>
<note>
<para>
<b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see cref="F:Alphaleonis.Win32.Vss.VssRollForwardType.Undefined"/>
on unsupported operating systems.
</para>
</note>
</para>
</remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssComponent.Failure">
<summary>
VSS requesters read this property to retrieve component-level errors reported by writers.
VSS writers set this property to report errors at the component level.
</summary>
<returns>An instance of <see cref="T:Alphaleonis.Win32.Vss.VssComponentFailure"/> containing the information reported by the writer.</returns>
<remarks>Minimum supported client: Windows 7, Minimum supported server: Windows Server 2008 R2</remarks>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.IVssAsyncResult">
<summary>
Represents the status of an asynchronous operation performed by the VSS framework.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssAsyncResult.Cancel">
<summary>
Cancels an incomplete asynchronous operation.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException">
<summary>
Exception indicating that the creation of a shadow copy is in progress, and only one shadow copy creation
operation can be in progress at one time. Either wait to try again or return with a failure.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssNonRetryableWriterException">
<summary>
Exception indicating that the writer operation failed because of an error that might recur if another shadow copy is created.
For more information, see <see href="http://msdn.microsoft.com/en-us/library/cc325736(VS.85).aspx">Event and Error Handling Under VSS</see>.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssNonRetryableWriterException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssNonRetryableWriterException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssNonRetryableWriterException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssNonRetryableWriterException"/> class.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssNonRetryableWriterException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssNonRetryableWriterException"/> class.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssNonRetryableWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssNonRetryableWriterException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is <see langword="null"/>.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.IVssImplementation">
<summary>
<c>IVssImplementation</c> provides an interface to the global methods of the VSS API compiled for a specific
platform.
</summary>
<remarks>
An instance of <c>IVssImplementation</c> can be obtained either by using the factory methods of
<see cref="T:Alphaleonis.Win32.Vss.VssUtils"/> for dynamically loading the suitable assembly containing the correct implementation (preferred),
or by statically referencing the correct platform-specific assembly and manually creating an instance of <c>VssImplementation</c>
from that assembly.
</remarks>
<seealso cref="T:Alphaleonis.Win32.Vss.VssUtils"/>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssImplementation.CreateVssBackupComponents">
<summary>
The <c>CreateVssBackupComponents</c> method creates an <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> interface object
for the current implementation and returns a reference to it.
</summary>
<remarks>
The calling application is responsible for calling <c>Dispose"</c> to release the
resources held by the <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> instance when it is no longer needed.
</remarks>
<returns>A reference to the newly created <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> instance.</returns>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<seealso cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssImplementation.IsVolumeSnapshotted(System.String)">
<summary>
The <c>IsVolumeSnapshotted</c> function determines whether any shadow copies exist for the specified volume.
</summary>
<remarks>
Use <see cref="M:Alphaleonis.Win32.Vss.IVssImplementation.GetSnapshotCompatibility(System.String)"/> to determine whether certain volume control or file I/O operations are
disabled for the given volume if a shadow copy of it exists.
</remarks>
<param name="volumeName">
Name of the volume. The name of the volume to be checked must be in one of the following formats:
<list type="bullet">
<item><description>The path of a volume mount point with a backslash (\)</description></item>
<item><description>A drive letter with backslash (\), for example, D:\</description></item>
<item><description>A unique volume name of the form \\?\Volume{GUID}\ (where GUID is the unique global identifier of the volume) with a backslash (\)</description></item>
</list>
</param>
<returns><c>true</c> if the volume has a shadow copy, and <c>false</c> if the volume does not have a shadow copy.</returns>
<exception cref="T:System.ArgumentException">One of the parameters is not valid.</exception>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified volume was not found.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">Unexpected provider error. The error code is logged in the event log file.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssImplementation.GetSnapshotCompatibility(System.String)">
<summary>
Determines whether certain volume control or file I/O operations are disabled for the given volume if a shadow copy of it exists.
</summary>
<param name="volumeName">
Name of the volume. The name of the volume to be checked must be in one of the following formats:
<list type="bullet">
<item><description>The path of a volume mount point with a backslash (\)</description></item>
<item><description>A drive letter with backslash (\), for example, D:\</description></item>
<item><description>A unique volume name of the form \\?\Volume{GUID}\ (where GUID is the unique global identifier of the volume) with a backslash (\)</description></item>
</list>
</param>
<returns>
A bit mask (or bitwise OR) of <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotCompatibility"/> values that indicates whether certain
volume control or file I/O operations are disabled for the given volume if a shadow copy of it exists.
</returns>
<remarks>
<para>
Use <see cref="M:Alphaleonis.Win32.Vss.IVssImplementation.IsVolumeSnapshotted(System.String)"/> to determine whether a snapshot exists for the specified volume or not.
</para>
<para>
If no volume control or file I/O operations are disabled for the selected volume, then the shadow copy capability of the
selected volume returned will <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotCompatibility.None"/>.
</para>
</remarks>
<seealso cref="M:Alphaleonis.Win32.Vss.IVssImplementation.IsVolumeSnapshotted(System.String)"/>
<exception cref="T:System.ArgumentException">One of the parameters is not valid.</exception>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified volume was not found.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">Unexpected provider error. The error code is logged in the event log file.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssImplementation.ShouldBlockRevert(System.String)">
<summary>
Checks the registry for writers that should block revert operations on the specified volume.
</summary>
<param name="volumeName">
The name of the volume. The name must be in one of the following formats:
<list type="bullet">
<item><description>The path of a volume mount point with a backslash (\)</description></item>
<item><description>A drive letter with backslash (\), for example, D:\</description></item>
<item><description>A unique volume name of the form \\?\Volume{GUID}\ (where GUID is the unique global identifier of the volume) with a backslash (\)</description></item>
</list>
</param>
<returns>
<see langword="true" /> if the volume contains components from any writers that are listed in the registry as writers that should block
revert operations; otherwise, <see langword="false"/>
</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssImplementation.CreateVssExamineWriterMetadata(System.String)">
<summary>
The <b>CreateVssExamineWriterMetadata</b> function creates a new <see cref="T:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata"/> instance from an
XML document for the current implementation.
</summary>
<param name="xml">A string containing a Writer Metadata Document with which to initialize the returned <see cref="T:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata"/> object.</param>
<remarks>
This method attempts to load the returned <see cref="T:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata"/> object with metadata previously stored by a call to
<see cref="M:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.SaveAsXml"/>. Users should not tamper with this metadata document.
</remarks>
<returns>a <see cref="T:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata"/> instance initialized with the specified XML document.</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssImplementation.GetSnapshotManagementInterface">
<summary>
Gets a snapshot management interface for the current implementation.
</summary>
<returns>A snapshot management interface for the current implementation.</returns>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssRestoreType">
<summary>The <see cref="T:Alphaleonis.Win32.Vss.VssRestoreType"/> enumeration is used by a requester to indicate the type of restore operation it is about to perform.</summary>
<remarks>
<para>A requester sets the type of a restore operation using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRestoreState(Alphaleonis.Win32.Vss.VssRestoreType)"/>.</para>
<!-- <para>A writer can retrieve the type of a restore operation by calling CVssWriter::GetRestoreType.</para> -->
</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreType.Undefined">
<summary>
<para>No restore type is defined.</para>
<para>This indicates an error on the part of the requester.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreType.ByCopy">
<summary>The default restore type: A requester restores backed-up data to the original volume from a backup medium.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreType.Import">
<summary>
<para>
A requester does not copy data from a backup medium, but imports a transportable shadow copy
and uses this imported volume for operations such as data mining.
</para>
<para>
<b>Windows Server 2003, Standard Edition and Windows Server 2003, Web Edition:</b> This value is not supported. All editions of Windows Server 2003 SP1 support this value.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreType.Other">
<summary>A restore type not currently enumerated. This value indicates an application error.</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssLegacyProviderException">
<summary>
Exception indicating that this version of the hardware provider does not support this operation.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssLegacyProviderException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssLegacyProviderException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssLegacyProviderException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssLegacyProviderException"/> class.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssLegacyProviderException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssLegacyProviderException"/> class.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssLegacyProviderException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssLegacyProviderException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is <see langword="null"/>.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssVolumeProperties">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.VssVolumeProperties"/> class contains the properties of a shadow copy source volume.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssVolumeProperties.#ctor(System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeProperties"/> class.
</summary>
<param name="volumeName">Name of the volume.</param>
<param name="volumeDisplayName">Display name of the volume.</param>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssVolumeProperties.VolumeName">
<summary>
Gets the volume name, in <c>\\?\Volume{GUID}\</c> format.
</summary>
<value>The volume name, in <c>\\?\Volume{GUID}\</c> format.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssVolumeProperties.VolumeDisplayName">
<summary>
Gets a string that can be displayed to the user containing the shortest mount point (for example C:\).
</summary>
<value>A string that can be displayed to the user containing the shortest mount point (for example C:\).</value>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssDiffVolumeProperties">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.VssDiffVolumeProperties"/> structure describes a shadow copy storage area volume.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssDiffVolumeProperties.#ctor(System.String,System.String,System.Int64,System.Int64)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDiffVolumeProperties"/> class.
</summary>
<param name="volumeName">Name of the volume.</param>
<param name="volumeDisplayName">Display name of the volume.</param>
<param name="volumeFreeSpace">The volume free space.</param>
<param name="volumeTotalSpace">The volume total space.</param>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDiffVolumeProperties.VolumeName">
<summary>
Gets the shadow copy storage area volume name, in <c>\\?\Volume{GUID}\</c> format.
</summary>
<value>The shadow copy storage area volume name, in <c>\\?\Volume{GUID}\</c> format.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDiffVolumeProperties.VolumeDisplayName">
<summary>
Gets a string that can be displayed to a user, for example <c>C:\</c>, for the shadow copy storage area volume.
</summary>
<value>A string that can be displayed to a user, for example <c>C:\</c>, for the shadow copy storage area volume.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDiffVolumeProperties.VolumeFreeSpace">
<summary>
Gets the free space, in bytes, on the shadow copy storage area volume.
</summary>
<value>The free space, in bytes, on the shadow copy storage area volume.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDiffVolumeProperties.VolumeTotalSpace">
<summary>
Gets the total space, in bytes, on the shadow copy storage area volume.
</summary>
<value>The total space, in bytes, on the shadow copy storage area volume..</value>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssBadStateException">
<summary>
Exception class indicating that the vss object referenced was not in a correct state for the requested operation.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssBadStateException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssBadStateException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssBadStateException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssBadStateException"/> class with the specified error message.
</summary>
<param name="message">The error message.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssBadStateException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssBadStateException"/> class with the specified error message
and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message.</param>
<param name="innerException">The inner exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssBadStateException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssBadStateException"/> class with serialized data.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssSourceType">
<summary>The <see cref="T:Alphaleonis.Win32.Vss.VssSourceType"/> enumeration specifies the type of data that a writer manages.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSourceType.Undefined">
<summary><para>The source of the data is not known.</para><para>This indicates a writer error, and the requester should report it.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSourceType.TransactedDB">
<summary>The source of the data is a database that supports transactions, such as Microsoft SQL Server.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSourceType.NonTransactedDB">
<summary>The source of the data is a database that does not support transactions.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSourceType.Other">
<summary>
<para>Unclassified source type—data will be in a file group.</para>
<para>This is the default source type.</para>
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssSnapshotContext">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> enumeration enables a requester using <see cref="O:Alphaleonis.Win32.Vss.IVssBackupComponents.SetContext"/> to specify how a
shadow copy is to be created, queried, or deleted and the degree of writer involvement.
<see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/>::SetContext" method) may be modified by a bitmask that contains a valid combination of
<see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/> and <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> enumeration values.
</summary>
<remarks><see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> is defined as a static class defining the base <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/>
combination of values representing the VSS_CTX_XXXXXX constants defined in the VSS API.
</remarks>
<seealso cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.Backup">
<summary>
The standard backup context. Specifies an auto-release, nonpersistent shadow copy in which writers are involved in the creation.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.FileShareBackup">
<summary>
Specifies a nonpersistent and auto-release shadow copy created without writer involvement.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.NasRollback">
<summary>
<para>Specifies a persistent and non-auto-release shadow copy without writer involvement. This context should be used when there is no need for writer involvement to ensure that files are in a consistent state at the time of the shadow copy. </para>
<para>Lightweight automated file rollback mechanisms or persistent shadow copies of file shares or data volumes that are not expected to contain any system-related files or databases might run under this context. For example, a requester could use this context for creating a shadow copy of a NAS volume hosting documents and simple user shares. Those types of data do not need writer involvement to create a consistent shadow copy.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.AppRollback">
<summary>
<para>Specifies a persistent and non-auto-release shadow copy with writer involvement. This context is designed to be used when writers are needed to ensure that files are in a well-defined state prior to shadow copy. </para>
<para>Automated file rollback mechanisms of system volumes and shadow copies to be used in data mining or restore operations might run under this context. This context is similar to VSS_CTX_BACKUP but allows a requester more control over the persistence of the shadow copy.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.ClientAccessible">
<summary>
<para>Specifies a read-only, client-accessible shadow copy supporting Shadow Copies for Shared Folders and created without writer involvement. Only the system provider (the default provider available on the system) can create this type of shadow copy. </para>
<para>Most requesters will want to use the <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.NasRollback"/> context for persistent, non-auto-release shadow copies without writer involvement.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.ClientAccessibleWriters">
<summary>
<para>Specifies a read-only, client-accessible shadow copy supporting Shadow Copies for Shared Folders and created with writer involvement. Only the system provider (the default provider available on the system) can create this type of shadow copy. </para>
<para>Most requesters will want to use the <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.AppRollback"/> context for persistent, non-auto-release shadow copies with writer involvement.</para>
<para><b>Windows Server 2003 and Windows XP:</b> This context is not supported by Windows Server 2003 and Windows XP.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.All">
<summary>
All types of currently live shadow copies are available for administrative operations, such as shadow copy queries
(see the Query method in <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/>). <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.All"/> is a valid context for all VSS interfaces except
<see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/>::StartSnapshotSet and <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/>::DoSnapshotSet.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssProviderType">
<summary>The <see cref="T:Alphaleonis.Win32.Vss.VssProviderType"/> enumeration specifies the provider type.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProviderType.Unknown">
<summary>
<para>
The provider type is unknown.
</para>
<para>
This indicates an error in the application or the VSS service, or that no provider is available.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProviderType.System">
<summary>The default provider that ships with Windows.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProviderType.Software">
<summary>A software-based provider.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProviderType.Hardware">
<summary>A hardware-based provider.</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssRecoveryOptions">
<summary>
Used by a requester to specify how a resynchronization operation is to be performed.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRecoveryOptions.None">
<summary>
No options.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRecoveryOptions.RevertIdentityAll">
<summary>
After the resynchronization operation is complete, the signature of each target LUN should be identical to that of the original LUN that was used to create the shadow copy.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRecoveryOptions.NoVolumeCheck">
<summary>
Volume safety checks should not be performed.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssWMDependency">
<summary>
<see cref="T:Alphaleonis.Win32.Vss.VssWMDependency"/> is used to determine the writer ID, logical path, and component name of components that must be restored or
backed up along with the target component.</summary>
<remarks>Note that a dependency does not indicate an order of preference between the component with the documented dependencies and the components it depends on. A dependency merely indicates that the component and the components it depends on must always be backed up or restored together.
<note><b>Windows XP:</b> This class is not supported until Windows Server 2003</note>
</remarks>
<seealso href="http://msdn.microsoft.com/en-us/library/aa384301(VS.85).aspx"/>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWMDependency.#ctor(System.Guid,System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWMDependency"/> class.
</summary>
<param name="writerId">The writer id.</param>
<param name="logicalPath">The logical path.</param>
<param name="componentName">Name of the component.</param>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWMDependency.WriterId">
<summary>
The class ID of a writer containing a component that the current component depends on.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWMDependency.LogicalPath">
<summary>
The logical path of a component that the current component depends on.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWMDependency.ComponentName">
<summary>
Retrieves the name of a component that the current component depends on.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.Resources.LocalizedStrings">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.AlphaVSSRequiresAtLeastWindowsXP">
<summary>
Looks up a localized string similar to AlphaVSS requires at least Windows XP..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.AnotherLUNResynchronizationOperationIsAlreadyInProgress">
<summary>
Looks up a localized string similar to Another LUN resynchronization operation is already in progress..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.AnUnexpectedErrorOccuredTheErrorCodeIsLogg">
<summary>
Looks up a localized string similar to An unexpected error occurred. The error code is logged in the error log file..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.AnUnexpectedErrorOccurredDuringCommunicationWithWriters">
<summary>
Looks up a localized string similar to An unexpected error occurred during communication with writers..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.DeletionOfSnapshotFailedSeeInnerExceptionF">
<summary>
Looks up a localized string similar to Deletion of snapshot failed. See inner exception for details. .
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.DeletionOfSnapshotsFailed">
<summary>
Looks up a localized string similar to Deletion of snapshots failed.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ExpectedProviderError">
<summary>
Looks up a localized string similar to Expected provider error. Check the event log for details..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.FailedToDetectArchitectureOfRunningOperati">
<summary>
Looks up a localized string similar to Failed to detect architecture of running operating system..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.IA64ArchitectureIsNotSupported">
<summary>
Looks up a localized string similar to IA64 architecture is not supported..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.InvalidXMLDocumentCheckTheEventLogForDetails">
<summary>
Looks up a localized string similar to Invalid XML document. Check the event log for details..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.MaximumDiffAreaAssociationsReached">
<summary>
Looks up a localized string similar to The maximum number of shadow copy storage areas has been added to the shadow copy source volume..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.RequestedOperationUnsupportedByOS">
<summary>
Looks up a localized string similar to The requested operation is not supported on the current operating system..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.SystemWasUnableToFreezeDtcOrKtm">
<summary>
Looks up a localized string similar to System was unable to freeze the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheCreationOfAShadowCopyIsAlreadyInProgress">
<summary>
Looks up a localized string similar to The creation of a shadow copy is already in progress..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheMaximumNumberOfVolumesHasAlreadyBeenAddedToTheShadowCopySet">
<summary>
Looks up a localized string similar to The maximum number of volumes has already been added to the shadow copy set..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheOperationIsNotSupportedUnderTheCurrentContext">
<summary>
Looks up a localized string similar to The operation is not supported under the current context..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheProviderEncounteredAnErrorThatRequiresTheUserToRestartTheComputer">
<summary>
Looks up a localized string similar to The provider encountered an error that requires the user to restart the computer..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheProviderReturnedAnUnexpectedErrorCode">
<summary>
Looks up a localized string similar to The provider returned an unexpected error code..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheRequestedIdentifierDoesNotCorrespondToARegisteredProvider">
<summary>
Looks up a localized string similar to The requested identifier does not correspond to a registered provider..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheRequestedObjectDoesNotExist">
<summary>
Looks up a localized string similar to The requested object does not exist..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheRequestedObjectWasADuplicate">
<summary>
Looks up a localized string similar to The requested object was a duplicate..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheSystemOrProviderHasInsufficientStorageSpace">
<summary>
Looks up a localized string similar to The system or provider has insufficient storage space. If possible delete any old or unnecessary persistent shadow copies and try again..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheSystemWasUnableToFlushIOWrites">
<summary>
Looks up a localized string similar to The system was unable to flush I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheSystemWasUnableToHoldIOWrites">
<summary>
Looks up a localized string similar to The system was unable to hold I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVolumeAlreadyHasARevertInProgress">
<summary>
Looks up a localized string similar to The volume already has a revert in progress..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVolumeDoesNotSupportTheRequestedOperation">
<summary>
Looks up a localized string similar to The volume does not support the requested operation, or no provider supports it..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVolumeHasAlreadyBeenAddedToTheMaximumNumberOfShadowCopySets">
<summary>
Looks up a localized string similar to The volume has already been added to the maximum number of shadow copy sets..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVolumeIsNotSupportedByTheSpecifiedProvider">
<summary>
Looks up a localized string similar to The volume is not supported by the specified provider..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVolumeWasInUseAndCouldNotBeLocked">
<summary>
Looks up a localized string similar to The volume was in use and could not be locked..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVSSObjectWasInAnIncorrectStateForTheRequestedOperation">
<summary>
Looks up a localized string similar to The VSS object was in an incorrect state for the requested operation..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheWriterInfrastructureIsNotOperatingProperly">
<summary>
Looks up a localized string similar to The writer infrastructure is not operating properly. Check that the Event Service and VSS have been started, and check for errors associated with those services in the error log..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheWriterIsNotResponding">
<summary>
Looks up a localized string similar to The writer is not responding..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires01DetectedOperatingSystemWas23">
<summary>
Looks up a localized string similar to This operation requires {0}{1}. Detected operating system was: {2}{3}..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires01OrLaterDetectedOperatingSystemWas23">
<summary>
Looks up a localized string similar to This operation requires {0}{1} or later. Detected operating system was: {2}{3}..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires0DetectedOperatingSystemWas1">
<summary>
Looks up a localized string similar to This operation requires {0}. Detected operating system was: {1}..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires0OrLaterDetectedOperatingSystemWas1">
<summary>
Looks up a localized string similar to This operation requires {0} or later. Detected operating system was: {1}..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires0WithAtLeastServicePack1DetectedOperatingSystemWas23">
<summary>
Looks up a localized string similar to This operation requires {0} with at least Service Pack {1}. Detected operating system was: {2}{3}..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires0WithAtLeastServicePack1Or2WithAtLeastServicePack3DetectedOperatingSystemWas45">
<summary>
Looks up a localized string similar to This operation requires {0} with at least Service Pack {1}, or {2} with at least service pack {3}. Detected operating system was: {4}{5}..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisVersionOfTheHardwareProviderDoesNotSupportThisOperation">
<summary>
Looks up a localized string similar to This version of the hardware provider does not support this operation..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.UnexpectedSystemError">
<summary>
Looks up a localized string similar to Unexpected system error..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.UnsupportedOperatingSystemExceptionMessage">
<summary>
Looks up a localized string similar to The requested method is not supported on the current operating system, or the loaded assembly is targeted for a different operating system than the one on which it is running..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssCannotRevertDiskIdExceptionMessage">
<summary>
Looks up a localized string similar to The MBR signature or GPT ID for one or more disks could not be set to the intended value. Check the Application event log for more information..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssInconsistentSnapshotWriterExceptionMessage">
<summary>
Looks up a localized string similar to The shadow copy contains only a subset of the volumes needed by the writer to correctly back up the application component..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssNonRetryableWriterExceptionMessage">
<summary>
Looks up a localized string similar to The writer operation failed because of an error that might recur if another shadow copy is created..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssOutOfResourcesExceptionMessage">
<summary>
Looks up a localized string similar to The writer ran out of memory or other system resources..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssPartialFailureWriterExceptionMessage">
<summary>
Looks up a localized string similar to The writer is reporting one or more component-level errors..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssRetryableWriterExceptionMessage">
<summary>
Looks up a localized string similar to The writer failed due to an error that would likely not occur if the entire backup, restore, or shadow copy creation process was restarted.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssSnapshotNotInSetExceptionMessage">
<summary>
Looks up a localized string similar to The specified snapshot specifies a shadow copy that does not exist in the Backup Components Document..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssTimeoutWriterExceptionMessage">
<summary>
Looks up a localized string similar to The writer operation failed because of a time-out between the Freeze and Thaw events..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssUnselectedVolumeExceptionMessage">
<summary>
Looks up a localized string similar to The resynchronization destination contained a volume that was not explicitly included..
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssWriterStatusNotAvailableExceptionMessage">
<summary>
Looks up a localized string similar to Writer status is not available for one or more writers. A writer may have reached the maximum number of available backup and restore sessions..
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.IVssWMComponent">
<summary>
<see cref="T:Alphaleonis.Win32.Vss.IVssWMComponent"/> is a class that allows access to component information stored in a Writer Metadata Document.
Instances of <see cref="T:Alphaleonis.Win32.Vss.IVssWMComponent"/> are obtained by enumerating <cee cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Components"/>.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssWMComponent.GetIcon">
<summary>
Gets a buffer containing the binary data for a displayable icon representing the component.
</summary>
<remarks>
The buffer contents should use the same format as the standard icon (.ico) files. If the writer that created
the component did not choose to specify an icon, the value will be <see langword="null"/>.
</remarks>
<returns>A buffer containing the binary data for a displayable icon representing the component. </returns>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.Type">
<summary>
The component type.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.LogicalPath">
<summary>
The logical path of the component.
</summary>
<value>A string containing the logical path of the component, which may be <see langword="null"/>.
<remarks>There are no restrictions on the characters that can appear in a non-NULL logical path.</remarks></value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.ComponentName">
<summary>
The name of the component. A component name string cannot be <see langword="null"/>.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.Caption">
<summary>
The description of the component. A caption string can be <see langword="null" />.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.RestoreMetadata">
<summary>
Boolean that indicates whether there is private metadata associated with the restoration of the component.
</summary>
<value>
The Boolean is <see langword="true"/> if there is private metadata associated with the restoration
of the components, and <see langword="false"/> if there is not.
</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.NotifyOnBackupComplete">
<summary>Reserved for future use.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.Selectable">
<summary>
Boolean that indicates (for component mode operations) if the component is selectable for backup.
</summary>
<remarks>
The value of <see cref="P:Alphaleonis.Win32.Vss.IVssWMComponent.Selectable"/> helps determine whether a requester has the option of including or excluding
a given component in backup operations.
</remarks>
<value>
<see langword="true"/> if the component is selectable for backup and <see langword="false"/> if it is not.
</value>
<seealso href="http://msdn.microsoft.com/en-us/library/aa384680(VS.85).aspx">VSS_COMPONENTINFO structure on MSDN</seealso>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.SelectableForRestore">
<summary>
Boolean that indicates (for component-mode operations) whether the component is selectable for restore.
</summary>
<remarks>
<para>
<see cref="P:Alphaleonis.Win32.Vss.IVssWMComponent.SelectableForRestore"/> allows the requester to determine whether this component can be individually selected
for restore if it had earlier been implicitly included in the backup.
</para>
<para>
<note>
<b>Windows XP:</b> This requires Windows Server 2003 or later. It will always return false on earlier operating systems.
</note>
</para>
</remarks>
<value>
The Boolean is <see langword="true"/> if the component is selectable for restore and <see langword="false"/> if it is not.
</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.ComponentFlags">
<summary>
A bit mask (or bitwise OR) of values of the <see cref="T:Alphaleonis.Win32.Vss.VssComponentFlags"/> enumeration, indicating the
features this component supports.
</summary>
<remarks>
<note>
<b>Windows Server 2003 and Windows XP:</b> Before Windows Server 2003 SP1, this member is reserved for system use and
will always return <see cref="F:Alphaleonis.Win32.Vss.VssComponentFlags.None"/>.
</note>
</remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.Files">
<summary>
The file descriptors associated with this component.
</summary>
<remarks>This collection represents the method <c>GetFile()</c> of <c>IVssWMComponent</c> in the VSS API</remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.DatabaseFiles">
<summary>
A list of <see cref="T:Alphaleonis.Win32.Vss.VssWMFileDescriptor"/> instances containing information about the database backup component files.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.DatabaseLogFiles">
<summary>
A list of file descriptors for the log files associated with the specified database backup component.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.Dependencies">
<summary>
A list of <see cref="T:Alphaleonis.Win32.Vss.VssWMDependency"/> instances containing accessors for obtaining information about explicit writer-component
dependencies of one of the current components.
</summary>
<remarks>This will always be an empty list on operating systems earlier than Windows Server 2003.</remarks>
</member>
<member name="T:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement"/> interface contains methods that allow applications to query and
manage shadow copy storage areas generated by the system shadow copy provider.
</summary>
<remarks>
<para>
<note>
<para>
<b>Windows XP: </b> This interface requires Windows Server 2003 or later.
</para>
</note>
</para>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.AddDiffArea(System.String,System.String,System.Int64)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.AddDiffArea(System.String,System.String,System.Int64)"/> method adds a shadow copy storage area association for the specified volume.
If the association is not supported, an exception will be thrown.
</summary>
<param name="volumeName">
<para>
Name of the volume that will be the source of shadow copies that is to be associated
with a shadow copy storage area on the <paramref name="volumeName"/> volume.
</para>
<para>
The name of the volume must be in one of the following formats:
<list type="bullet">
<item>
<description>
The path of a volume mount point with a backslash (\)
</description>
</item>
<item>
<description>
A drive letter with backslash (\), for example, <c>D:\</c>
</description>
</item>
<item>
<description>
A unique volume name of the form <c>\\?\Volume{GUID}\</c> (where
GUID is the unique global identifier of the volume) with a backslash (\)
</description>
</item>
</list>
</para>
</param>
<param name="diffAreaVolumeName">
<para>
Name of the volume that
will contain the shadow copy storage area to be associated with the
<paramref name="volumeName"/> volume.
</para>
<para>
The name of the volume must be in one of the following formats:
<list type="bullet">
<item>
<description>
The path of a volume mount point with a backslash (\)
</description>
</item>
<item>
<description>
A drive letter with backslash (\), for example, <c>D:\</c>
</description>
</item>
<item>
<description>
A unique volume name of the form <c>\\?\Volume{GUID}\</c> (where
GUID is the unique global identifier of the volume) with a backslash (\)
</description>
</item>
</list>
</para>
</param>
<param name="maximumDiffSpace">
<para>
Specifies the maximum size, in bytes, of the shadow copy storage area on the volume.
This value must be at least 300 MB, up to the system-wide limit.
</para>
<para>
Windows Server 2003: Prior to
Windows Server 2003 SP1 the shadow copy storage area size was fixed at 100 MB.
</para>
</param>
<remarks>
<para>
<note>
<para>
<b>Windows XP:</b> This method is not supported until Windows Server 2003.
</para>
</note>
</para>
</remarks>
<exception cref="T:System.UnauthorizedAccessException">Caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">The caller is out of memory or other system resources.</exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.ArgumentNullException">One of the arguments was <see langword="null"/></exception>
<exception cref="T:System.SystemException">Unexpected error. The error code is logged in the error log file.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectAlreadyExistsException">The association between the <paramref name="volumeName"/> and <paramref name="diffAreaVolumeName"/> volumes already exists.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException">The <paramref name="diffAreaVolumeName"/> volume is not NTFS or has insufficient free space.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException">The maximum number of shadow copy storage areas has been added to the shadow copy source volume. The specified shadow copy storage volume was not associated with the specified shadow copy source volume.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.ChangeDiffAreaMaximumSize(System.String,System.String,System.Int64)">
<summary>
The <see cref="O:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.ChangeDiffAreaMaximumSize"/> method updates the shadow copy storage area maximum size
for a certain volume. This may not have an immediate effect.
</summary>
<overloads>
Updates the shadow copy storage area maximum size
for a certain volume. This method has two overloads.
</overloads>
<param name="volumeName">
<para>
Name of the volume that is the source of shadow copies that are associated with a shadow copy
storage area on the <paramref name="diffAreaVolumeName"/> volume.
</para>
<para>
The name of the volume must be in one of the following formats:
<list type="bullet">
<item>
<description>
The path of a volume mount point with a backslash (\)
</description>
</item>
<item>
<description>
A drive letter with backslash (\), for example, <c>D:\</c>
</description>
</item>
<item>
<description>
A unique volume name of the form <c>\\?\Volume{GUID}\</c> (where
GUID is the unique global identifier of the volume) with a backslash (\)
</description>
</item>
</list>
</para>
</param>
<param name="diffAreaVolumeName">
<para>
Name of the volume that contains the shadow copy storage area associated with
the <paramref name="volumeName"/> volume.
</para>
<para>
The name of the volume must be in one of the following formats:
<list type="bullet">
<item>
<description>
The path of a volume mount point with a backslash (\)
</description>
</item>
<item>
<description>
A drive letter with backslash (\), for example, <c>D:\</c>
</description>
</item>
<item>
<description>
A unique volume name of the form <c>\\?\Volume{GUID}\</c> (where
GUID is the unique global identifier of the volume) with a backslash (\)
</description>
</item>
</list>
</para>
</param>
<param name="maximumDiffSpace">
Specifies the maximum size, in bytes, for the shadow copy storage area to
use for the volume. If this value is zero, the shadow copy storage area will be disabled.
</param>
<exception cref="T:System.UnauthorizedAccessException">Caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">The caller is out of memory or other system resources.</exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.ArgumentNullException">One of the arguments was <see langword="null"/></exception>
<exception cref="T:System.SystemException">Unexpected error. The error code is logged in the error log file.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The association between the <paramref name="volumeName"/> and <paramref name="diffAreaVolumeName"/> volumes was not found.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInsufficientStorageException">The <paramref name="diffAreaVolumeName"/> volume does not have sufficient free space.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssVolumeInUseException">A shadow copy is currently using the shadow copy storage area.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.QueryDiffAreasForSnapshot(System.Guid)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.QueryDiffAreasForSnapshot(System.Guid)"/> method queries shadow copy storage areas in use by the
original volume associated with the input shadow copy.
</summary>
<param name="snapshotId">The snapshot id.</param>
<returns>A list of <see cref="T:Alphaleonis.Win32.Vss.VssDiffAreaProperties"/> describing the shadow copy storage areas in use by the
shadow copy specified.</returns>
<exception cref="T:System.UnauthorizedAccessException">Caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">The caller is out of memory or other system resources.</exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.ArgumentNullException">One of the arguments was <see langword="null"/></exception>
<exception cref="T:System.SystemException">Unexpected error. The error code is logged in the error log file.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.QueryDiffAreasForVolume(System.String)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.QueryDiffAreasForVolume(System.String)"/> method queries shadow copy storage areas in use by the volume specified.
</summary>
<param name="volumeName">
<para>
Name of the volume that contains shadow copy storage areas.
</para>
<para>
The name of the volume must be in one of the following formats:
<list type="bullet">
<item>
<description>
The path of a volume mount point with a backslash (\)
</description>
</item>
<item>
<description>
A drive letter with backslash (\), for example, <c>D:\</c>
</description>
</item>
<item>
<description>
A unique volume name of the form <c>\\?\Volume{GUID}\</c> (where
GUID is the unique global identifier of the volume) with a backslash (\)
</description>
</item>
</list>
</para>
</param>
<returns>A list containing <see cref="T:Alphaleonis.Win32.Vss.VssDiffAreaProperties"/> objects describing the shadow
copy storage areas in use by the volume specified.</returns>
<exception cref="T:System.UnauthorizedAccessException">Caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">The caller is out of memory or other system resources.</exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.ArgumentNullException">One of the arguments was <see langword="null"/></exception>
<exception cref="T:System.SystemException">Unexpected error. The error code is logged in the error log file.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.QueryDiffAreasOnVolume(System.String)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.QueryDiffAreasOnVolume(System.String)"/> method queries shadow copy storage areas that physically
reside on the given volume
</summary>
<param name="volumeName">
<para>
Name of the volume that contains shadow copy storage areas.
</para>
<para>
The name of the volume must be in one of the following formats:
<list type="bullet">
<item>
<description>
The path of a volume mount point with a backslash (\)
</description>
</item>
<item>
<description>
A drive letter with backslash (\), for example, <c>D:\</c>
</description>
</item>
<item>
<description>
A unique volume name of the form <c>\\?\Volume{GUID}\</c> (where
GUID is the unique global identifier of the volume) with a backslash (\)
</description>
</item>
</list>
</para>
</param>
<returns>A list of <see cref="T:Alphaleonis.Win32.Vss.VssDiffAreaProperties"/> objects describing the
shadow copy storage areas that physically reside on the given volume.</returns>
<exception cref="T:System.UnauthorizedAccessException">Caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">The caller is out of memory or other system resources.</exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.ArgumentNullException">One of the arguments was <see langword="null"/></exception>
<exception cref="T:System.SystemException">Unexpected error. The error code is logged in the error log file.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.QueryVolumesSupportedForDiffAreas(System.String)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.QueryVolumesSupportedForDiffAreas(System.String)"/> method queries volumes that support shadow copy storage
areas (including volumes with disabled shadow copy storage areas).
</summary>
<param name="originalVolumeName">
<para>
Name of the original volume that is the source of the shadow copies.
</para>
<para>
The name of the volume must be in one of the following formats:
<list type="bullet">
<item>
<description>
The path of a volume mount point with a backslash (\)
</description>
</item>
<item>
<description>
A drive letter with backslash (\), for example, <c>D:\</c>
</description>
</item>
<item>
<description>
A unique volume name of the form <c>\\?\Volume{GUID}\</c> (where
GUID is the unique global identifier of the volume) with a backslash (\)
</description>
</item>
</list>
</para>
</param>
<returns>A list of <see cref="T:Alphaleonis.Win32.Vss.VssDiffVolumeProperties"/> describing the volumes that support shadow
copy storage areas (including volumes with disabled shadow copy storage areas).</returns>
<exception cref="T:System.UnauthorizedAccessException">Caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">The caller is out of memory or other system resources.</exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.ArgumentNullException">One of the arguments was <see langword="null"/></exception>
<exception cref="T:System.SystemException">Unexpected error. The error code is logged in the error log file.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.ChangeDiffAreaMaximumSize(System.String,System.String,System.Int64,System.Boolean)">
<summary>
The <see cref="O:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.ChangeDiffAreaMaximumSize"/> method updates the shadow copy storage area maximum size
for a certain volume. This may not have an immediate effect.
</summary>
<param name="volumeName">
<para>
Name of the volume that is the source of shadow copies that are associated with a shadow copy
storage area on the <paramref name="diffAreaVolumeName"/> volume.
</para>
<para>
The name of the volume must be in one of the following formats:
<list type="bullet">
<item>
<description>
The path of a volume mount point with a backslash (\)
</description>
</item>
<item>
<description>
A drive letter with backslash (\), for example, <c>D:\</c>
</description>
</item>
<item>
<description>
A unique volume name of the form <c>\\?\Volume{GUID}\</c> (where
GUID is the unique global identifier of the volume) with a backslash (\)
</description>
</item>
</list>
</para>
</param>
<param name="diffAreaVolumeName">
<para>
Name of the volume that contains the shadow copy storage area associated with
the <paramref name="volumeName"/> volume.
</para>
<para>
The name of the volume must be in one of the following formats:
<list type="bullet">
<item>
<description>
The path of a volume mount point with a backslash (\)
</description>
</item>
<item>
<description>
A drive letter with backslash (\), for example, <c>D:\</c>
</description>
</item>
<item>
<description>
A unique volume name of the form <c>\\?\Volume{GUID}\</c> (where
GUID is the unique global identifier of the volume) with a backslash (\)
</description>
</item>
</list>
</para>
</param>
<param name="maximumDiffSpace">
Specifies the maximum size, in bytes, for the shadow copy storage area to
use for the volume. If this value is zero, the shadow copy storage area will be disabled.
</param>
<param name="isVolatile">
<para>
<see langword="true"/> to indicate that the effect of calling the
<see cref="O:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.ChangeDiffAreaMaximumSize"/> method should not continue if
the computer is rebooted; otherwise, <see langword="false"/>.
</para>
<para>
If the <paramref name="maximumDiffSpace"/> parameter is zero, the
<paramref name="isVolatile"/> parameter must be <see langword="false"/>.
</para>
</param>
<exception cref="T:System.UnauthorizedAccessException">Caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">The caller is out of memory or other system resources.</exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.ArgumentNullException">One of the arguments was <see langword="null"/></exception>
<exception cref="T:System.SystemException">Unexpected error. The error code is logged in the error log file.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The association between the <paramref name="volumeName"/> and <paramref name="diffAreaVolumeName"/> volumes was not found.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInsufficientStorageException">The <paramref name="diffAreaVolumeName"/> volume does not have sufficient free space.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssVolumeInUseException">A shadow copy is currently using the shadow copy storage area.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.ClearVolumeProtectFault(System.String)">
<summary>
Clears the protection fault state for the specified volume.
</summary>
<para>
Name of the volume that will be the source of shadow copies that is to be associated
with a shadow copy storage area on the <paramref name="volumeName"/> volume.
</para>
<param name="volumeName">
<para>The name of the volume. This parameter is required and cannot be <see langword="null"/>.</para>
<para>
The name of the volume must be in one of the following formats:
<list type="bullet">
<item>
<description>
The path of a volume mount point with a backslash (\)
</description>
</item>
<item>
<description>
A drive letter with backslash (\), for example, <c>D:\</c>
</description>
</item>
<item>
<description>
A unique volume name of the form <c>\\?\Volume{GUID}\</c> (where
GUID is the unique global identifier of the volume) with a backslash (\)
</description>
</item>
</list>
</para>
</param>
<remarks>
<para>
The <see cref="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.ClearVolumeProtectFault(System.String)"/> method dismounts the volume and resets the
volume's protection fault member to <see langword="false"/> to allow normal I/O to continue
on the volume. If the volume is not in a faulted state, this method does nothing.
</para>
<para>
<note>
<para>
<b>Windows XP, Windows Server 2003 and Windows Vista:</b> This method requires Windows Server 2008.
</para>
</note>
</para>
</remarks>
<exception cref="T:System.UnauthorizedAccessException">Caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">The caller is out of memory or other system resources.</exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.ArgumentNullException">One of the arguments was <see langword="null"/></exception>
<exception cref="T:System.NotImplementedException">The provider for the volume does not support shadow copy protection.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified volume was not found.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.DeleteUnusedDiffAreas(System.String)">
<summary>
Deletes all shadow copy storage areas (also called diff areas) on the specified volume that are not in use.
</summary>
<param name="diffAreaVolumeName">
<para>The name of the volume. This parameter is required and cannot be <see langword="null"/>.</para>
<para>
The name of the volume must be in one of the following formats:
<list type="bullet">
<item>
<description>
The path of a volume mount point with a backslash (\)
</description>
</item>
<item>
<description>
A drive letter with backslash (\), for example, <c>D:\</c>
</description>
</item>
<item>
<description>
A unique volume name of the form <c>\\?\Volume{GUID}\</c> (where
GUID is the unique global identifier of the volume) with a backslash (\)
</description>
</item>
</list>
</para>
</param>
<remarks>
<para>
Unused shadow copy storage area files are found on storage area volumes when the associated original
volume is offline due to a protection fault. In certain cases, the original volume may be
permanently lost, and calling the <see cref="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.DeleteUnusedDiffAreas(System.String)"/> method is the only way to
recover the abandoned storage area space.
</para>
<para>
<note>
<para>
<b>Windows XP, Windows Server 2003 and Windows Vista:</b> This method requires Windows Server 2008.
</para>
</note>
</para>
</remarks>
<exception cref="T:System.UnauthorizedAccessException">Caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">The caller is out of memory or other system resources.</exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.ArgumentNullException">One of the arguments was <see langword="null"/></exception>
<exception cref="T:System.NotImplementedException">The provider for the volume does not support shadow copy protection.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified volume was not found.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.GetVolumeProtectionLevel(System.String)">
<summary>
Gets the shadow copy protection level and status for the specified volume.
</summary>
<param name="volumeName">
<para>The name of the volume. This parameter is required and cannot be <see langword="null"/>.</para>
<para>
The name of the volume must be in one of the following formats:
<list type="bullet">
<item>
<description>
The path of a volume mount point with a backslash (\)
</description>
</item>
<item>
<description>
A drive letter with backslash (\), for example, <c>D:\</c>
</description>
</item>
<item>
<description>
A unique volume name of the form <c>\\?\Volume{GUID}\</c> (where
GUID is the unique global identifier of the volume) with a backslash (\)
</description>
</item>
</list>
</para>
</param>
<returns>A <see cref="T:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo"/> class instance that contains information about the volume's
shadow copy protection level.</returns>
<exception cref="T:System.UnauthorizedAccessException">Caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">The caller is out of memory or other system resources.</exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.ArgumentNullException">One of the arguments was <see langword="null"/></exception>
<exception cref="T:System.NotImplementedException">The provider for the volume does not support shadow copy protection.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified volume was not found.</exception>
<para>
<note>
<para>
<b>Windows XP, Windows Server 2003 and Windows Vista:</b> This method requires Windows Server 2008.
</para>
</note>
</para>
<remarks>
<para>
The <see cref="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.GetVolumeProtectionLevel(System.String)"/> method gets information about the volume's current protection level.
If the volume is in a faulted state, the <see cref="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.ProtectionFault"/> member of the
<see cref="T:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo"/> structure contains the current protection fault,
and the <see cref="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.FailureStatus"/> member contains the reason why the volume
is in a faulted state. If the volume is not in a faulted state,
the <see cref="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.ProtectionFault"/> and <see cref="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.FailureStatus"/>
members will be zero.
</para>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.SetVolumeProtectionLevel(System.String,Alphaleonis.Win32.Vss.VssProtectionLevel)">
<summary>
Sets the shadow copy protection level for an original volume or a shadow copy storage area volume.
</summary>
<param name="volumeName">
<para>The name of the volume. This parameter is required and cannot be <see langword="null"/>.</para>
<para>
The name of the volume must be in one of the following formats:
<list type="bullet">
<item>
<description>
The path of a volume mount point with a backslash (\)
</description>
</item>
<item>
<description>
A drive letter with backslash (\), for example, <c>D:\</c>
</description>
</item>
<item>
<description>
A unique volume name of the form <c>\\?\Volume{GUID}\</c> (where
GUID is the unique global identifier of the volume) with a backslash (\)
</description>
</item>
</list>
</para>
</param>
<param name="protectionLevel">
A value from the <see cref="T:Alphaleonis.Win32.Vss.VssProtectionLevel"/> enumeration that specifies the shadow
copy protection level.
</param>
<exception cref="T:System.UnauthorizedAccessException">Caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">The caller is out of memory or other system resources.</exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.ArgumentNullException">One of the arguments was <see langword="null"/></exception>
<exception cref="T:System.NotImplementedException">The provider for the volume does not support shadow copy protection.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified volume was not found.</exception>
<remarks>
<para>
The <see cref="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.SetVolumeProtectionLevel(System.String,Alphaleonis.Win32.Vss.VssProtectionLevel)"/> method checks the current shadow copy protection
level of the volume. If the volume is in a faulted state and
<see cref="F:Alphaleonis.Win32.Vss.VssProtectionLevel.OriginalVolume"/> is specified for the
<paramref name="protectionLevel"/> parameter, <see cref="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.SetVolumeProtectionLevel(System.String,Alphaleonis.Win32.Vss.VssProtectionLevel)"/> dismounts
the volume before setting the protection level.
</para>
<para>
If the current protection level of the volume is the same as the value of the
<paramref name="protectionLevel"/> parameter,
<see cref="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.SetVolumeProtectionLevel(System.String,Alphaleonis.Win32.Vss.VssProtectionLevel)"/> does nothing.
</para>
<para>
<note>
<para>
<b>Windows XP, Windows Server 2003 and Windows Vista:</b> This method requires Windows Server 2008.
</para>
</note>
</para>
</remarks>
</member>
<member name="T:Alphaleonis.Win32.Vss.IVssBackupComponents">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> class is used by a requester to poll writers about file status and to run backup/restore operations.
</summary>
<seealso cref="T:Alphaleonis.Win32.Vss.VssUtils"/>
<seealso cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/>
<remarks>
<para>
A <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> object can be used for only a single backup, restore, or Query operation.
</para>
<para>
After the backup, restore, or Query operation has either successfully finished or been explicitly terminated, a requester must
release the <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> object by calling <c>Dispose()</c>.
A <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> object must not be reused. For example, you cannot perform a backup or restore operation with the
same <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> object that you have already used for a Query operation.
</para>
<para>
For information on how to retrieve an instance of <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> for the current operating system, see
<see cref="T:Alphaleonis.Win32.Vss.VssUtils"/> and <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/>.
</para>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AbortBackup">
<summary>
<para>The <b>AbortBackup</b> method notifies VSS that a backup operation was terminated.</para>
<para>
This method must be called if a backup operation terminates after the creation of a shadow copy set with
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.StartSnapshotSet"/> and before <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DoSnapshotSet"/>returns.
</para>
<para>
If AbortBackup is called and no shadow copy or backup operations are underway, it is ignored.
</para>
</summary>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddAlternativeLocationMapping(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String,System.String,System.Boolean,System.String)">
<summary>
The <b>AddAlternativeLocationMapping</b> method is used by a requester to indicate that an alternate location
mapping was used to restore all the members of a file set in a given component.
</summary>
<param name="writerId">Globally unique identifier (GUID) of the writer class that exported the component.</param>
<param name="componentType">Type of the component.</param>
<param name="logicalPath">
<para>String containing the logical path to the component. The logical path can be <see langword="null"/>.</para>
<para>There are no restrictions on the characters that can appear in a non-<c>null</c> logical path.</para>
</param>
<param name="componentName">The component name.</param>
<param name="path">
<para>
The path to the directory that originally contained the
file to be relocated. This path must be local to the VSS machine.
</para>
<para>
The path can contain environment variables (for example, %SystemRoot%) but cannot contain wildcard characters.
UNC paths are not supported.
</para>
<para>
There is no requirement that the path end with a backslash ("\"). It is up to applications that retrieve
this information to check.
</para>
</param>
<param name="filespec">String containing the original file specification. A file specification cannot
contain directory specifications (for example, no backslashes) but can contain the ? and * wildcard characters.</param>
<param name="recursive">
Boolean indicating whether the path specified by the <paramref name="path"/> parameter identifies only a single
directory or if it indicates a hierarchy of directories to be traversed recursively. The Boolean is <c>true</c> if the
path is treated as a hierarchy of directories to be traversed recursively and <c>false</c> if not.
</param>
<param name="destination">The name of the directory where the file will be relocated. This path must be local to the VSS machine.
UNC paths are not supported.</param>
<exception cref="T:System.ArgumentException">One of the parameters is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified component does not exist.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)">
<summary>
The <b>AddComponent</b> method is used to explicitly add to the backup set in the Backup Components Document all required
components (nonselectable for backup components without a selectable for backup ancestor), and such optional
(selectable for backup) components as the requester considers necessary. Members of component sets (components with
a selectable for backup ancestor) are implicitly included in the backup set, but are not explicitly added to the Backup
Components Document.
</summary>
<param name="instanceId">Identifies a specific instance of a writer.</param>
<param name="writerId">Writer class identifier.</param>
<param name="componentType">Identifies the type of the component.</param>
<param name="logicalPath">
<para>String containing the logical path of the selectable for backup component.</para>
<para>A logical path is not required when adding a component. Therefore, the value of this parameter can be <see langword="null"/>.</para>
<para>There are no restrictions on the characters that can a logical path.</para>
</param>
<param name="componentName">
<para>String containing the name of the selectable for backup component.</para>
<para>The value of this parameter <b>cannot</b> be <see langword="nulL"/>.</para>
<para>There are no restrictions on the characters that can appear in a logical path.</para>
</param>
<exception cref="T:System.ArgumentException">One of the parameters is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectAlreadyExistsException">The object is a duplicate. A component with the same logical path and component name already exists.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddNewTarget(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String,System.String,System.Boolean,System.String)">
<summary>
The <b>AddNewTarget</b> method is used by a requester during a restore operation to indicate that the backup application plans
to restore files to a new location.
</summary>
<param name="writerId">Globally unique identifier (GUID) of the writer class containing the files that are to receive a new target.</param>
<param name="componentType">Identifies the type of the component, see the documentation for <see cref="T:Alphaleonis.Win32.Vss.VssComponentType"/> for more information.</param>
<param name="logicalPath">
<para>String containing the logical path of the component containing the files that are to receive a new restore target.</para>
<para>The value of the string containing the logical path used here should be the same as was used when the component was
added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.</para>
<para>The logical path can be <see langword="null"/>.</para>
<para>There are no restrictions on the characters that can appear in a non-<c>null</c> logical path.</para>
</param>
<param name="componentName">
<para>The name of the component containing the files that are to receive a new restore target.</para>
<para>The string should not be <see langword="null"/> and should contain the same component name as was used when the
component was added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.</para>
<para>There are no restrictions on the characters that can appear in a non-NULL logical path.</para>
</param>
<param name="path">
<para>The name of the directory or directory hierarchy containing the files to receive a new restore target.</para>
<para>The path can contain environment variables (for example, %SystemRoot%) but cannot contain wildcard characters.</para>
<para>There is no requirement that the path end with a backslash ("\"). It is up to applications that retrieve this information to check.</para>
</param>
<param name="fileName">
<para>The file specification of the files to receive a new restore target.</para>
<para>A file specification cannot contain directory specifications (for example, no backslashes) but can contain the ? and * wildcard characters.</para>
</param>
<param name="recursive">Boolean indicating whether only the files in the directory defined by <paramref name="path"/> and matching the file
specification provided by <paramref name="fileName"/> are to receive a new restore target, or if all files in the hierarchy defined
by <paramref name="path"/>and matching the file specification provided by <paramref name="fileName"/> are to receive a new restore target.
</param>
<param name="alternatePath">The fully qualified path of the new restore target directory.</param>
<remarks><note>This method is not supported on Windows XP</note></remarks>
<exception cref="T:System.ArgumentException">One of the parameters is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The component does not exist or the path and file specification do not match a component and file specification in the component.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
<exception cref="T:System.NotSupportedException">The operation is not supported on the current operating system.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddRestoreSubcomponent(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String,System.String)">
<summary>
The <b>AddRestoreSubcomponent</b> method indicates that a Subcomponent member of a component set, which had been marked as
nonselectable for backup but is marked selectable for restore, is to be restored irrespective of whether any other member
of the component set will be restored.
</summary>
<param name="writerId">Globally unique identifier (GUID) of the writer class containing the files that are to receive a new target.</param>
<param name="componentType">Identifies the type of the component, see the documentation for <see cref="T:Alphaleonis.Win32.Vss.VssComponentType"/> for more information.</param>
<param name="logicalPath">
<para>String containing the logical path of the component in the backup document that defines the backup component set containing the Subcomponent to be added for restore.</para>
<para>The logical path can be <see langword="null"/>.</para>
<para>There are no restrictions on the characters that can appear in a non-<c>null</c> logical path.</para>
</param>
<param name="componentName">
<para>The logical path of the component in the backup document that defines the backup component set containing the Subcomponent to be added for restore.</para>
<para>The string should not be <see langword="null"/> and should contain the same component name as was used when the
component was added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.</para>
<para>There are no restrictions on the characters that can appear in a non-NULL component name.</para>
</param>
<param name="subcomponentLogicalPath">
<para>The logical path of the Subcomponent to be added for restore. </para>
<para>A logical path is required when adding a Subcomponent. Therefore, the value of this parameter cannot be <see langword="null"/>.</para>
<para>There are no restrictions on the characters that can appear in a non-NULL logical path.</para>
</param>
<param name="subcomponentName">
<para>The logical name of the Subcomponent to be added for restore.</para>
<para>The value of this parameter cannot be <see langword="null"/>.</para>
<para>There are no restrictions on the characters that can appear in a non-NULL component name.</para>
</param>
<exception cref="T:System.ArgumentException">One of the parameters is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The component does not exist.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddToSnapshotSet(System.String,System.Guid)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddToSnapshotSet(System.String,System.Guid)"/> method adds an original volume to the shadow copy set.
</summary>
<param name="volumeName">String containing the name of the volume to be shadow copied. The name must be in one of the following formats:
<list type="bullet">
<item><description>The path of a volume mount point with a backslash (\)</description></item>
<item><description>A drive letter with backslash (\), for example, D:\</description></item>
<item><description>A unique volume name of the form "\\?\Volume{GUID}\" (where GUID is the unique global identifier of the volume) with a backslash (\)</description></item>
</list>
</param>
<param name="providerId">The provider to be used. <see cref="F:System.Guid.Empty"/> can be used, in which case the default provider will be used.</param>
<returns>Identifier of the added shadow copy.</returns>
<remarks>
<para>
The maximum number of shadow copies in a single shadow copy set is 64.
</para>
<para>If <paramref name="providerId"/> is <see cref="F:System.Guid.Empty"/>, the default provider is selected according to the following algorithm:
<list type="numbered">
<item><description>If any hardware-based provider supports the given volume, it is selected.</description></item>
<item><description>If there is no hardware-based provider available, if any software-based provider supports the given volume, it is selected.</description></item>
<item><description>If there is no hardware-based provider or software-based provider available, the system provider is selected. (There is only one preinstalled system provider, which must support all nonremovable local volumes.)</description></item>
</list>
</para>
</remarks>
<exception cref="T:System.UnauthorizedAccessException">Caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.ArgumentException">One of the parameters is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException">The maximum number of volumes has been added to the shadow copy set. The specified volume was not added to the shadow copy set.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException">The volume has been added to the maximum number of shadow copy sets. The specified volume was not added to the shadow copy set.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException"><paramref name="volumeName"/> does not correspond to an existing volume.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException"><paramref name="providerId"/> does not correspond to a registered provider.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException">The value of the <paramref name="providerId"/> parameter is <see cref="F:System.Guid.Empty"/> and no VSS provider indicates that it supports the specified volume.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException">The volume is not supported by the specified provider.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">The provider returned an unexpected error code.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddToSnapshotSet(System.String)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddToSnapshotSet(System.String)"/> method adds an original volume to the shadow copy set using the default provider.
</summary>
<param name="volumeName">String containing the name of the volume to be shadow copied. The name must be in one of the following formats:
<list type="bullet">
<item><description>The path of a volume mount point with a backslash (\)</description></item>
<item><description>A drive letter with backslash (\), for example, D:\</description></item>
<item><description>A unique volume name of the form "\\?\Volume{GUID}\" (where GUID is the unique global identifier of the volume) with a backslash (\)</description></item>
</list>
</param>
<returns>Identifier of the added shadow copy.</returns>
<remarks>
<para>
The maximum number of shadow copies in a single shadow copy set is 64.
</para>
</remarks>
<exception cref="T:System.UnauthorizedAccessException">Caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.ArgumentException">One of the parameters is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException">The maximum number of volumes has been added to the shadow copy set. The specified volume was not added to the shadow copy set.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException">The volume has been added to the maximum number of shadow copy sets. The specified volume was not added to the shadow copy set.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException"><paramref name="volumeName"/> does not correspond to an existing volume.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException">No VSS provider indicates that it supports the specified volume.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException">The volume is not supported by the specified provider.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">The provider returned an unexpected error code.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BackupComplete">
<summary>
This method causes VSS to generate a <b>BackupComplete</b> event, which signals writers that the backup
process has completed.
</summary>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException">An unexpected error occurred during communication with writers. The error code is logged in the error log file.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginBackupComplete(System.AsyncCallback,System.Object)">
<summary>
This method asynchronously causes VSS to generate a <b>BackupComplete</b> event, which signals writers that the backup
process has completed.
</summary>
<remarks>
Pass the <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> value returned to the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndBackupComplete(System.IAsyncResult)"/> method to release operating system resources used for this asynchronous operation.
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndBackupComplete(System.IAsyncResult)"/> must be called once for every call to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginBackupComplete(System.AsyncCallback,System.Object)"/>. You can do this either by using the same code that called <b>BeginBackupComplete</b> or
in a callback passed to <b>BeginBackupComplete</b>.
</remarks>
<param name="userCallback">An optional asynchronous callback, to be called when the read is complete.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
<returns>
An <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> instance that represents this asynchronous operation.
</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndBackupComplete(System.IAsyncResult)">
<summary>
Waits for a pending asynchronous operation to complete.
</summary>
<remarks>
<b>EndBackupComplete</b> can be called once on every <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> from <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginBackupComplete(System.AsyncCallback,System.Object)"/>.
</remarks>
<param name="asyncResult">The reference to the pending asynchronous request to finish. </param>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException">An unexpected error occurred during communication with writers. The error code is logged in the error log file.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BreakSnapshotSet(System.Guid)">
<overloads>
<summary>
The <c>BreakSnapshotSet</c> method causes the existence of a shadow copy set to be "forgotten" by VSS.
</summary>
</overloads>
<summary>
The <c>BreakSnapshotSet</c> method causes the existence of a shadow copy set to be "forgotten" by VSS.
</summary>
<param name="snapshotSetId">Shadow copy set identifier.</param>
<remarks>BreakSnapshotSet can be used only for shadow copies created by a hardware shadow copy provider. This method makes these shadow copies regular volumes.</remarks>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.ArgumentException">One of the parameters is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">The shadow copy was created by a software provider and cannot be broken.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified shadow copy does not exist.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DeleteSnapshot(System.Guid,System.Boolean)">
<summary>
The <c>DeleteSnapshot</c> method deletes a shadow copy..
</summary>
<param name="snapshotId">Identifier of the shadow copy to be deleted.</param>
<param name="forceDelete">If the value of this parameter is <see langword="true"/>, the provider will do everything possible to delete the shadow copy. If it is <see langword="false"/>, no additional effort will be made.</param>
<remarks>
<para>
The requester is responsible for serializing the delete shadow copy operation.
</para>
<para>
During a backup, shadow copies are automatically released as soon as the <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> instance is
disposed. In this case, it is not necessary to explicitly delete shadow copies.
</para>
</remarks>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.ArgumentException">One of the parameters is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified shadow copy does not exist.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">Unexpected provider error. The error code is logged in the error log.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DeleteSnapshotSet(System.Guid,System.Boolean)">
<summary>
The <c>DeleteSnapshotSet</c> method deletes a shadow copy set including any shadow copies in that set.
</summary>
<param name="snapshotSetId">Identifier of the shadow copy set to be deleted.</param>
<param name="forceDelete">
If the value of this parameter is <see langword="true"/>, the provider will do everything possible to
delete the shadow copies in a shadow copy set. If it is <see langword="false"/>, no additional effort will be made.
</param>
<remarks>
<para>
Multiple shadow copies in a shadow copy set are deleted sequentially. If an error occurs during one of these individual
deletions, <b>DeleteSnapshotSet</b> will throw an exception immediately; no attempt will be made to delete any remaining shadow copies.
The identifier of the undeleted shadow copy can be found in the instance of <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> thrown.
</para>
<para>
The requester is responsible for serializing the delete shadow copy operation.
</para>
<para>
During a backup, shadow copies are automatically released as soon as the <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> instance is
disposed. In this case, it is not necessary to explicitly delete shadow copies.
</para>
</remarks>
<exception cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException">The deletion failed. This is the only exception actually thrown by this method. It
wraps one of the other exceptions listed in this section as its inner exception.</exception>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.ArgumentException">One of the parameters is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified shadow copy does not exist.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">Unexpected provider error. The error code is logged in the error log.</exception>
<returns>The total number of snapshots that were deleted</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DisableWriterClasses(System.Guid[])">
<summary>
This method prevents a specific class of writers from receiving any events.
</summary>
<param name="writerClassIds">An array containing one or more writer class identifiers.</param>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.ArgumentException">One of the parameters is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DisableWriterInstances(System.Guid[])">
<summary>
This method disables a specified writer instance or instances.
</summary>
<param name="writerInstanceIds">An array containing one or more writer instance identifiers.</param>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.ArgumentException">One of the parameters is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DoSnapshotSet">
<summary>
Commits all shadow copies in this set simultaneously.
</summary>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object has not been initialized or the prerequisite calls for a given shadow copy context have not been made prior to calling <b>DoSnapshotSet</b>. </exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInsufficientStorageException">The system or provider has insufficient storage space. If possible delete any old or unnecessary persistent shadow copies and try again.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException">The system was unable to flush I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException">The system was unable to hold I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">The provider was unable to perform the request at this time. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssRebootRequiredException">
<para>
The provider encountered an error that requires the user to restart the computer.
</para>
<para>
<b>Windows Server 2003 and Windows XP:</b> This value is not supported until Windows Vista.
</para>
</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException">
<para>
The system was unable to freeze the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).
</para>
<para>
<b>Windows Server 2003 and Windows XP:</b> This value is not supported until Windows Vista.
</para>
</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException">
<para>
The system was unable to freeze the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).
</para>
<para>
<b>Windows Server 2003 and Windows XP:</b> This value is not supported until Windows Vista.
</para>
</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">The provider returned an unexpected error code. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginDoSnapshotSet(System.AsyncCallback,System.Object)">
<summary>
Commits all shadow copies in this set simultaneously as an asynchronous operation.
</summary>
<param name="userCallback">An optional asynchronous callback, to be called when the read is complete.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
<returns>An <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> instance that represents this asynchronous operation.</returns>
<remarks>
Pass the <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> value returned to the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndDoSnapshotSet(System.IAsyncResult)"/> method to release operating system resources used for this asynchronous operation.
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndDoSnapshotSet(System.IAsyncResult)"/> must be called once for every call to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginDoSnapshotSet(System.AsyncCallback,System.Object)"/>. You can do this either by using the same code that called <b>BeginDoSnapshotSet</b> or
in a callback passed to <b>BeginDoSnapshotSet</b>.
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndDoSnapshotSet(System.IAsyncResult)">
<summary>
Waits for a pending asynchronous operation to complete.
</summary>
<remarks>
<b>EndDoSnapshotSet</b> can be called once on every <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> from <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginDoSnapshotSet(System.AsyncCallback,System.Object)"/>.
</remarks>
<param name="asyncResult">The reference to the pending asynchronous request to finish. </param>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object has not been initialized or the prerequisite calls for a given shadow copy context have not been made prior to calling <b>DoSnapshotSet</b>. </exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInsufficientStorageException">The system or provider has insufficient storage space. If possible delete any old or unnecessary persistent shadow copies and try again.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException">The system was unable to flush I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException">The system was unable to hold I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">The provider was unable to perform the request at this time. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssRebootRequiredException">
<para>
The provider encountered an error that requires the user to restart the computer.
</para>
<para>
<b>Windows Server 2003 and Windows XP:</b> This value is not supported until Windows Vista.
</para>
</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException">
<para>
The system was unable to freeze the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).
</para>
<para>
<b>Windows Server 2003 and Windows XP:</b> This value is not supported until Windows Vista.
</para>
</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException">
<para>
The system was unable to freeze the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).
</para>
<para>
<b>Windows Server 2003 and Windows XP:</b> This value is not supported until Windows Vista.
</para>
</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">The provider returned an unexpected error code. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EnableWriterClasses(System.Guid[])">
<summary>
The <b>EnableWriterClasses</b> method enables the specified writers to receive all events.
</summary>
<param name="writerClassIds">An array containing one or more writer class identifiers.</param>
<remarks>
<para>
Once this method is called, only enabled writer classes are subsequently called.
</para>
<para>
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DisableWriterClasses(System.Guid[])"/> must be called prior to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GatherWriterMetadata"/>. To obtain information about the writers
currently running on the system, it may be necessary to call <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GatherWriterMetadata"/> from another instance of the
<see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> class.
</para>
<para>
After <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GatherWriterMetadata"/> is called, these calls have no effect.
</para>
</remarks>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.ExposeSnapshot(System.Guid,System.String,Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes,System.String)">
<summary>
The <b>ExposeSnapshot</b> method exposes a shadow copy either by mounting it as a device on a drive letter or mount point, or
as a file share.
</summary>
<param name="snapshotId">Shadow copy identifier.</param>
<param name="pathFromRoot">
<para>The path to the portion of the volume made available when exposing a shadow copy as a file share. The value of this parameter must be NULL when exposing a shadow copy locally; that is, by mounting to a drive letter or a mount point.</para>
<para>The path cannot contain environment variables (for example, %MyEnv%) or wildcard characters.</para>
<para>There is no requirement that the path end with a backslash ("\"). It is up to applications that retrieve this information to check.</para>
</param>
<param name="attributes">Attributes of the exposed shadow copy indicating whether it is exposed locally or remotely. The value must
be either the <see cref="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.ExposedLocally"/> or the <see cref="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.ExposedRemotely"/>
value of <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/>.</param>
<param name="expose">When a shadow copy is exposed as a file share, the value of this parameter is the share name. If a shadow copy
is exposed by mounting it as a device, the parameter value is a drive letter followed by a colon, for example, "X:" or a mount point
path (for example, "X:\a\b"). If the value of this parameter is <see langword="null"/>, then VSS determines the share name or drive
letter if the <paramref name="attributes"/> parameter is <see cref="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.ExposedRemotely"/>. </param>
<returns>The exposed name of the shadow copy. This is either a share name, a drive letter followed by a colon, or a mount point.</returns>
<remarks>
<para>When exposing a persistent shadow copy, it remains exposed through subsequent boots.</para>
<para>When exposing a shadow copy of a volume, the shadow copy may be treated either as a mountable device or as a file system available for file sharing.</para>
<para>When it is exposed as a device, as with other mountable devices, the shadow copy of a volume is exposed at its mount point starting with its root.</para>
<para>When exposed as a file share, subsets (indicated by <paramref name="pathFromRoot"/>) of the volume can be shared.</para>
</remarks>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified shadow copy does not exist.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">Unexpected provider error. The error code is logged in the error log.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.FreeWriterMetadata">
<summary>
The <c>FreeWriterMetadata</c> method frees system resources allocated when <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GatherWriterMetadata"/> was called.
</summary>
<remarks>
<para>
This method should never be called prior to the completion of <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GatherWriterMetadata"/>.
The result of calling the method prior to completion of the metadata gather is undefined.
</para>
<para>
Once writer metadata has been freed, it cannot be recovered by the current instance of the <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> class.
It will be necessary to create a new instance of <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/>, and call the
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GatherWriterMetadata"/> method again.
</para>
</remarks>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.FreeWriterStatus">
<summary>
The <c>FreeWriterStatus</c> method frees system resources allocated during the call to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GatherWriterStatus"/>.
</summary>
<exception cref="T:System.OutOfMemoryException">The caller is out of memory or other system resources.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GatherWriterMetadata">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GatherWriterMetadata"/> method prompts each writer to send the metadata they have collected. The method will generate an <c>Identify</c> event to communicate with writers.
</summary>
<remarks><see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GatherWriterMetadata"/> should be called only once during the lifetime of a given <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> object.</remarks>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException">The writer infrastructure is not operating properly. Check that the Event Service and VSS have been started, and check for errors associated with those services in the error log.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginGatherWriterMetadata(System.AsyncCallback,System.Object)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginGatherWriterMetadata(System.AsyncCallback,System.Object)"/> method asynchronously prompts each writer to send the metadata they have collected.
The method will generate an <c>Identify</c> event to communicate with writers.
</summary>
<remarks>
<para><see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginGatherWriterMetadata(System.AsyncCallback,System.Object)"/> should be called only once during the lifetime of a given <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> object.</para>
<para>
Pass the <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> value returned to the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndGatherWriterMetadata(System.IAsyncResult)"/> method to release operating system resources used for this asynchronous operation.
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndGatherWriterMetadata(System.IAsyncResult)"/> must be called once for every call to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginGatherWriterMetadata(System.AsyncCallback,System.Object)"/>. You can do this either by using the same code that called <b>BeginGatherWriterMetadata</b> or
in a callback passed to <b>BeginGatherWriterMetadata</b>.
</para>
</remarks>
<param name="userCallback">An optional asynchronous callback, to be called when the read is complete.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
<returns>An <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> instance that represents this asynchronous operation.</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndGatherWriterMetadata(System.IAsyncResult)">
<summary>
Waits for a pending asynchronous operation to complete.
</summary>
<remarks>
<b>EndGatherWriterMetadata</b> can be called once on every <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> from <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginGatherWriterMetadata(System.AsyncCallback,System.Object)"/>.
</remarks>
<param name="asyncResult">The reference to the pending asynchronous request to finish. </param>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException">The writer infrastructure is not operating properly. Check that the Event Service and VSS have been started, and check for errors associated with those services in the error log.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GatherWriterStatus">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GatherWriterStatus"/> method prompts each writer to send a status message.
</summary>
<remarks>The caller of this method should also call <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.FreeWriterStatus"/> after receiving the status of each writer.</remarks>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException">The writer infrastructure is not operating properly. Check that the Event Service and VSS have been started, and check for errors associated with those services in the error log.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginGatherWriterStatus(System.AsyncCallback,System.Object)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginGatherWriterStatus(System.AsyncCallback,System.Object)"/> method asynchronously prompts each writer to send a status message.
</summary>
<remarks>
<para>The caller of this method should also call <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.FreeWriterStatus"/> after receiving the status of each writer.</para>
<para>
Pass the <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> value returned to the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndGatherWriterStatus(System.IAsyncResult)"/> method to release operating system resources used for this asynchronous operation.
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndGatherWriterStatus(System.IAsyncResult)"/> must be called once for every call to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginGatherWriterStatus(System.AsyncCallback,System.Object)"/>. You can do this either by using the same code that called <b>BeginGatherWriterStatus</b> or
in a callback passed to <b>BeginGatherWriterStatus</b>.
</para>
</remarks>
<param name="userCallback">An optional asynchronous callback, to be called when the read is complete.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
<returns>An <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> instance that represents this asynchronous operation.</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndGatherWriterStatus(System.IAsyncResult)">
<summary>
Waits for a pending asynchronous operation to complete.
</summary>
<remarks>
<b>EndGatherWriterStatus</b> can be called once on every <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> from <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginGatherWriterStatus(System.AsyncCallback,System.Object)"/>.
</remarks>
<param name="asyncResult">The reference to the pending asynchronous request to finish. </param>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException">The writer infrastructure is not operating properly. Check that the Event Service and VSS have been started, and check for errors associated with those services in the error log.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GetSnapshotProperties(System.Guid)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GetSnapshotProperties(System.Guid)"/> method gets the properties of the specified shadow copy.
</summary>
<param name="snapshotId">The identifier of the shadow copy of a volume as returned by <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddToSnapshotSet(System.String,System.Guid)"/>. </param>
<returns>A <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotProperties"/> instance containing the shadow copy properties.</returns>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified shadow copy does not exist.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">Unexpected provider error. The error code is logged in the error log.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.ImportSnapshots">
<summary>
The ImportSnapshots method imports shadow copies transported from a different machine.
</summary>
<note>This method is supported only on Windows Server operating systems.</note>
<remarks>
<para>Only one shadow copy can be imported at a time.</para>
<para>The requester is responsible for serializing the import shadow copy operation.</para>
<para>For more information see the <see href="http://msdn.microsoft.com/en-us/library/aa382683(VS.85).aspx">MSDN documentation on IIVssBackupComponents::ImportSnapshots Method</see></para>
<para>Requires Windows Server 2008, Windows Server 2003 SP1, Windows Server 2003, Enterprise Edition, or Windows Server 2003, Datacenter Edition.</para>
</remarks>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginImportSnapshots(System.AsyncCallback,System.Object)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginImportSnapshots(System.AsyncCallback,System.Object)"/> method asynchronously imports shadow copies transported from a different machine.
</summary>
<note>This method is supported only on Windows Server operating systems.</note>
<remarks>
<para>Only one shadow copy can be imported at a time.</para>
<para>The requester is responsible for serializing the import shadow copy operation.</para>
<para>For more information see the <see href="http://msdn.microsoft.com/en-us/library/aa382683(VS.85).aspx">MSDN documentation on IIVssBackupComponents::ImportSnapshots Method</see></para>
<para>Requires Windows Server 2008, Windows Server 2003 SP1, Windows Server 2003, Enterprise Edition, or Windows Server 2003, Datacenter Edition.</para>
<para>
Pass the <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> value returned to the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndImportSnapshots(System.IAsyncResult)"/> method to release operating system resources used for this asynchronous operation.
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndImportSnapshots(System.IAsyncResult)"/> must be called once for every call to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginImportSnapshots(System.AsyncCallback,System.Object)"/>. You can do this either by using the same code that called <b>BeginImportSnapshots</b> or
in a callback passed to <b>BeginImportSnapshots</b>.
</para>
</remarks>
<param name="userCallback">An optional asynchronous callback, to be called when the read is complete.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
<returns>An <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> instance that represents this asynchronous operation.</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndImportSnapshots(System.IAsyncResult)">
<summary>
Waits for a pending asynchronous operation to complete.
</summary>
<remarks>
<b>EndImportSnapshots</b> can be called once on every <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> from <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginImportSnapshots(System.AsyncCallback,System.Object)"/>.
</remarks>
<param name="asyncResult">The reference to the pending asynchronous request to finish. </param>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.InitializeForBackup(System.String)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.InitializeForBackup(System.String)"/> method initializes the backup components metadata in preparation for backup.
</summary>
<param name="xml">
<para>
During imports of transported shadow copies, this parameter must be the original document generated when creating the saved
shadow copy and saved using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SaveAsXml"/>.
</para>
<para>
This parameter may be <see langword="null"/>
</para>
</param>
<remarks>
The XML document supplied to this method initializes the <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> object with metadata previously stored by
a call to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SaveAsXml"/>. Users should not tamper with this metadata document.
</remarks>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.InitializeForRestore(System.String)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.InitializeForRestore(System.String)"/> method initializes the IIVssBackupComponents interface in preparation for a restore operation.
</summary>
<param name="xml">
XML string containing the Backup Components Document generated by a backup operation and saved by
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SaveAsXml"/>.
</param>
<remarks>
The XML document supplied to this method initializes the <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> object with metadata previously stored by a call to
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SaveAsXml"/>. Users should not tamper with this metadata document.
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="xml"/> is <see langword="null"/></exception>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The load operation of the specified XML document failed.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.IsVolumeSupported(System.String,System.Guid)">
<summary>
The <c>IsVolumeSupported</c> method determines whether the specified provider supports shadow copies on the specified volume.
</summary>
<param name="providerId">
Provider identifier. If the value is <see cref="F:System.Guid.Empty"/>, <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.IsVolumeSupported(System.String,System.Guid)"/> checks whether any provider
supports the volume.
</param>
<param name="volumeName">Name of the volume. The name of the volume to be checked must be in one of the following formats:
<list type="bullet">
<item><description>The path of a volume mount point with a backslash (\)</description></item>
<item><description>A drive letter with backslash (\), for example, D:\</description></item>
<item><description>A unique volume name of the form \\?\Volume{GUID}\ (where GUID is the unique global identifier of the volume) with a backslash (\)</description></item>
</list></param>
<returns><see langword="true"/> if shadow copies are supported on the specified volume. If the value is <see langword="false"/>, shadow
copies are not supported on the specified volume.</returns>
<remarks>
<para>
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.IsVolumeSupported(System.String,System.Guid)"/> will return <see langword="true"/> if it is possible to create shadow copies on the given volume,
even if the current configuration does not allow the creation of shadow copies on that volume at the present time.
</para>
<para>
For example, if the maximum number of shadow copies has been reached on a given volume (and therefore no more shadow copies
can be created on that volume), the method will still indicate that the volume can be shadow copied.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="volumeName"/> is <see langword="null"/></exception>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified volume was not found or was not available.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.IsVolumeSupported(System.String)">
<summary>
The <c>IsVolumeSupported</c> method determines whether any provider supports shadow copies on the specified volume.
</summary>
<param name="volumeName">Name of the volume. The name of the volume to be checked must be in one of the following formats:
<list type="bullet">
<item><description>The path of a volume mount point with a backslash (\)</description></item>
<item><description>A drive letter with backslash (\), for example, D:\</description></item>
<item><description>A unique volume name of the form \\?\Volume{GUID}\ (where GUID is the unique global identifier of the volume) with a backslash (\)</description></item>
</list></param>
<returns><see langword="true"/> if shadow copies are supported on the specified volume. If the value is <see langword="false"/>, shadow
copies are not supported on the specified volume.</returns>
<remarks>
<para>
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.IsVolumeSupported(System.String,System.Guid)"/> will return <see langword="true"/> if it is possible to create shadow copies on the given volume,
even if the current configuration does not allow the creation of shadow copies on that volume at the present time.
</para>
<para>
For example, if the maximum number of shadow copies has been reached on a given volume (and therefore no more shadow copies
can be created on that volume), the method will still indicate that the volume can be shadow copied.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="volumeName"/> is <see langword="null"/></exception>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified volume was not found or was not available.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PostRestore">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PostRestore"/> method will cause VSS to generate a <c>PostRestore</c> event, signaling writers that the current
restore operation has finished.
</summary>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified volume was not found or was not available.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginPostRestore(System.AsyncCallback,System.Object)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginPostRestore(System.AsyncCallback,System.Object)"/> method will asynchronously cause VSS to generate a <c>PostRestore</c> event, signaling writers that the current
restore operation has finished.
</summary>
<remarks>
<para>
Pass the <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> value returned to the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndPostRestore(System.IAsyncResult)"/> method to release operating system resources used for this asynchronous operation.
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndPostRestore(System.IAsyncResult)"/> must be called once for every call to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginPostRestore(System.AsyncCallback,System.Object)"/>. You can do this either by using the same code that called <b>BeginPostRestore</b> or
in a callback passed to <b>BeginPostRestore</b>.
</para>
</remarks>
<param name="userCallback">An optional asynchronous callback, to be called when the read is complete.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
<returns>An <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> instance that represents this asynchronous operation.</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndPostRestore(System.IAsyncResult)">
<summary>
Waits for a pending asynchronous operation to complete.
</summary>
<remarks>
<b>EndGatherWriterStatus</b> can be called once on every <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> from <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginPostRestore(System.AsyncCallback,System.Object)"/>.
</remarks>
<param name="asyncResult">The reference to the pending asynchronous request to finish. </param>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified volume was not found or was not available.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PrepareForBackup">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PrepareForBackup"/> method will cause VSS to generate a PrepareForBackup event, signaling writers to prepare for an upcoming
backup operation. This makes a requester's Backup Components Document available to writers.
</summary>
<remarks>
<para>
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PrepareForBackup"/> generates a <c>PrepareForBackup</c> event, which is handled by each instance of each writer
through the CVssWriter::OnPrepareBackup method.
</para>
<para>
Before PrepareForBackup can be called, <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetBackupState(System.Boolean,System.Boolean,Alphaleonis.Win32.Vss.VssBackupType,System.Boolean)"/> must be called.
</para>
</remarks>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginPrepareForBackup(System.AsyncCallback,System.Object)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginPrepareForBackup(System.AsyncCallback,System.Object)"/> method will asynchronously cause VSS to generate a PrepareForBackup event, signaling writers to prepare for an upcoming
backup operation. This makes a requester's Backup Components Document available to writers.
</summary>
<remarks>
<para>
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginPrepareForBackup(System.AsyncCallback,System.Object)"/> generates a <c>PrepareForBackup</c> event, which is handled by each instance of each writer
through the CVssWriter::OnPrepareBackup method.
</para>
<para>
Before PrepareForBackup can be called, <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetBackupState(System.Boolean,System.Boolean,Alphaleonis.Win32.Vss.VssBackupType,System.Boolean)"/> must be called.
</para>
<para>
Pass the <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> value returned to the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndPrepareForBackup(System.IAsyncResult)"/> method to release operating system resources used for this asynchronous operation.
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndPrepareForBackup(System.IAsyncResult)"/> must be called once for every call to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginPrepareForBackup(System.AsyncCallback,System.Object)"/>. You can do this either by using the same code that called <b>BeginPrepareForBackup</b> or
in a callback passed to <b>BeginPrepareForBackup</b>.
</para>
</remarks>
<param name="userCallback">An optional asynchronous callback, to be called when the read is complete.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
<returns>An <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> instance that represents this asynchronous operation.</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndPrepareForBackup(System.IAsyncResult)">
<summary>
Waits for a pending asynchronous operation to complete.
</summary>
<remarks>
<b>EndGatherWriterStatus</b> can be called once on every <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> from <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginPrepareForBackup(System.AsyncCallback,System.Object)"/>.
</remarks>
<param name="asyncResult">The reference to the pending asynchronous request to finish. </param>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PreRestore">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PreRestore"/> method will cause VSS to generate a <c>PreRestore</c> event, signaling writers to prepare for a
coming restore operation.
</summary>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginPreRestore(System.AsyncCallback,System.Object)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginPreRestore(System.AsyncCallback,System.Object)"/> method will asynchronously cause VSS to generate a <c>PreRestore</c> event, signaling writers to prepare for a
coming restore operation.
</summary>
<remarks>
<para>
Pass the <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> value returned to the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndPreRestore(System.IAsyncResult)"/> method to release operating system resources used for this asynchronous operation.
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndPreRestore(System.IAsyncResult)"/> must be called once for every call to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginPreRestore(System.AsyncCallback,System.Object)"/>. You can do this either by using the same code that called <b>BeginPreRestore</b> or
in a callback passed to <b>BeginPreRestore</b>.
</para>
</remarks>
<param name="userCallback">An optional asynchronous callback, to be called when the read is complete.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
<returns>An <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> instance that represents this asynchronous operation.</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndPreRestore(System.IAsyncResult)">
<summary>
Waits for a pending asynchronous operation to complete.
</summary>
<remarks>
<b>EndGatherWriterStatus</b> can be called once on every <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> from <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginPreRestore(System.AsyncCallback,System.Object)"/>.
</remarks>
<param name="asyncResult">The reference to the pending asynchronous request to finish. </param>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.QuerySnapshots">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.QuerySnapshots"/> method queries the completed shadow copies in the system that reside in the current context.
The method can be called only during backup operations.
</summary>
<returns>A list of <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotProperties"/> objects representing the requested information.</returns>
<remarks>
<para>
Because <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.QuerySnapshots"/> returns only information on completed shadow copies, the only shadow copy state it can disclose
is <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotState.Created"/>.
</para>
<para>
The method may be called only during backup operations and must be preceded by calls to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.InitializeForBackup(System.String)"/> and
<see cref="O:Alphaleonis.Win32.Vss.IVssBackupComponents.SetContext"/>.
</para>
<para>
The method will return only information
about shadow copies with the current context (set by <see cref="O:Alphaleonis.Win32.Vss.IVssBackupComponents.SetContext"/>). For instance, if the
<see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> context is set to <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.Backup"/>, <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.QuerySnapshots"/> will not
return information on a shadow copy created with a context of <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.FileShareBackup"/>.
</para>
</remarks>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.UnauthorizedAccessException">The caller is not an administrator or a backup operator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The queried object is not found.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">Unexpected provider error. The error code is logged in the error log.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.QueryProviders">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.QueryProviders"/> method queries providers on the system.
The method can be called only during backup operations.
</summary>
<returns>A list of <see cref="T:Alphaleonis.Win32.Vss.VssProviderProperties"/> objects representing the requested information.</returns>
<remarks>
<para>
The method may be called only during backup operations and must be preceded by calls to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.InitializeForBackup(System.String)"/> and
<see cref="O:Alphaleonis.Win32.Vss.IVssBackupComponents.SetContext"/>.
</para>
</remarks>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.UnauthorizedAccessException">The caller is not an administrator or a backup operator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The queried object is not found.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">Unexpected provider error. The error code is logged in the error log.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginQueryRevertStatus(System.String,System.AsyncCallback,System.Object)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginQueryRevertStatus(System.String,System.AsyncCallback,System.Object)"/> method begins an asynchronous operation to determine the status of the revert operation. The
returned <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> can be used to determine the outcome of the operation.
</summary>
<param name="userCallback">An optional asynchronous callback, to be called when the operation is complete.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
<returns>
An <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> instance that represents this asynchronous operation.
</returns>
<param name="volumeName">Name of the volume. The name of the volume to be checked must be in one of the following formats:
<list type="bullet">
<item><description>The path of a volume mount point with a backslash (\)</description></item>
<item><description>A drive letter with backslash (\), for example, D:\</description></item>
<item><description>A unique volume name of the form \\?\Volume{GUID}\ (where GUID is the unique global identifier of the volume) with a backslash (\)</description></item>
</list></param>
<returns>An <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> instance that can be used to determine the status of the revert operation.</returns>
<remarks>
The revert operation will continue even if the computer is rebooted, and cannot be canceled or undone, except by restoring a
backup created using another method.
<note><b>Windows XP, Windows Server 2003 and Windows Vista:</b> This method requires Windows Server 2008 or Windows Server 2003 SP1</note>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndQueryRevertStatus(System.IAsyncResult)">
<summary>
Waits for a pending asynchronous operation to complete.
</summary>
<remarks>
<b>EndQueryRevertStatus</b> can be called once on every <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> from <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginQueryRevertStatus(System.String,System.AsyncCallback,System.Object)"/>.
</remarks>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.UnauthorizedAccessException">The calling process has insufficient privileges.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified parameter is not a valid volume.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException">Revert is not supported on this volume.</exception>
<exception cref="T:System.NotImplementedException">The provider for the volume does not support revert operations.</exception>
<exception cref="T:System.NotSupportedException">This operation is not supported on the current operating system.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.RevertToSnapshot(System.Guid,System.Boolean)">
<summary>
The <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.RevertToSnapshot(System.Guid,System.Boolean)"/> method reverts a volume to a previous shadow copy. Only shadow copies created with persistent
contexts (<see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.AppRollback"/>, <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.ClientAccessible"/>,
<see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.ClientAccessibleWriters"/> or <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.NasRollback"/>)
are supported.
</summary>
<param name="snapshotId">The identifier of the shadow copy to revert</param>
<param name="forceDismount">If this parameter is <see langword="true"/>, the volume will be dismounted and reverted even if the volume is in use.</param>
<remarks>This operation cannot be canceled, or undone once completed. If the computer is rebooted during the revert operation, the revert process will continue when the system is restarted.
<note><b>Windows XP, Windows Server 2003 and Windows Vista:</b> This method requires Windows Server 2008 or Windows Server 2003 SP1</note>
</remarks>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.UnauthorizedAccessException">The calling process has insufficient privileges.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The <paramref name="snapshotId"/> parameter is not a valid shadow copy.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException">The provider was not found.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssRevertInProgressException">The volume already has a revert in process.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException">Revert is only supported for persistent shadow copies.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssVolumeInUseException">The <paramref name="forceDismount"/> parameter was <see langword="false"/>, and the volume could not be locked.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException">Revert is not supported on this volume.</exception>
<exception cref="T:System.NotImplementedException">The provider for the volume does not support revert operations.</exception>
<exception cref="T:System.NotSupportedException">This operation is not supported on the current operating system.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SaveAsXml">
<summary>
The SaveAsXml method saves the Backup Components Document containing a requester's state information to a specified string.
This XML document, which contains the Backup Components Document, should always be securely saved as part of a backup operation.
</summary>
<returns>The Backup Components Document containing a requester's state information.</returns>
<remarks>
<para>For a typical backup operation, SaveAsXml should not be called until after both writers and the requester are finished modifying the Backup Components Document.</para>
<para>Writers can continue to modify the Backup Components Document until their successful return from handling the PostSnapshot event (CVssWriter::OnPostSnapshot), or equivalently upon the completion of <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DoSnapshotSet"/>.</para>
<para>Requesters will need to continue to modify the Backup Components Document as the backup progresses. In particular, a requester will store a component-by-component record of the success or failure of the backup through calls to the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetBackupSucceeded(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Boolean)"/> method.</para>
<para>Once the requester has finished modifying the Backup Components Document, the requester should use <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SaveAsXml"/> to save a copy of the document to the backup media.</para>
<para>A Backup Components Document can be saved at earlier points in the life cycle of a backup operation, for instance, to support the generation of transportable shadow copies to be handled on remote machines.</para>
<para>However, <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SaveAsXml"/> should never be called prior to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PrepareForBackup"/>, because the Backup Components Document will not have been filled by the requester and the writers.</para>
</remarks>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetAdditionalRestores(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Boolean)">
<summary>
The <b>SetAdditionalRestores</b> method is used by a requester during incremental or differential restore operations to indicate
to writers that a given component will require additional restore operations to completely retrieve it.
</summary>
<param name="writerId">Writer identifier.</param>
<param name="componentType">Type of the component.</param>
<param name="logicalPath">
<para>
The logical path of the component to be added. For more information, see
<see href="http://msdn.microsoft.com/en-us/library/aa384316(VS.85).aspx">Logical Pathing of Components</see>.
</para>
<para>
The value of the string containing the logical path used here should be the same as was used when the component was
added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
<para>
The logical path can be <see langword="null"/>.
</para>
<para>
There are no restrictions on the characters that can appear in a non-<c>null</c> logical path.
</para>
</param>
<param name="componentName">
<para>The name of the component.</para>
<para>
The value of the string should not be <see langword="null"/>, and should contain the same component as was used when the
component was added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
</param>
<param name="additionalResources">
<para>
If the value of this parameter is <see langword="true"/>, additional restores of the component will follow this restore. If the
value is <see langword="false"/>, additional restores of the component will not follow this restore.
</para>
</param>
<remarks>
<para>
The information provided by the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetAdditionalRestores(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Boolean)"/> method is typically used by writers that support an explicit
recovery mechanism as part of their PostRestore event handler (CVssWriter::OnPostRestore)�for instance, the Exchange Server, and
database applications such as SQL Server. For these applications, it is often not possible to perform additional differential,
incremental, or log restores after such a recovery is performed.
</para>
<para>
Therefore, if <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetAdditionalRestores(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Boolean)"/> for a component is set to <see langword="true"/>, this means that such a writer
should not execute its explicit recovery mechanism and should expect that additional differential, incremental, or log restores
will be done.
</para>
<para>
When <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetAdditionalRestores(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Boolean)"/> on a component is set to <see langword="false"/>, then after the component is restored,
the application can complete its recovery operation and be brought back online.
</para>
<para>
This method must be called before <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PreRestore"/>.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException">One of the arguments that cannot be <see langword="null"/> was <see langword="null"/></exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The backup component does not exist.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetBackupOptions(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)">
<summary>
Sets a string of private, or writer-dependent, backup parameters for a component.
</summary>
<param name="writerId">Writer identifier.</param>
<param name="componentType">Type of the component.</param>
<param name="logicalPath">
<para>
The logical path of the component to be added. For more information, see
<see href="http://msdn.microsoft.com/en-us/library/aa384316(VS.85).aspx">Logical Pathing of Components</see>.
</para>
<para>
The value of the string containing the logical path used here should be the same as was used when the component was
added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
<para>
The logical path can be <see langword="null"/>.
</para>
<para>
There are no restrictions on the characters that can appear in a non-<c>null</c> logical path.
</para>
</param>
<param name="componentName">
<para>The name of the component.</para>
<para>
The value of the string should not be <see langword="null"/>, and should contain the same component as was used when the
component was added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
</param>
<param name="backupOptions">
String containing the backup parameters to be set.
</param>
<remarks>
<para>
The exact syntax and content of the backup options set by the wszBackupOptions parameter of the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetBackupOptions(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/> method
will depend on the specific writer being contacted.
</para>
<para>
This method must be called before <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PrepareForBackup"/>.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException">One of the arguments that cannot be <see langword="null"/> was <see langword="null"/></exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The backup component does not exist.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetBackupState(System.Boolean,System.Boolean,Alphaleonis.Win32.Vss.VssBackupType,System.Boolean)">
<summary>
Defines an overall configuration for a backup operation.
</summary>
<param name="selectComponents">
<para>
Indicates whether a backup or restore operation will be in component mode.
</para>
<para>
Operation in component mode supports selectively backing up designated individual components (which can allow their exclusion),
or only supports backing up all files and components on a volume.
</para>
<para>
The Boolean is <see langword="true"/> if the operation will be conducted in component mode and <see langword="false"/> if not.
</para>
</param>
<param name="backupBootableSystemState">
<para>
Indicates whether a bootable system state backup is being performed.
</para>
</param>
<param name="backupType">
<para>
A <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> enumeration value indicating the type of backup to be performed.
</para>
</param>
<param name="partialFileSupport">
<para>
If the value of this parameter is <see langword="true"/>, partial file support is enabled.
The default value for this argument is <see langword="false"/>.
</para>
</param>
<remarks>
Applications must call <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetBackupState(System.Boolean,System.Boolean,Alphaleonis.Win32.Vss.VssBackupType,System.Boolean)"/> prior to calling <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PrepareForBackup"/>.
</remarks>
<exception cref="T:System.ArgumentNullException">One of the arguments that cannot be <see langword="null"/> was <see langword="null"/></exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetBackupSucceeded(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Boolean)">
<summary>
Indicates whether the backup of the specified component of a specific writer was successful.
</summary>
<param name="instanceId">Globally unique identifier of the writer instance.</param>
<param name="writerId">Globally unique identifier of the writer class.</param>
<param name="componentType">Type of the component.</param>
<param name="logicalPath">
<para>
The logical path of the component to be added. For more information, see
<see href="http://msdn.microsoft.com/en-us/library/aa384316(VS.85).aspx">Logical Pathing of Components</see>.
</para>
<para>
The value of the string containing the logical path used here should be the same as was used when the component was
added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
<para>
The logical path can be <see langword="null"/>.
</para>
<para>
There are no restrictions on the characters that can appear in a non-<c>null</c> logical path.
</para>
</param>
<param name="componentName">
<para>The name of the component.</para>
<para>
The value of the string should not be <see langword="null"/>, and should contain the same component as was used when the
component was added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
</param>
<param name="succeeded">The value of this parameter is <see langword="true"/> if the component was successfully backed up, and <see langword="false"/> if it was not.</param>
<remarks>
<para>
When working in component mode (when <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetBackupState(System.Boolean,System.Boolean,Alphaleonis.Win32.Vss.VssBackupType,System.Boolean)"/> is called with its select components argument set to <see langword="true"/>),
writers the state of each components backup using <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.BackupSucceeded"/>.
</para>
<para>
Therefore, a well-behaved backup application (requester) must call <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetBackupSucceeded(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Boolean)"/> after each component has been
processed and prior to calling <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BackupComplete"/>.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException">One of the arguments that cannot be <see langword="null"/> was <see langword="null"/></exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The backup component does not exist.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetContext(Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes)">
<overloads>
Sets the context for subsequent shadow copy-related operations.
</overloads>
<summary>
Sets the context for subsequent shadow copy-related operations.
</summary>
<param name="context">
The context to be set. The context must be one of the supported values of <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> or a supported bit
mask (or bitwise OR) of <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/> with a valid <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/>.
</param>
<remarks>
<para>
The default context for VSS shadow copies is <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.Backup"/>.
</para>
<para>
<b>Windows XP:</b> The only supported context is the default context, <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.Backup"/>. Therefore, calling
this method under Windows XP throws a <see cref="T:System.NotImplementedException"/>.
</para>
<para>
This method be called only once, and it must be called prior to calling most VSS functions.
</para>
<para>
For details on how the context set by this method affects how a shadow copy is created and managed, see
<see href="http://msdn.microsoft.com/en-us/library/aa381653(VS.85).aspx">Implementation Details for Creating Shadow Copies</see>.
</para>
<para>
For a complete discussion of the permitted shadow copy contexts, see <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> and <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/>.
</para>
</remarks>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetContext(Alphaleonis.Win32.Vss.VssSnapshotContext)">
<summary>
Sets the context for subsequent shadow copy-related operations.
</summary>
<param name="context">
The context to be set. The context must be one of the supported values of <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> or a supported bit
mask (or bitwise OR) of <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/> with a valid <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/>.
</param>
<remarks>
<para>
The default context for VSS shadow copies is <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.Backup"/>.
</para>
<para>
<b>Windows XP:</b> The only supported context is the default context, <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.Backup"/>. Therefore, calling
this method under Windows XP throws a <see cref="T:System.NotImplementedException"/>.
</para>
<para>
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetContext(Alphaleonis.Win32.Vss.VssSnapshotContext)"/> can be called only once, and it must be called prior to calling most VSS functions.
</para>
<para>
For details on how the context set by this method affects how a shadow copy is created and managed, see
<see href="http://msdn.microsoft.com/en-us/library/aa381653(VS.85).aspx">Implementation Details for Creating Shadow Copies</see>.
</para>
<para>
For a complete discussion of the permitted shadow copy contexts, see <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> and <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/>.
</para>
</remarks>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetFileRestoreStatus(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,Alphaleonis.Win32.Vss.VssFileRestoreStatus)">
<summary>
Indicates whether some, all, or no files were successfully restored.
</summary>
<param name="writerId">Globally unique identifier of the writer class.</param>
<param name="componentType">Type of the component.</param>
<param name="logicalPath">
<para>
The logical path of the component. For more information, see
<see href="http://msdn.microsoft.com/en-us/library/aa384316(VS.85).aspx">Logical Pathing of Components</see>.
</para>
<para>
The value of the string containing the logical path used here should be the same as was used when the component was
added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
<para>
The logical path can be <see langword="null"/>.
</para>
<para>
There are no restrictions on the characters that can appear in a non-<c>null</c> logical path.
</para>
</param>
<param name="componentName">
<para>The name of the component.</para>
<para>
The value of the string should not be <see langword="null"/>, and should contain the same component as was used when the
component was added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
</param>
<param name="status">
If all of the files were restored, the value of this parameter is <see cref="F:Alphaleonis.Win32.Vss.VssFileRestoreStatus.All"/>.
If some of the files were restored, the value of this parameter is <see cref="F:Alphaleonis.Win32.Vss.VssFileRestoreStatus.Failed"/>. If none of the files
were restored, the value of this parameter is <see cref="F:Alphaleonis.Win32.Vss.VssFileRestoreStatus.None"/>.
</param>
<remarks>This method should be called between calls to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PreRestore"/> and <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PostRestore"/>.</remarks>
<exception cref="T:System.ArgumentNullException">One of the arguments that cannot be <see langword="null"/> was <see langword="null"/></exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The backup component does not exist.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetPreviousBackupStamp(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)">
<summary>
<para>
Sets the backup stamp of an earlier backup operation, upon which a differential or
incremental backup operation will be based.
</para>
<para>
The method can be called only during a backup operation.
</para>
</summary>
<param name="writerId">Writer identifier.</param>
<param name="componentType">Type of the component.</param>
<param name="logicalPath">
<para>
The logical path of the component. For more information, see
<see href="http://msdn.microsoft.com/en-us/library/aa384316(VS.85).aspx">Logical Pathing of Components</see>.
</para>
<para>
The value of the string containing the logical path used here should be the same as was used when the component was
added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
<para>
The logical path can be <see langword="null"/>.
</para>
<para>
There are no restrictions on the characters that can appear in a non-<c>null</c> logical path.
</para>
</param>
<param name="componentName">
<para>The name of the component.</para>
<para>
The value of the string should not be <see langword="null"/>, and should contain the same component as was used when the
component was added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
</param>
<param name="previousBackupStamp">The backup stamp to be set.</param>
<remarks>
<para>This method should be called before <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PrepareForBackup"/>.</para>
<para>Only requesters can call this method.</para>
<para>The backup stamp set by <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetPreviousBackupStamp(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/> applies to all files in the component and any nonselectable Subcomponents it has.</para>
<para>Requesters merely store the backup stamps in the Backup Components Document. They cannot make direct use of the backup stamps, do not know their format, and do not know how to generate them.</para>
<para>Therefore, the value set with <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetPreviousBackupStamp(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/> should either be retrieved from the stored Backup Components Document of an earlier backup operation (using <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.BackupStamp"/> for the correct component), or from information stored by the requester into its own internal records.</para>
<para>A writer will then obtain this value (using <c>IVssComponent::GetPreviousBackupStamp</c>) and using it will be able to mark the appropriate files for participation in an incremental or differential backup.</para>
</remarks>
<exception cref="T:System.ArgumentNullException">One of the arguments that cannot be <see langword="null"/> was <see langword="null"/></exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The backup component does not exist.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRangesFilePath(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Int32,System.String)">
<summary>
This method is used when a partial file operation requires a ranges file, and that file has been restored to a location other than its original one.
</summary>
<param name="writerId">Globally unique identifier (GUID) of the writer class containing the files involved in the partial file operation</param>
<param name="componentType">Type of the component.</param>
<param name="logicalPath">
<para>
The logical path of the component containing the files that are participating in the partial file operation. For more information, see
<see href="http://msdn.microsoft.com/en-us/library/aa384316(VS.85).aspx">Logical Pathing of Components</see>.
</para>
<para>
The value of the string containing the logical path used here should be the same as was used when the component was
added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
<para>
The logical path can be <see langword="null"/>.
</para>
<para>
There are no restrictions on the characters that can appear in a non-<c>null</c> logical path.
</para>
</param>
<param name="componentName">
<para>The name of the component containing the files that are participating in the partial file operation.</para>
<para>
The value of the string should not be <see langword="null"/>, and should contain the same component as was used when the
component was added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
</param>
<param name="partialFileIndex">
Index number of the partial file. The value of this parameter is an integer between <c>0</c> and <c>n-1</c>,
where <c>n</c> is the total number of partial files associated with a given component. The value of <c>n</c> is the number
of items in <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.PartialFiles"/>.
</param>
<param name="rangesFile">
The fully qualified path of a ranges file.
</param>
<remarks>
Calling <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRangesFilePath(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Int32,System.String)"/> is not necessary if ranges files are restored in place.
<note><b>Windows XP and Windows Vista:</b> This method requires Windows Server 2008 or Windows Server 2003</note>
</remarks>
<exception cref="T:System.ArgumentNullException">One of the arguments that cannot be <see langword="null"/> was <see langword="null"/></exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The backup component does not exist.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
<exception cref="T:System.NotSupportedException">The operation is not supported by the current operating system.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRestoreOptions(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)">
<summary>
Sets a string of private, or writer-dependent, restore parameters for a writer component.
</summary>
<param name="writerId">Writer identifier.</param>
<param name="componentType">Type of the component.</param>
<param name="logicalPath">
<para>
The logical path of the component. For more information, see
<see href="http://msdn.microsoft.com/en-us/library/aa384316(VS.85).aspx">Logical Pathing of Components</see>.
</para>
<para>
The value of the string containing the logical path used here should be the same as was used when the component was
added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
<para>
The logical path can be <see langword="null"/>.
</para>
<para>
There are no restrictions on the characters that can appear in a non-<c>null</c> logical path.
</para>
</param>
<param name="componentName">
<para>The name of the component.</para>
<para>
The value of the string should not be <see langword="null"/>, and should contain the same component as was used when the
component was added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
</param>
<param name="restoreOptions">The private string of restore parameters. For more information see <see href="http://msdn.microsoft.com/en-us/library/aa384610(VS.85).aspx">Setting VSS Restore Options</see>.</param>
<remarks>
<para>
This method must be called before <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PreRestore"/>.
</para>
<para>
The exact syntax and content of the restore options set by the <paramref name="restoreOptions"/> parameter of the
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRestoreOptions(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/> method will depend on the specific writer being contacted.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException">One of the arguments that cannot be <see langword="null"/> was <see langword="null"/></exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The backup component does not exist.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRestoreState(Alphaleonis.Win32.Vss.VssRestoreType)">
<summary>
Defines an overall configuration for a restore operation.
</summary>
<param name="restoreType">The type of restore to be performed.</param>
<remarks>
<para>Typically, most restore operations will not need to override the default restore type <see cref="F:Alphaleonis.Win32.Vss.VssRestoreType.Undefined"/>.</para>
<para>If applications need to call <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRestoreState(Alphaleonis.Win32.Vss.VssRestoreType)"/>, it should be called prior to calling <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PreRestore"/>.</para>
<note><b>Windows XP:</b> This method requires Windows Vista, Windows Server 2008 or Windows Server 2003</note>
</remarks>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The backup component does not exist.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetSelectedForRestore(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Boolean)">
<summary>
Indicates whether the specified selectable component is selected for restoration.
</summary>
<overloads>
Indicates whether the specified selectable component is selected for restoration.
</overloads>
<param name="writerId">Writer identifier.</param>
<param name="componentType">Type of the component.</param>
<param name="logicalPath">
<para>
The logical path of the component. For more information, see
<see href="http://msdn.microsoft.com/en-us/library/aa384316(VS.85).aspx">Logical Pathing of Components</see>.
</para>
<para>
The value of the string containing the logical path used here should be the same as was used when the component was
added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
<para>
The logical path can be <see langword="null"/>.
</para>
<para>
There are no restrictions on the characters that can appear in a non-<c>null</c> logical path.
</para>
</param>
<param name="componentName">
<para>The name of the component.</para>
<para>
The value of the string should not be <see langword="null"/>, and should contain the same component as was used when the
component was added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
</param>
<param name="selectedForRestore">
If the value of this parameter is <see langword="true"/>, the selected component has been selected for
restoration. If the value is <see langword="false"/>, the selected component has not been selected for restoration.
</param>
<remarks>
<para>SetSelectedForRestore has meaning only for restores taking place in component mode.</para>
<para><see cref="O:Alphaleonis.Win32.Vss.IVssBackupComponents.SetSelectedForRestore"/> can only be called for components that were explicitly added to the
backup document at backup time using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>. Restoring a component that was implicitly
selected for backup as part of a component set must be done by calling <see cref="O:Alphaleonis.Win32.Vss.IVssBackupComponents.SetSelectedForRestore"/> on the closest
ancestor component that was added to the document. If only this component's data is to be restored,
that should be accomplished through <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddRestoreSubcomponent(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String,System.String)"/>; this can only be done if the component
is selectable for restore.</para>
<para>This method must be called before <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PreRestore"/>.</para>
</remarks>
<exception cref="T:System.ArgumentNullException">One of the arguments that cannot be <see langword="null"/> was <see langword="null"/></exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The backup component does not exist.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
<overloads>indicates whether the specified selectable component is selected for restoration. This method has two overloads.</overloads>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.StartSnapshotSet">
<summary>
Creates a new, empty shadow copy set.
</summary>
<returns>Shadow copy set identifier.</returns>
<remarks>This method must be called before <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PrepareForBackup"/> during backup operations.</remarks>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException">The creation of a shadow copy is in progress, and only one shadow copy creation operation can be in progress at one time. Either wait to try again or return with a failure error code.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetSelectedForRestore(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Boolean,System.Guid)">
<summary>
Indicates whether the specified selectable component is selected for restoration to a specified writer instance.
</summary>
<param name="writerId">Globally unique identifier (GUID) of the writer class.</param>
<param name="componentType">Type of the component.</param>
<param name="logicalPath">
<para>
The logical path of the component. For more information, see
<see href="http://msdn.microsoft.com/en-us/library/aa384316(VS.85).aspx">Logical Pathing of Components</see>.
</para>
<para>
The value of the string containing the logical path used here should be the same as was used when the component was
added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
<para>
The logical path can be <see langword="null"/>.
</para>
<para>
There are no restrictions on the characters that can appear in a non-<c>null</c> logical path.
</para>
</param>
<param name="componentName">
<para>The name of the component.</para>
<para>
The value of the string should not be <see langword="null"/>, and should contain the same component as was used when the
component was added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
</param>
<param name="selectedForRestore">
If the value of this parameter is <see langword="true"/>, the selected component has been selected for
restoration. If the value is <see langword="false"/>, the selected component has not been selected for restoration.
</param>
<param name="instanceId">
<para>GUID of the writer instance.</para>
</param>
<remarks>
<para>
<c>SetSelectedForRestore</c>, which moves a component to a different writer instance, can be called only for a
writer that supports running multiple writer instances with the same class ID and supports a requester moving a
component to a different writer instance at restore time. To determine whether a writer provides this support, call
the <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.BackupSchema"/> method.
</para>
<para>
<c>SetSelectedForRestore</c> has meaning only for restores taking place in component mode.
</para>
<para>
<c>SetSelectedForRestore</c> can be called only for components that were explicitly added to the backup document at backup
time using AddComponent. Restoring a component that was implicitly selected for backup as part of a component set must be
done by calling <c>SetSelectedForRestore</c> on the closest ancestor component that was added to the document. If only
this component's data is to be restored, that should be accomplished through the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddRestoreSubcomponent(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String,System.String)"/> method;
this can be done only if the component is selectable for restore (see
<see href="http://msdn.microsoft.com/en-us/library/aa384988(VS.85).aspx">Working with Selectability and Logical Paths</see>).
</para>
<para>
This method must be called before the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PreRestore"/> method.
</para>
<para>
The distinction between the <paramref name="instanceId"/> and <paramref name="writerId"/> parameters is necessary because it is
possible that multiple instances of the same writer are running on the computer.
</para>
<para>
If the value of the <paramref name="instanceId"/> parameter is <see cref="F:System.Guid.Empty"/>, this is equivalent to calling the
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetSelectedForRestore(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Boolean)"/>.
</para>
<para>
The <paramref name="instanceId"/> parameter is used to specify that the component is to be restored to a different writer
instance. If the value of the <paramref name="instanceId"/> parameter is not <see cref="F:System.Guid.Empty"/>, it must match the
instance ID of a writer instance with the same writer class ID specified in in the <paramref name="writerId"/> parameter.
</para>
<para>
A writer's class identifier, instance identifier, and instance name can be found
in the properties of <see cref="T:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata"/>.
</para>
<note>
<b>Windows XP and Windows 2003:</b> This method is not supported until Windows 2003 SP1.
</note>
</remarks>
<exception cref="T:System.ArgumentNullException">One of the arguments that cannot be <see langword="null"/> was <see langword="null"/></exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The backup component does not exist.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BreakSnapshotSet(System.Guid,Alphaleonis.Win32.Vss.VssHardwareOptions)">
<summary>
Breaks a shadow copy set according to requester-specified options.
</summary>
<param name="snapshotSetId">A shadow copy set identifier.</param>
<param name="breakFlags">A bitmask of <see cref="T:Alphaleonis.Win32.Vss.VssHardwareOptions"/> flags that specify how the shadow copy set is broken.</param>
<remarks>
<para>
This method is similar to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BreakSnapshotSet(System.Guid)"/>, except that is has an extra parameter to specify
how the shadow copy set is broken.
</para>
<para>
Like <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BreakSnapshotSet(System.Guid)"/>, this method can be used only for shadow copies that were created by
a hardware shadow copy provider.
</para>
<para>
After this method returns, the shadow copy volume is still a volume, but it is no longer a shadow copy.
For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa381505(VS.85).aspx">Breaking Shadow Copies</see>.
</para>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginBreakSnapshotSet(System.Guid,Alphaleonis.Win32.Vss.VssHardwareOptions,System.AsyncCallback,System.Object)">
<summary>
Begins an asynchronous operation to break a shadow copy set according to requester-specified options.
</summary>
<param name="snapshotSetId">A shadow copy set identifier.</param>
<param name="breakFlags">A bitmask of <see cref="T:Alphaleonis.Win32.Vss.VssHardwareOptions"/> flags that specify how the shadow copy set is broken.</param>
<remarks>
<para>
This method is similar to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BreakSnapshotSet(System.Guid)"/>, except that is has an extra parameter to specify
how the shadow copy set is broken.
</para>
<para>
Like <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BreakSnapshotSet(System.Guid)"/>, this method can be used only for shadow copies that were created by
a hardware shadow copy provider.
</para>
<para>
After this method returns, the shadow copy volume is still a volume, but it is no longer a shadow copy.
For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa381505(VS.85).aspx">Breaking Shadow Copies</see>.
</para>
</remarks>
<param name="userCallback">An optional asynchronous callback, to be called when the read is complete.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
<returns>
An <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> instance that represents this asynchronous operation.
</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndBreakSnapshotSet(System.IAsyncResult)">
<summary>
Waits for an asynchronous operation to complete.
</summary>
<remarks>
<b>EndBreakSnapshotSet</b> can be called once on every <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> from <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginBreakSnapshotSet(System.Guid,Alphaleonis.Win32.Vss.VssHardwareOptions,System.AsyncCallback,System.Object)"/>.
</remarks>
<param name="asyncResult">The reference to the pending asynchronous request to finish. </param>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetAuthoritativeRestore(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Boolean)">
<summary>
Marks the restore of a component as authoritative for a replicated data store.
</summary>
<param name="writerId">The globally unique identifier (GUID) of the writer class.</param>
<param name="componentType">Type of the component.</param>
<param name="logicalPath">
<para>
The logical path of the component to be added. For more information, see
<see href="http://msdn.microsoft.com/en-us/library/aa384316(VS.85).aspx">Logical Pathing of Components</see>.
</para>
<para>
The value of the string containing the logical path used here should be the same as was used when the component was
added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
<para>
The logical path can be <see langword="null"/>.
</para>
<para>
There are no restrictions on the characters that can appear in a non-<c>null</c> logical path.
</para>
</param>
<param name="componentName">
<para>The name of the component.</para>
<para>
The value of the string should not be <see langword="null"/>, and should contain the same component as was used when the
component was added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
</param>
<param name="isAuthorative"><see langword="true"/> to indicate that the restore of the component is authoritative; otherwise, <see langword="false"/>.</param>
<exception cref="T:System.ArgumentNullException">One of the arguments that cannot be <see langword="null"/> was <see langword="null"/></exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">This method was not called during a restore operation.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified component was not found.</exception>
<remarks>
<para>
<note>
<b>Windows XP and Windows 2003:</b> This method requires Windows Vista or Windows Server 2008.
</note>
</para>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRestoreName(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)">
<summary>
Assigns a new logical name to a component that is being restored.
</summary>
<param name="writerId">The globally unique identifier (GUID) of the writer class.</param>
<param name="componentType">The type of the component.</param>
<param name="logicalPath">
<para>
A string containing the logical path of the component. For more information, see
<see href="http://msdn.microsoft.com/en-us/library/aa384316(VS.85).aspx">Logical Pathing of Components</see>.
</para>
<para>
The value of the string containing the logical path used here should be the same as the string that was used when
the component was added.
</para>
<para>
The logical path can be <see langword="null"/>.
</para>
<para>
There are no restrictions on the characters that can appear in a logical path.
</para>
</param>
<param name="componentName">
<para>The name of the component.</para>
<para>
The string cannot be <see langword="null"/> and should contain the same component name as was the component name
that was used when the component was added to the backup set using the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/> method.
</para>
</param>
<param name="restoreName">String containing the restore name to be set for the component.</param>
<exception cref="T:System.ArgumentNullException">One of the arguments that cannot be <see langword="null"/> was <see langword="null"/></exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">This method was not called during a restore operation.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified component was not found.</exception>
<remarks>
<para>
<note>
<b>Windows XP and Windows 2003:</b> This method requires Windows Vista or Windows Server 2008.
</note>
</para>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRollForward(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,Alphaleonis.Win32.Vss.VssRollForwardType,System.String)">
<summary>
Sets the roll-forward operation type for a component and specifies the restore point for a partial roll-forward operation.
</summary>
<param name="writerId">The globally unique identifier (GUID) of the writer class.</param>
<param name="componentType">Type of the component.</param>
<param name="logicalPath">
<para>
The logical path of the component. For more information, see
<see href="http://msdn.microsoft.com/en-us/library/aa384316(VS.85).aspx">Logical Pathing of Components</see>.
</para>
<para>
The value of the string containing the logical path used here should be the same as was used when the component was
added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
<para>
The logical path can be <see langword="null"/>.
</para>
<para>
There are no restrictions on the characters that can appear in a non-<c>null</c> logical path.
</para>
</param>
<param name="componentName">
<para>The name of the component.</para>
<para>
The value of the string should not be <see langword="null"/>, and should contain the same component as was used when the
component was added to the backup set using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
</param>
<param name="rollType">A <see cref="T:Alphaleonis.Win32.Vss.VssRollForwardType"/> enumeration value indicating the type of roll-forward operation to be performed.</param>
<param name="rollForwardPoint">
<para>A null-terminated wide character string specifying the roll-forward restore point.</para>
<para>The format of this string is defined by the writer, and can be a timestamp, a log sequence number (LSN), or any marker defined by the writer.</para>
</param>
<exception cref="T:System.ArgumentNullException">One of the arguments that cannot be <see langword="null"/> was <see langword="null"/></exception>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">This method was not called during a restore operation.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The backup component does not exist.</exception>
<remarks>
<para>
<note>
<b>Windows XP and Windows 2003:</b> This method requires Windows Vista or Windows Server 2008.
</note>
</para>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.UnexposeSnapshot(System.Guid)">
<summary>
Unexposes a shadow copy either by deleting the file share or by removing the drive letter or mount point.
</summary>
<param name="snapshotId">The shadow copy identifier. The value of this identifier should be the same as the value that was used when the shadow copy was exposed.</param>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified shadow copy does not exist or is not exposed.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">Expected provider error. The provider logged the error in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">Unexpected provider error. The error code is logged in the error log.</exception>
<remarks>
<para>
<note>
<b>Windows XP and Windows 2003:</b> This method requires Windows Vista or Windows Server 2008.
</note>
</para>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddSnapshotToRecoverySet(System.Guid,System.String)">
<summary>
Specifies the volumes to be included in a LUN resynchronization operation. This method is supported only on Windows server operating systems.
</summary>
<param name="snapshotId">
The identifier of the shadow copy that was returned by the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddToSnapshotSet(System.String,System.Guid)"/> method during backup.
This parameter is required and cannot be <c>Guid.Empty</c>.
</param>
<param name="destinationVolume">
This parameter is optional and can be <see langword="null"/>.
A value of <see langword="null"/> means that the contents of the shadow copy volume are to be copied back to the original volume.
VSS identifies the original volume by the <c>VDS_LUN_INFO</c> information in the Backup Components Document.
</param>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">Either there is no hardware provider that supports the operation, or the requester did not successfully add any volumes to the recovery set.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssLegacyProviderException">This version of the hardware provider does not support this operation.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The <paramref name="snapshotId"/> parameter specifies a shadow copy that the hardware provider does not own.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssResyncInProgressException">Another LUN resynchronization operation is already in progress.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException">The <paramref name="snapshotId"/> parameter specifies a shadow copy that does not exist in the Backup Components Document.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException">LUN resynchronization is not supported on this volume, because it is a dynamic volume,
because the destination disk does not have a unique page 83 storage identifier, because the specified volume does not reside on a LUN managed
by a VSS hardware provider, or because the destination disk is a cluster quorum disk. </exception>
<remarks>
<para>
<note>
<b>Windows XP, Windows 2003, Windows Vista, Windows 2008, Windows 7:</b> This method requires Windows Server 2008 R2.
</note>
</para>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GetSessionId">
<summary>
Gets the requester's session identifier.
</summary>
<remarks>
<para>
The session identifier is an opaque value that uniquely identifies a backup or restore session. It is used to distinguish
the current session among multiple parallel backup or restore sessions.
</para>
<para>
As a best practice, writers and requesters should include the session ID in all diagnostics messages used for event logging and tracing.
</para>
<para>
<note>
<b>Windows XP, Windows 2003, Windows Vista, Windows 2008:</b> This method requires Windows 7 or Windows Server 2008 R2.
</note>
</para>
</remarks>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<returns>The requester's session identifier.</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.RecoverSet(Alphaleonis.Win32.Vss.VssRecoveryOptions)">
<summary>
Initiates a LUN resynchronization operation. This method is supported only on Windows server operating systems.
</summary>
<param name="options"><see cref="T:Alphaleonis.Win32.Vss.VssRecoveryOptions"/> flags that specify how the resynchronization is to be performed.</param>
<exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.NotImplementedException">The provider for the volume does not support LUN resynchronization.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">Possible reasons for this return value include:
<list type="bullet">
<item><description>There is no hardware provider that supports the operation.</description></item>
<item><description>The requester did not successfully add any volumes to the recovery set.</description></item>
<item><description>The method was called in WinPE or in Safe mode.</description></item>
<item><description>he caller did not call the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.InitializeForRestore(System.String)"/> method before calling this method.</description></item>
</list>
</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssLegacyProviderException">This version of the hardware provider does not support this operation.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">An unexpected provider error occurred. If this error code is returned, the error must be described in an entry in the application event log, giving the user information on how to resolve the problem.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException">The resynchronization destination contained a volume that was not explicitly included.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException">The MBR signature or GPT ID for one or more disks could not be set to the intended value. Check the Application event log for more information.</exception>
<remarks>
<para>
<note>
<b>Windows XP, Windows 2003, Windows Vista, Windows 2008, Windows 7:</b> This method requires Windows Server 2008 R2.
</note>
</para>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginRecoverSet(Alphaleonis.Win32.Vss.VssRecoveryOptions,System.AsyncCallback,System.Object)">
<summary>
Begins an asynchronous operation that initiates a LUN resynchronization operation. This method is supported only on Windows server operating systems.
</summary>
<param name="options"><see cref="T:Alphaleonis.Win32.Vss.VssRecoveryOptions"/> flags that specify how the resynchronization is to be performed.</param>
<param name="userCallback">An optional asynchronous callback, to be called when the read is complete.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
<returns>
An <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> instance that represents this asynchronous operation.
</returns>
<remarks>
<para>
Pass the <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> value returned to the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndRecoverSet(System.IAsyncResult)"/> method to release operating system resources used for this asynchronous operation.
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndRecoverSet(System.IAsyncResult)"/> must be called once for every call to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginRecoverSet(Alphaleonis.Win32.Vss.VssRecoveryOptions,System.AsyncCallback,System.Object)"/>. You can do this either by using the same code that called <b>BeginRecoverSet</b> or
in a callback passed to <b>BeginRecoverSet</b>.
</para>
<para>
<note>
<b>Windows XP, Windows 2003, Windows Vista, Windows 2008, Windows 7:</b> This method requires Windows Server 2008 R2.
</note>
</para>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.IVssBackupComponents.EndRecoverSet(System.IAsyncResult)">
<summary>
Waits for a pending asynchronous operation to complete.
</summary>
<remarks>
<b>EndRecoverSet</b> can be called once on every <see cref="T:Alphaleonis.Win32.Vss.IVssAsyncResult"/> from <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BeginRecoverSet(Alphaleonis.Win32.Vss.VssRecoveryOptions,System.AsyncCallback,System.Object)"/>.
</remarks>
<param name="asyncResult">The reference to the pending asynchronous request to finish. </param>
/// <exception cref="T:System.ArgumentException">One of the parameter values is not valid.</exception>
<exception cref="T:System.UnauthorizedAccessException">The caller does not have sufficient backup privileges or is not an administrator.</exception>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.NotImplementedException">The provider for the volume does not support LUN resynchronization.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">Possible reasons for this return value include:
<list type="bullet">
<item><description>There is no hardware provider that supports the operation.</description></item>
<item><description>The requester did not successfully add any volumes to the recovery set.</description></item>
<item><description>The method was called in WinPE or in Safe mode.</description></item>
<item><description>he caller did not call the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.InitializeForRestore(System.String)"/> method before calling this method.</description></item>
</list>
</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssLegacyProviderException">This version of the hardware provider does not support this operation.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException">An unexpected provider error occurred. If this error code is returned, the error must be described in an entry in the application event log, giving the user information on how to resolve the problem.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException">The resynchronization destination contained a volume that was not explicitly included.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException">The MBR signature or GPT ID for one or more disks could not be set to the intended value. Check the Application event log for more information.</exception>
<remarks>
<para>
<note>
<b>Windows XP, Windows 2003, Windows Vista, Windows 2008, Windows 7:</b> This method requires Windows Server 2008 R2.
</note>
</para>
</remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterComponents">
<summary>
A read-only list containing information about the components of each writer that has been stored in a requester's Backup Components Document.
</summary>
<remarks>
<para>
<see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterComponents"/> retrieves component information for a component stored in the Backup Components Document by earlier
calls to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
<para>
The information in the components stored in the Backup Components Document is not static. If a writer updates a component during a
restore, that change will be reflected in the component retrieved by <see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterComponents"/>. This is in contrast with
component information found in the <see cref="T:Alphaleonis.Win32.Vss.IVssWMComponent"/> object returned by <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Components"/>.
That information is read-only and comes from the Writer Metadata Document of a writer process.
</para>
<para>
The <see cref="T:Alphaleonis.Win32.Vss.IVssWriterComponents"/> instances that are returned should not be cached, because the following
<see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> methods cause the instances that are returned by <see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterComponents"/> to
be no longer valid:
<list type="bullet">
<item><description><see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PrepareForBackup"/></description></item>
<item><description><see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DoSnapshotSet"/></description></item>
<item><description><see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.BackupComplete"/></description></item>
<item><description><see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PreRestore"/></description></item>
<item><description><see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.PostRestore"/></description></item>
</list>
</para>
<para>
If you call one of these methods after you have retrieved a <see cref="T:Alphaleonis.Win32.Vss.IVssWriterComponents"/> instance by calling
<see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterComponents"/>, you cannot reuse that instance, because it is no longer valid. Instead, you must call
<see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterComponents"/> again to retrieve a new <see cref="T:Alphaleonis.Win32.Vss.IVssWriterComponents"/> instance.
</para>
</remarks>
<value>
A read-only list containing information about the components of each writer that has been stored in a requester's Backup Components Document.
<note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> from which it
was obtained has been disposed.</note>
</value>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterMetadata">
<summary>
A read-only list containing metadata for the writers running on the systsem.
</summary>
<value>
A read-only list containing metadata for the writers running on the system.
<note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> from which it
was obtained has been disposed.</note>
</value>
<remarks>
<para>
A requester must call the asynchronous operation <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GatherWriterMetadata"/> and wait for it
to complete prior to using <see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterMetadata"/>.
</para>
<para>
Although <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GatherWriterMetadata"/> must be called prior to either a restore or backup operation,
<see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterMetadata"/> is not typically used for restores.
</para>
<para>
Component information retrieved (during backup operations) using <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Components"/>, where the
<see cref="T:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata"/> instance has been returned by <see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterMetadata"/>, comes from the Writer
Metadata Document of a live writer process.
</para>
<para>
This is in contrast to the information returned by <see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterComponents"/> (during restore operations), which was
stored in the Backup Components Document by calls to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>.
</para>
</remarks>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">The XML document is not valid. Check the event log for details.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified shadow copy does not exist.</exception>
</member>
<member name="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterStatus">
<summary>
A read-only list containing the status of the writers.
</summary>
<value>
A read-only list containing <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusInfo"/> instances representing the returned status for each respective writer.
<note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> from which it
was obtained has been disposed.</note>
</value>
<remarks>
<para>
A requester must call the asynchronous operation <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.GatherWriterStatus"/> and wait for it to
complete prior to using <see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterStatus"/>.
</para>
</remarks>
<exception cref="T:System.OutOfMemoryException">Out of memory or other system resources.</exception>
<exception cref="T:System.SystemException">Unexpected VSS system error. The error code is logged in the event log.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified shadow copy does not exist.</exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">
<summary>
Exception thrown to indicate that the provider returned an unexpected error code. This can be a transient problem.
</summary>
<remarks>
It is recommended to wait ten minutes and try again, up to three times.
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException">
<summary>
Exception thrown to indicate that the requested identifier does not correspond to a registered provider.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssObjectAlreadyExistsException">
<summary>
Exception thrown to indicate that the requested object was a duplicate.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssObjectAlreadyExistsException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectAlreadyExistsException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssObjectAlreadyExistsException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectAlreadyExistsException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssObjectAlreadyExistsException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectAlreadyExistsException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssObjectAlreadyExistsException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectAlreadyExistsException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssInsufficientStorageException">
<summary>
Exception thrown to indicate that the system or provider has insufficient storage space.
</summary>
<remarks>
If possible delete any old or unnecessary persistent shadow copies and try again.
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssInsufficientStorageException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInsufficientStorageException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssInsufficientStorageException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInsufficientStorageException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssInsufficientStorageException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInsufficientStorageException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssInsufficientStorageException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInsufficientStorageException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException">
<summary>
Exception thrown to indicate that the requested deletion of snapshots did not complete successfully.
</summary>
<remarks>
To get further information about the cause of the error, check the inner exception which is populated with the
original exception that caused the deletion to fail.
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> class with the specified error message.
</summary>
<param name="message">The error message.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> class with the specified error message and a reference
to the exception causing this exception to be thrown.
</summary>
<param name="message">The error message.</param>
<param name="innerException">The inner exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.#ctor(System.Int32,System.Guid,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> class, specifying the number of
successfully deleted snapshots, the id of the snapshot on which the delete operation failed and the exception
causing the delete operation to fail.
</summary>
<param name="deletedSnapshotsCount">The number of successfully deleted snapshots.</param>
<param name="nonDeletedSnapshotId">The id of the non deleted snapshot, or <see cref="F:System.Guid.Empty"/> if such information is not available.</param>
<param name="innerException">The inner exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with information about the exception.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is a null reference (Nothing in Visual Basic). </exception>
<PermissionSet>
<IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Read="*AllFiles*" PathDiscovery="*AllFiles*"/>
<IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="SerializationFormatter"/>
</PermissionSet>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.DeletedSnapshotsCount">
<summary>
Gets the number of successfully deleted snapshots.
</summary>
<value>The number of successfully deleted snapshots.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.NonDeletedSnapshotId">
<summary>
Gets the non id of the snapshot that failed to be deleted.
</summary>
<value>The id of the snapshot that could not be deleted.</value>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssObjectType">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.VssObjectType"/> enumeration is used by requesters to identify an object as
a shadow copy set, shadow copy, or provider.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssObjectType.Unknown">
<summary>
<para>
The object type is not known.
</para>
<para>
This indicates an application error.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssObjectType.None">
<summary>
<para>
The interpretation of this value depends on whether it is used as an
input to a VSS method or returned as an output from a VSS method.
</para>
<para>
When used as an input to a VSS method, it indicates that the method is
not restricted to any particular object type, but should act on all
appropriate objects. In this sense, <see cref="F:Alphaleonis.Win32.Vss.VssObjectType.None"/> can be thought
of as a wildcard input.
</para>
<para>
When returned as an output, the object type is not known and means that
there has been an application error.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssObjectType.SnapshotSet">
<summary>Shadow copy set.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssObjectType.Snapshot">
<summary>Shadow copy.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssObjectType.Provider">
<summary>Shadow copy provider.</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException">
<summary>
Exception indicating that the writer ran out of memory or other system resources.
The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssRetryableWriterException">
<summary>
Exception indicating that the writer failed due to an error that would likely not occur if the entire backup, restore, or
shadow copy creation process was restarted. The recommended way to handle this error is to wait ten minutes and then
repeat the operation, up to three times.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssRetryableWriterException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRetryableWriterException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssRetryableWriterException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRetryableWriterException"/> class.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssRetryableWriterException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRetryableWriterException"/> class.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssRetryableWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRetryableWriterException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is <see langword="null"/>.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException"/> class.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException"/> class.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is <see langword="null"/>.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException">
<summary>
Exception indicating that the resynchronization destination contained a volume that was not explicitly included.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException"/> class.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException"/> class.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is <see langword="null"/>.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssDiffAreaProperties">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.VssDiffAreaProperties"/> structure describes associations between volumes containing the original file data
and volumes containing the shadow copy storage area (also known as the diff area).
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssDiffAreaProperties.#ctor(System.String,System.String,System.Int64,System.Int64,System.Int64)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDiffAreaProperties"/> class.
</summary>
<param name="volumeName">Name of the volume.</param>
<param name="diffAreaVolumeName">Name of the diff area volume.</param>
<param name="maximumDiffSpace">The maximum diff space.</param>
<param name="allocatedDiffSpace">The allocated diff space.</param>
<param name="usedDiffSpace">The used diff space.</param>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.VolumeName">
<summary>
Gets the original volume name.
</summary>
<value>The original volume name.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.DiffAreaVolumeName">
<summary>
Gets the shadow copy storage area volume name.
</summary>
<value>The shadow copy storage area volume name.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.MaximumDiffSpace">
<summary>
Gets the maximum space used on the shadow copy storage area volume for this association.
</summary>
<value>The maximum space used on the shadow copy storage area volume for this association.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.AllocatedDiffSpace">
<summary>
Gets the allocated space on the shadow copy storage area volume by this association.
This must be less than or equal to <see cref="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.MaximumDiffSpace"/>.
</summary>
<value>The allocated space on the shadow copy storage area volume by this association.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.UsedDiffSpace">
<summary>
Gets the used space from the allocated area. This must be less than or equal to <see cref="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.AllocatedDiffSpace"/>.
</summary>
<value>The the used space from the allocated area.</value>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException">
<summary>
Exception indicating that the writer status is not available for one or more writers.
A writer may have reached the maximum number of available backup and restore sessions.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException"/> class.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException"/> class.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is <see langword="null"/>.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException">
<summary>
Exception thrown to indicate that the maximum number of volumes has been added to the shadow copy set.
The specified volume was not added to the shadow copy set.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException">
<summary>
Exception thrown to indicate that the operation is not supported under the current context.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnsupportedContextException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnsupportedContextException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnsupportedContextException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnsupportedContextException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssUnexpectedErrorException">
<summary>
Exception class indicating that an unexpected error occured. The error code is logged in the error log file.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnexpectedErrorException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnexpectedErrorException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedErrorException"/> class with the specified error message.
</summary>
<param name="message">The error message.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnexpectedErrorException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedErrorException"/> class with the specified error message
and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message.</param>
<param name="innerException">The inner exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssUnexpectedErrorException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedErrorException"/> class with serialized data.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssResyncInProgressException">
<summary>
Exception thrown to indicate that another LUN resynchronization operation is already in progress.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssResyncInProgressException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssResyncInProgressException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssResyncInProgressException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssResyncInProgressException"/> class.
</summary>
<param name="message">The message.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssResyncInProgressException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssResyncInProgressException"/> class.
</summary>
<param name="message">The message.</param>
<param name="inner">The inner.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssResyncInProgressException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssResyncInProgressException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is <see langword="null"/>.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException">
<summary>
Exception indicating that the the shadow copy contains only a subset of the volumes needed by the writer to correctly back up the application component.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException"/> class.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException"/> class.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is <see langword="null"/>.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssRollForwardType">
<summary>
The <c>VssRollForwardType</c> enumeration is used by a requester to indicate the type of roll-forward operation it is about to perform.
</summary>
<remarks>
A requester sets the roll-forward operation type and specifies the restore point for partial roll-forward operations
using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRollForward(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,Alphaleonis.Win32.Vss.VssRollForwardType,System.String)"/>.
</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRollForwardType.Undefined">
<summary>
<para>
No roll-forward type is defined.
</para>
<para>
This indicates an error on the part of the requester.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRollForwardType.None">
<summary>
The roll-forward operation should not roll forward through logs.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRollForwardType.All">
<summary>
The roll-forward operation should roll forward through all logs.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRollForwardType.Partial">
<summary>
The roll-forward operation should roll forward through logs up to a specified restore point.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssSnapshotProperties">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotProperties"/> class contains the properties of a shadow copy or shadow copy set.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssSnapshotProperties.#ctor(System.Guid,System.Guid,System.Int64,System.String,System.String,System.String,System.String,System.String,System.String,System.Guid,Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes,System.DateTime,Alphaleonis.Win32.Vss.VssSnapshotState)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotProperties"/> class.
</summary>
<param name="snapshotId">The snapshot id.</param>
<param name="snapshotSetId">The snapshot set id.</param>
<param name="snapshotCount">The snapshot count.</param>
<param name="snapshotDeviceObject">The snapshot device object.</param>
<param name="originalVolumeName">Name of the original volume.</param>
<param name="originatingMachine">The originating machine.</param>
<param name="serviceMachine">The service machine.</param>
<param name="exposedName">Name of the exposed.</param>
<param name="exposedPath">The exposed path.</param>
<param name="providerId">The provider id.</param>
<param name="snapshotAttributes">The snapshot attributes.</param>
<param name="creationTimestamp">The creation timestamp.</param>
<param name="snapshotState">State of the snapshot.</param>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotId">
<summary>A <see cref="T:System.Guid"/> uniquely identifying the shadow copy identifier.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotSetId">
<summary>A <see cref="T:System.Guid"/> uniquely identifying the shadow copy set containing the shadow copy.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotsCount">
<summary>
<para>
Number of volumes included with the shadow copy in the shadow copy set when it was created.
Because it is possible for applications to release individual shadow copies without releasing the shadow copy
set, at any given time the number of shadow copies in the shadow copy set may be less than <see cref="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotsCount"/>
</para>
<para>
The maximum number of shadow-copied volumes permitted in a shadow copy set is 64.
</para>
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotDeviceObject">
<summary>
<para>
The name of the device object for the shadow copy of the volume. The device object can be thought of as
the root of a shadow copy of a volume. Requesters will use this device name when accessing files on a
shadow-copied volume that it needs to work with.
</para>
<para>
The device name does not contain a trailing "\".
</para>
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.OriginalVolumeName">
<summary>The name of the volume that had been shadow copied.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.OriginatingMachine">
<summary>The name of the machine containing the original volume.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.ServiceMachine">
<summary>The name of the machine running the Volume Shadow Copy Service that created the shadow copy.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.ExposedName">
<summary>The name of the shadow copy when it is exposed. This is a drive letter or mount point (if the shadow copy is exposed as a local volume), or a share name. </summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.ExposedPath">
<summary>The portion of the shadow copy of a volume made available if it is exposed as a share.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.ProviderId">
<summary>A <see cref="T:System.Guid"/> uniquely identifying the provider used to create this shadow copy.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotAttributes">
<summary>
The attributes of the shadow copy expressed as a bit mask (or bitwise OR) of members of
the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/> enumeration.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.CreationTimestamp">
<summary>Time stamp indicating when the shadow copy was created. The exact time is determined by the provider.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.Status">
<summary>Current shadow copy creation status. See <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotState"/>.</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssRevertInProgressException">
<summary>
Exception thrown to indicate that the volume already has a revert in progress.
</summary>
<remarks>
<note>
<b>Windows XP and Windows 2003:</b> This error is not supported until Windows Vista.
</note>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssRevertInProgressException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRevertInProgressException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssRevertInProgressException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRevertInProgressException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssRevertInProgressException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRevertInProgressException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssRevertInProgressException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRevertInProgressException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssUsageType">
<summary>The <see cref="T:Alphaleonis.Win32.Vss.VssUsageType"/> enumeration specifies how the host system uses the data managed by a writer involved in a VSS operation.</summary>
<remarks>Requester applications that are interested in backing up system state should look for writers with the
<see cref="F:Alphaleonis.Win32.Vss.VssUsageType.BootableSystemState"/> or <see cref="F:Alphaleonis.Win32.Vss.VssUsageType.SystemService"/> usage type.</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssUsageType.Undefined">
<summary><para>The usage type is not known.</para><para>This indicates an error on the part of the writer.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssUsageType.BootableSystemState">
<summary>The data stored by the writer is part of the bootable system state.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssUsageType.SystemService">
<summary>The writer either stores data used by a system service or is a system service itself.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssUsageType.UserData">
<summary>The data is user data.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssUsageType.Other">
<summary>Unclassified data.</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssRestoreMethod">
<summary>This enumeration is used by a writer at backup time to specify through its Writer Metadata Document the default file restore
method to be used with all the files in all the components it manages.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.Undefined">
<summary>
<para>No restore method is defined.</para>
<para>This indicates an error on the part of the writer.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreIfNotThere">
<summary>
A requester will restore files of a selected component or component set only if there are no versions of those files currently on the disk.
</summary>
<remarks>
<para>Unless alternate location mappings are defined for file restoration, if a version of any file managed by a selected component or component set is currently on the disk, none of the files managed by the selected component or component set will be restored.</para>
<para>If a file's alternate location mapping is defined, and a version of the files is present on disk at the original location, files will be written to the alternate location as long as no version of the file exists at the alternate location.</para>
</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreIfCanReplace">
<summary>
A requester will restore files of a selected component or component set only if there are no versions of those files currently on the disk that cannot be overwritten.
</summary>
<remarks>
<para>Unless alternate location mappings are defined for file restoration, if there is a version of any file that cannot be overwritten of the selected component or component set on the disk, none of the files managed by the component or component set will be restored.</para>
<para>If a file's alternate location mapping is defined, files will be written to the alternate location.</para>
</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.StopRestoreStart">
<summary>
This value is used by a writer to indicates that a given service must be stopped prior to the start of the restore. After the restore operation, the service will be restarted.
</summary>
<remarks>
The service to be stopped is specified by an argument to <c>IVssCreateWriterMetadata.SetRestoreMethod</c>.
</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreToAlternateLocation">
<summary>
A requester must restore the files of a selected component or component set to the location specified by the alternate location mapping specified in the writer component metadata file.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreAtReboot">
<summary>
A requester will restore the files of a selected component or component set following a reboot of the system.
<para>
Files to be restored should be copied to a temporary location, and the requester should use <c>File.Move</c> with the <c>DelayUntilReboot</c> flag
to complete the restoration of these files to their proper location following reboot. (Using AlphaFS for file operations).
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreAtRebootIfCannotReplace">
<summary>
If possible, a requester will restore the files of a selected component or component set to their correct location immediately.
</summary>
<remarks>
<para>If there are versions of any of the files managed by the selected component or component set on the disk that cannot be overwritten, then all the files managed by the selected component or component set will be restored following the reboot of the system.</para>
<para>In this case, files to be restored should be copied to a temporary location, and the requester should use <c>File.Move</c> with the <c>DelayUntilReboot</c> flag
to complete the restoration of these files to their proper location following reboot. (Using AlphaFS for file operations). </para>
<note><b>Windows XP:</b> This value is not supported until Windows Server 2003</note>
</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.Custom">
<summary>
This value indicates that a custom restore method will be used to restore the files managed by the selected component or component set.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreStopStart">
<summary>
The requester should perform the restore operation as follows:
<list type="number">
<item><description>Send the PreRestore event and wait for all writers to process it.</description></item>
<item><description>Restore the files to their original locations.</description></item>
<item><description>Send the PostRestore event and wait for all writers to process it.</description></item>
<item><description>Stop the service.</description></item>
<item><description>Restart the service.</description></item>
</list>
<para>The service to be stopped is specified by the writer beforehand when it calls the IVssCreateWriterMetadata::SetRestoreMethod method.
The requester can obtain the name of the service by examining the <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.RestoreMethod"/> property.</para>
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException">
<summary>
Exception thrown to indicate that the volume does not support the requested operation, or that no provider supports it.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException">
<summary>
Exception thrown to indicate that the system was unable to thaw the
Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).
</summary>
<remarks>
<note>
<b>Windows Server 2003 and Windows XP:</b> This exception is not supported until Windows Vista.
</note>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">
<summary>
Exception thrown to indicate that the XML document is not valid. Check the event log for details.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException">
<summary>
Exception thrown to indicate that the system was unable to hold I/O writes.
</summary>
<remarks>
This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssTimeoutWriterException">
<summary>
Exception indicating that the writer operation failed because of a time-out between the Freeze and Thaw events. The recommended way to
handle this error code is to wait ten minutes and then repeat the operation, up to three times.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssTimeoutWriterException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTimeoutWriterException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssTimeoutWriterException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTimeoutWriterException"/> class.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssTimeoutWriterException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTimeoutWriterException"/> class.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssTimeoutWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTimeoutWriterException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is <see langword="null"/>.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssSnapshotState">
<summary>The <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotState"/> enumeration is returned by a provider to specify the state of a given shadow copy operation.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Unknown">
<summary><para>Reserved for system use.</para><para>Unknown shadow copy state.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Preparing">
<summary><para>Reserved for system use.</para><para>Shadow copy is being prepared.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingPrepare">
<summary><para>Reserved for system use.</para><para>Processing of the shadow copy preparation is in progress.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Prepared">
<summary><para>Reserved for system use.</para><para>Shadow copy has been prepared.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingPreCommit">
<summary><para>Reserved for system use.</para><para>Processing of the shadow copy precommit is in process.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.PreComitted">
<summary><para>Reserved for system use.</para><para>Shadow copy is precommitted.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingCommit">
<summary><para>Reserved for system use.</para><para>Processing of the shadow copy commit is in process.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Committed">
<summary><para>Reserved for system use.</para><para>Shadow copy is committed.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingPostCommit">
<summary><para>Reserved for system use.</para><para>Processing of the shadow copy postcommit is in process.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingPreFinalCommit">
<summary><para>Reserved for system use.</para><para>Processing of the shadow copy file commit operation is underway.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.PreFinalCommitted">
<summary><para>Reserved for system use.</para><para>Processing of the shadow copy file commit operation is done.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingPostFinalCommit">
<summary><para>Reserved for system use.</para><para>Processing of the shadow copy following the final commit and prior to shadow copy create is underway.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Created">
<summary><para>Shadow copy is created.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Aborted">
<summary><para>Reserved for system use.</para><para>Shadow copy creation is aborted.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Deleted">
<summary><para>Reserved for system use.</para><para>Shadow copy has been deleted.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.PostCommitted">
<summary><para>Reserved value.</para></summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException">
<summary>
Exception indicating that the maximum number of shadow copy storage areas has been added to
the shadow copy source volume. The specified shadow copy storage volume was not associated
with the specified shadow copy source volume.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">
<summary>
Exception indicating that the requested method is not supported on the current operating system, or the loaded
assembly is targeted for a different operating system than the one on which it is running.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> class.
</summary>
<param name="message">The message.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> class.
</summary>
<param name="message">The message.</param>
<param name="innerException">The inner exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.ProcessorArchitecture">
<summary>
Enumeration used by <see cref="T:Alphaleonis.Win32.Vss.OperatingSystemInfo"/> to indicate the current
processor architecture for which the operating system is targeted and running.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.ProcessorArchitecture.X86">
<summary>
The system is running a 32-bit version of Windows.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.ProcessorArchitecture.IA64">
<summary>
The system is running an Itanium processor.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.ProcessorArchitecture.X64">
<summary>
The system is running a 64-bit version of Windows.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.ProcessorArchitecture.Unknown">
<summary>
Unknown architecture.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException">
<summary>
Exception thrown to indicate that the volume is not supported by the specified provider.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssPartialFileInfo">
<summary>
Representation of information on a partial file associated with a component.
</summary>
<remarks>See <see href="http://msdn.microsoft.com/en-us/library/aa383529(VS.85).aspx">MSDN documentation on IVssComponent::GetPartialFile Method</see> for more information.</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssPartialFileInfo.#ctor(System.String,System.String,System.String,System.String)">
<summary>Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssPartialFileInfo"/> class</summary>
<param name="path">The path of the partial file.</param>
<param name="fileName">The name of the partial file.</param>
<param name="range">Either a listing of file offsets and lengths that make up the partial file support range
(the sections of the file that were backed up), or the name of a file containing such a list.</param>
<param name="metadata">Any additional metadata required by a writer to validate a partial file restore operation. The information in this
metadata string will be opaque to requesters. May be <see langword="null"/></param>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssPartialFileInfo.Path">
<summary>
<para>
The path of the partial file.
</para>
<para>
Users of this public need to check to determine whether this path ends with a backslash ("\").
</para>
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssPartialFileInfo.FileName">
<summary>The name of the partial file.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssPartialFileInfo.Range">
<summary>
Either a listing of file offsets and lengths that make up the partial file support range
(the sections of the file that were backed up), or the name of a file containing such a list.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssPartialFileInfo.Metadata">
<summary>
<para>
Any additional metadata required by a writer to validate a partial file restore operation. The information in this
metadata string will be opaque to requesters.
</para>
<para>
Additional metadata is not required, so <see cref="P:Alphaleonis.Win32.Vss.VssPartialFileInfo.Metadata"/> may also be empty (zero length).
</para>
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssBackupSchema">
<summary>The <see cref="T:Alphaleonis.Win32.Vss.VssBackupSchema"/> enumeration is used by a writer to indicate the types of backup operations it can participate in.
The supported kinds of backup are expressed as a bit mask (or bitwise OR) of <see cref="T:Alphaleonis.Win32.Vss.VssBackupSchema"/> values.</summary>
<remarks>
<para>
<note>
<b>Windows XP:</b> This enumeration is not available until Windows Server 2003 or later.
</note>
</para>
<para>
Writer set their backup schemas with calls to <c>IVssCreateWriterMetadata.SetBackupSchema"</c>.
</para>
<para>
Requesters use <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.BackupSchema"/> to determine the backup schema that a writer supports.
</para>
<para>
For a specific kind of backup operation to be supported, the writer must support the corresponding schema, and the
requester must set the corresponding backup type.
</para>
<para>
For example, to involve a writer in an incremental backup operation, the requester must set the backup type to
<see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/>, and the writer should have a backup schema that includes <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental"/>.
</para>
<para>
A writer that does not support the backup schema corresponding to a requester's backup type should treat the backup operation
that is being performed as if it were a default (full) backup. If the desired backup type is not supported by the writer's
backup schema, the requester can either perform a full backup for this writer or exclude the writer from the backup operation.
A requester can exclude a writer by selecting none of the writer's components, or by disabling the writer
(see <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DisableWriterClasses(System.Guid[])"/> or
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DisableWriterInstances(System.Guid[])"/>).
</para>
</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Undefined">
<summary>
The writer supports a simple full backup and restoration of entire files (as defined by a <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> value of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Full"/>).
This backup scheme can be used as the basis of an incremental or differential backup. This is the default value.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Differential">
<summary>
The writer supports differential backups (corresponding to the <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> value <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Differential"/>).
Files created or changed since the last full backup are saved. Files are not marked as having been backed up. This setting does not preclude mixing of incremental and differential backups.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental">
<summary>
The writer supports incremental backups (corresponding to the <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> value <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/>). Files created or changed since the last full or incremental backup are saved. Files are marked as having been backed up. This setting does not preclude mixing of incremental and differential backups.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.ExclusiveIncrementalDifferential">
<summary>
The writer supports both differential and incremental backup schemas, but only exclusively: for example, you cannot follow a differential backup with an incremental one.
A writer cannot support this schema if it does not support both incremental and differential schemas (<see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Differential"/> | <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental"/>).
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Log">
<summary>
<para>The writer supports backups that involve only the log files it manages (corresponding to a <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> value of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Log"/>). </para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Copy">
<summary>
Similar to the default backup schema (<see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Undefined"/>), the writer supports copy backup operations
(corresponding to <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Copy"/>) where file access information (such as information as to when a file was
last backed up) will not be updated either in the writer's own state information or in the file system information. This type of
backup cannot be used as the basis of an incremental or differential backup.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Timestamped">
<summary>
<para>
A writer supports using the VSS time-stamp mechanism when evaluating if a file should be included in
differential or incremental operations (corresponding to <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Differential"/> and
<see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/>, respectively) using the <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.PreviousBackupStamp"/>,
<see cref="P:Alphaleonis.Win32.Vss.IVssComponent.BackupStamp"/> setters, and the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetPreviousBackupStamp(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/> method.
</para>
<para>
A writer cannot support this schema if it does not support either differential or incremental backup schemas
(<see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Differential"/> or <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental"/>).
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.LastModify">
<summary>
<para>
When implementing incremental or differential backups with differenced files, a writer can provide last modification
time information for files (using <c>IVssComponent.AddDifferencedFileByLastModifyTime</c>).
A requester then can use <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.DifferencedFiles"/> to obtain candidate files and information
about their last modification data. The requester can use this information (along with any records about
previous backup operations it maintains) to decide if a file should be included in incremental and differential backups.
</para>
<para>
This scheme does not apply to partial file implementations of incremental and differential backup operations.
</para>
<para>
A writer cannot support this schema if it does not support either incremental or differential backup
schemas (<see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Differential"/> or <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental"/>.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Lsn">
<summary>
Reserved for system use.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.WriterSupportsNewTarget">
<summary>
The writer supports a requester changing the target for file restoration using
<see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddNewTarget(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String,System.String,System.Boolean,System.String)"/>.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.WriterSupportsRestoreWithMove">
<summary>
<para>
The writer supports running multiple writer instances with the same class ID, and it supports a
requester moving a component to a different writer instance at restore time using
<see cref="O:Alphaleonis.Win32.Vss.IVssBackupComponents.SetSelectedForRestore"/>.
</para>
<para>
<b>Windows Server 2003:</b> This value is not supported until Windows Server 2003 SP1.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.IndependentSystemState">
<summary>
<para>
The writer supports backing up data that is part of the system state, but that can also
be backed up independently of the system state.
</para>
<para>
<b>Windows Server 2003:</b> This value is not supported until Windows Vista.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.RollForwardRestore">
<summary>
<para>
The writer supports a requester setting a roll-forward restore point using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRollForward(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,Alphaleonis.Win32.Vss.VssRollForwardType,System.String)"/>.
</para>
<para>
<b>Windows Server 2003:</b> This value is not supported until Windows Vista.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.RestoreRename">
<summary>
<para>
The writer supports a requester setting a restore name using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRestoreName(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/>.
</para>
<para>
<b>Windows Server 2003:</b> This value is not supported until Windows Vista.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.AuthoritativeRestore">
<summary>
<para>
The writer supports a requester setting authoritative restore using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetAuthoritativeRestore(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Boolean)"/>.
</para>
<para>
<b>Windows Server 2003:</b> This value is not supported until Windows Vista.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.WriterSupportsParallelRestores">
<summary>
<para>
The writer supports multiple unsynchronized restore events.
</para>
<para>
<b>Windows Vista and Windows Server 2003:</b> This value is not supported until Windows Server 2008.
</para>
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssWMFileDescriptor">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.VssWMFileDescriptor"/> class is returned to a calling application by a number of query methods.
It provides detailed information about a file or set of files (a file set).
</summary>
<remarks>
The following methods return a <see cref="T:Alphaleonis.Win32.Vss.VssWMFileDescriptor"/> instance:
<list type="bullet">
<item><description><see cref="P:Alphaleonis.Win32.Vss.IVssComponent.AlternateLocationMappings"/></description></item>
<item><description><see cref="P:Alphaleonis.Win32.Vss.IVssComponent.NewTargets"/></description></item>
<item><description><see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.ExcludeFiles"/></description></item>
<item><description><see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.AlternateLocationMappings"/></description></item>
<item><description><see cref="P:Alphaleonis.Win32.Vss.IVssWMComponent.Files"/></description></item>
<item><description><see cref="P:Alphaleonis.Win32.Vss.IVssWMComponent.DatabaseFiles"/></description></item>
<item><description><see cref="P:Alphaleonis.Win32.Vss.IVssWMComponent.DatabaseLogFiles"/></description></item>
</list>
</remarks>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssWMFileDescriptor.#ctor(System.String,Alphaleonis.Win32.Vss.VssFileSpecificationBackupType,System.String,System.String,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWMFileDescriptor"/> class.
</summary>
<param name="alternateLocation">The alternate location.</param>
<param name="backupTypeMask">The backup type mask.</param>
<param name="fileSpecification">The file specification.</param>
<param name="path">The path.</param>
<param name="isRecursive">if set to <c>true</c> this file description is recursive.</param>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWMFileDescriptor.AlternateLocation">
<summary>
Obtains the alternate backup location of the component files.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWMFileDescriptor.BackupTypeMask">
<summary>
Obtains the file backup specification for a file or set of files.
</summary>
<remarks><note><b>Windows XP:</b> This value is not supported in Windows XP and will always return <see cref="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.Unknown"/></note></remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWMFileDescriptor.FileSpecification">
<summary>
Obtains the file specification for the list of files provided.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWMFileDescriptor.Path">
<summary>
Obtains the fully qualified directory path for the list of files provided.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssWMFileDescriptor.IsRecursive">
<summary>
Determines whether only files in the root directory or files in the entire directory hierarchy are considered for backup.
</summary>
<remarks>VSS API reference: <c>IVssWMFiledesc::GetRecursive()</c></remarks>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssComponentFailure">
<summary>
Represents a component-level error reported by writers.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssComponentFailure.#ctor(System.Int32,System.Int32,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssComponentFailure"/> class.
</summary>
<param name="errorCode">The error code.</param>
<param name="applicationErrorCode">The application error code.</param>
<param name="applicationMessage">The application message.</param>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssComponentFailure.ErrorCode">
<summary>
Gets the HRESULT failure code that the writer passed for the hr parameter of the IVssComponentEx2::SetFailure method.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssComponentFailure.ApplicationErrorCode">
<summary>
Gets the additional error code if provided by the writer.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssComponentFailure.ApplicationMessage">
<summary>
Gets an error message for the requester to display to the end user. The writer is responsible for localizing this string if necessary before using it in this method. This parameter is optional and can be <see langword="null"/> or an empty string.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssWriterState">
<summary>The <see cref="T:Alphaleonis.Win32.Vss.VssWriterState"/> enumeration indicates the current state of the writer.</summary>
<remarks>A requester determines the state of a writer through <see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterStatus"/>.</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.Unknown">
<summary><para>The writer's state is not known.</para><para>This indicates an error on the part of the writer.</para></summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.Stable">
<summary>The writer has completed processing current shadow copy events and is ready to proceed, or <c>CVssWriter::OnPrepareSnapshot</c> has not yet been called.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.WaitingForFreeze">
<summary>The writer is waiting for the freeze state.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.WaitingForThaw">
<summary>The writer is waiting for the thaw state.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.WaitingForPostSnapshot">
<summary>The writer is waiting for the <c>PostSnapshot</c> state.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.WaitingForBackupComplete">
<summary>The writer is waiting for the requester to finish its backup operation.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtIdentify">
<summary>The writer vetoed the shadow copy creation process at the writer identification state.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtPrepareBackup">
<summary>The writer vetoed the shadow copy creation process during the backup preparation state.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtPrepareSnapshot">
<summary>The writer vetoed the shadow copy creation process during the <c>PrepareForSnapshot</c> state.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtFreeze">
<summary>The writer vetoed the shadow copy creation process during the freeze state.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtThaw">
<summary>The writer vetoed the shadow copy creation process during the thaw state.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtPostSnapshot">
<summary>The writer vetoed the shadow copy creation process during the <c>PostSnapshot</c> state.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtBackupComplete">
<summary>The shadow copy has been created and the writer failed during the <c>BackupComplete</c> state.
A writer should save information about this failure to the error log.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtPreRestore">
<summary>The writer failed during the <c>PreRestore</c> state.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtPostRestore">
<summary>The writer failed during the <c>PostRestore</c> state.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtBackupShutdown">
<summary>The writer failed during the shutdown of the backup application.</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssBackupType">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> enumeration indicates the type of backup to be performed using VSS writer/requester
coordination.
</summary>
<remarks>
For more information see <see href="http://msdn.microsoft.com/en-us/library/aa384679(VS.85).aspx">MSDN documentation on
VSS_BACKUP_TYPE Enumeration</see>
</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupType.Undefined">
<summary>
<para>
The backup type is not known.
</para>
<para>
This value indicates an application error.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupType.Full">
<summary>
<para>Full backup: all files, regardless of whether they have been marked as backed up or not, are saved. This is the default backup type and schema, and all writers support it.</para>
<para>Each file's backup history will be updated to reflect that it was backed up.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental">
<summary>
<para>
Incremental backup: files created or changed since the last full or incremental backup are saved. Files are marked as having been backed up.
</para>
<para>
A requester can implement this sort of backup on a particular writer only if it supports the <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental"/> schema.
</para>
<para>
If a requester's backup type is <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/> and a particular writer's backup schema does not support that sort of backup, the requester will always perform a full (<see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Full"/>) backup on that writer's data.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupType.Differential">
<summary>
<para>
Differential backup: files created or changed since the last full backup are saved. Files are not marked as having been backed up.
</para>
<para>
A requester can implement this sort of backup on a particular writer only if it supports the <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Differential"/> schema.
</para>
<para>
If a requester's backup type is <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Differential"/> and a particular writer's backup schema does not support that sort of backup, the requester will always perform a full (<see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Full"/>) backup on that writer's data.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupType.Log">
<summary>
<para>
The log file of a writer is to participate in backup or restore operations.
</para>
<para>
A requester can implement this sort of backup on a particular writer only if it supports the <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Log"/> schema.
</para>
<para>
If a requester's backup type is <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Log"/> and a particular writer's backup schema does not support that sort of backup, the requester will always perform a full (<see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Full"/>) backup on that writer's data.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupType.Copy">
<summary>
<para>
Files on disk will be copied to a backup medium regardless of the state of each file's backup history, and the backup history will not be updated.
</para>
<para>
A requester can implement this sort of backup on a particular writer only if it supports the <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Copy"/> schema.
</para>
<para>
If a requester's backup type is <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Copy"/> and a particular writer's backup schema does not support that sort of backup, the requester will always perform a full (<see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Full"/>) backup on that writer's data.
</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssBackupType.Other">
<summary>Backup type that is not full, copy, log, incremental, or differential.</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssProviderProperties">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.VssProviderProperties"/> class specifies shadow copy provider properties.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssProviderProperties.#ctor(System.Guid,System.String,Alphaleonis.Win32.Vss.VssProviderType,System.String,System.Guid,System.Guid)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderProperties"/> class.
</summary>
<param name="providerId">The provider id.</param>
<param name="providerName">Name of the provider.</param>
<param name="providerType">Type of the provider.</param>
<param name="providerVersion">The provider version.</param>
<param name="providerVersionId">The provider version id.</param>
<param name="classId">The class id.</param>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ProviderId">
<summary>Identifies the provider who supports shadow copies of this class.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ProviderName">
<summary>The provider name.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ProviderType">
<summary>The provider type. See <see cref="T:Alphaleonis.Win32.Vss.VssProviderType"/> for more information.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ProviderVersion">
<summary>The provider version in readable format.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ProviderVersionId">
<summary>A <see cref="T:System.Guid"/> uniquely identifying the version of a provider.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ClassId">
<summary>Class identifier of the component registered in the local machine's COM catalog.</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo">
<summary>
Contains information about a volume's shadow copy protection level.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.#ctor(Alphaleonis.Win32.Vss.VssProtectionLevel,System.Boolean,Alphaleonis.Win32.Vss.VssProtectionFault,System.UInt32,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo"/> class.
</summary>
<param name="protectionLevel">The protection level.</param>
<param name="volumeIsOfflineForProtection">if set to <c>true</c> the volume is offline for protection.</param>
<param name="protectionFault">The protection fault.</param>
<param name="failureStatus">The failure status.</param>
<param name="volumeHasUnusedDiffArea">if set to <c>true</c> the volume has unused diff area.</param>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.ProtectionLevel">
<summary>
Gets the target protection level for the volume.
</summary>
<value>The target protection level for the volume.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.VolumeIsOfflineForProtection">
<summary>
Gets a value indicating whether the volume is offline due to a protection fault.
</summary>
<value>
<c>true</c> if the volume is offline due to a protection fault; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.ProtectionFault">
<summary>
Gets a value that describes the shadow copy protection fault that caused the volume to go offline.
</summary>
<value>A value that describes the shadow copy protection fault that caused the volume to go offline.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.FailureStatus">
<summary>
Gets the internal failure status code.
</summary>
<value>The internal failure status code.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.VolumeHasUnusedDiffArea">
<summary>
Gets a value indicating whether the volume has unused shadow copy storage area files or not.
</summary>
<value>
<c>true</c> if the volume has unused shadow copy storage area files; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssDifferencedFileInfo">
<summary>
Information about a file set (a specified file or files) to participate in an incremental or differential backup
or restore as a differenced file, that is, backup and restores associated with it are to be implemented as if
entire files are copied to and from backup media (as opposed to using partial files).
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.#ctor(System.String,System.String,System.Boolean,System.DateTime)">
<summary>Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDifferencedFileInfo"/> class.</summary>
<param name="path">The path to the differenced files.</param>
<param name="fileSpecification">The file specification of the differenced files.</param>
<param name="lastModifyTime">The time of last modification for the difference files.</param>
<param name="isRecursive"><see langword="true"/> if the filespec for the differenced files should be interpreted recursively, <see langword="false"/> otherwise.</param>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.Path">
<summary>
<para>
The path to the differenced files.
</para>
<para>
Users of this method need to check to determine whether this path ends with a backslash (\).
</para>
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.FileSpecification">
<summary>The file specification of the differenced files.</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.IsRecursive">
<summary>
Boolean specifying whether the file specification for the differenced files should be interpreted recursively.
If <see langword="true"/>, then the entire directory hierarchy will need to be searched for files matching the
file specification <see cref="P:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.FileSpecification"/> to find files to be handled as differenced files during incremental
or differential backups. If <see langword="false"/>, only the root directory needs to be searched.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.LastModifyTime">
<summary>
The writer specification of the time of last modification for the difference files.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssProviderVetoException">
<summary>
Exception thrown to indicate an expected provider error. The provider logged the error in the event log.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssProviderVetoException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException"/>
class with a system-supplied message describing the error.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssProviderVetoException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssProviderVetoException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssProviderVetoException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssComponentType">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.VssComponentType"/> enumeration is used by both the requester and the writer to specify the type of component being used
with a shadow copy backup operation.
</summary>
<remarks>
<para>
A writer sets a component's type when it adds the component to its Writer Metadata Document using
<c>IVssCreateWriterMetadata.AddComponent</c>
</para>
<para>
Writers and requesters can find the type information of components selected for inclusion in a Backup
Components Document through calls to <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.ComponentType"/> to return a component type directly.
</para>
<para>
A requester can obtain the type of any component in a given writer's Writer Metadata Document by doing the following:
<list type="number">
<item><description>Using <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Components"/> to obtain a <see cref="T:Alphaleonis.Win32.Vss.IVssWMComponent"/> interface</description></item>
<item><description>Examining the Type member of the <see cref="T:Alphaleonis.Win32.Vss.IVssWMComponent"/> object</description></item>
</list>
</para>
</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssComponentType.Undefined">
<summary><para>Undefined component type.</para>
<para>This value indicates an application error.</para>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssComponentType.Database">
<summary>Database component.</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssComponentType.FileGroup">
<summary>File group component. This is any component other than a database.</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException">
<summary>
Exception thrown to indicate that the specified snapshot specifies a shadow copy that does not exist in the Backup Components Document.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException"/> class.
</summary>
<param name="message">The message.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException"/> class.
</summary>
<param name="message">The message.</param>
<param name="inner">The inner.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is <see langword="null"/>.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssPartialFailureWriterException">
<summary>
Exception indicating the writer is reporting one or more component-level errors.
To retrieve the errors, the requester must use the <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.Failure"/> property.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssPartialFailureWriterException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssPartialFailureWriterException"/> class.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssPartialFailureWriterException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssPartialFailureWriterException"/> class.
</summary>
<param name="message">The message that describes the error</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssPartialFailureWriterException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssPartialFailureWriterException"/> class.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssPartialFailureWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssPartialFailureWriterException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is <see langword="null"/>.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssProtectionFault">
<summary>
Defines the set of shadow copy protection faults.
A shadow copy protection fault occurs when the VSS service is unable to perform a copy-on-
write operation to the shadow copy storage area (also called the diff area).
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.None">
<summary>
No shadow copy protection fault has occurred.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.DiffAreaMissing">
<summary>
The volume that contains the shadow copy storage area could not be found. Usually this fault means that the volume has not yet arrived in the system.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.IOFailureDuringOnline">
<summary>
The volume that contains the shadow copy storage area could not be brought online because an I/O failure occurred.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.MetadataCorruption">
<summary>
The shadow copy metadata for the shadow copy storage area has been corrupted.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.MemoryAllocationFailure">
<summary>
A memory allocation failure occurred. This could be caused by a temporary low-memory condition that does not happen again after you clear the fault and restart the shadow copy operation.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.MappedMemoryFailure">
<summary>
A memory mapping failure occurred. This fault could mean that the page file is too small, or it could be caused by a low-memory condition.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.CowReadFailure">
<summary>
A read failure occurred during the copy-on-write operation when data was being copied from the live volume to the shadow copy storage area volume.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.CowWriteFailure">
<summary>
A read or write failure occurred during the copy-on-write operation when data was being copied from the live volume to the shadow copy storage area volume. One possible reason is that the shadow copy storage area volume has been removed from the system.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.DiffAreaFull">
<summary>
This failure means that either the shadow copy storage area is full or the shadow copy storage area volume is full.
After clearing the protection fault, you can do one of the following:
<list type="bullet">
<item><description>Delete unused shadow copy storage areas by calling the <see cref="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.DeleteUnusedDiffAreas(System.String)"/> method.</description></item>
<item><description>Increase the shadow copy storage area maximum size for the volume by calling the <see cref="O:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.ChangeDiffAreaMaximumSize"/> method.</description></item>
</list>
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.GrowTooSlow">
<summary>
The size of the shadow copy storage area could not be increased because there was no longer enough space on the shadow copy storage area volume.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.GrowFailed">
<summary>
The size of the shadow copy storage area could not be increased.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.DestroyAllSnapshots">
<summary>
An unexpected error occurred.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.FileSystemFailure">
<summary>
Either the shadow copy storage area files could not be opened or the shadow copy storage area volume could not be mounted because of a file system operation failure.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.IOFailure">
<summary>
A read or write failure occurred on the shadow copy storage area volume.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.DiffAreaRemoved">
<summary>
The shadow copy storage area volume was removed from the system or could not be accessed for some other reason.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.ExternalWriterToDiffArea">
<summary>
Another application attempted to write to the shadow copy storage area.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.OSVersionName">
<summary>
Enumeration used to discriminate between the named windows versions.
</summary>
<remarks>
The values of the enumeration are ordered so a later released operating system version
has a higher number, so comparisons between named versions are meaningful.
</remarks>
</member>
<member name="F:Alphaleonis.Win32.Vss.OSVersionName.Earlier">
<summary>
A windows version earlier than Windows 2000.
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.OSVersionName.Windows2000">
<summary>
Windows 2000 (Server or Professional)
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.OSVersionName.WindowsXP">
<summary>
Windows XP
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.OSVersionName.WindowsServer2003">
<summary>
Windows Server 2003
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.OSVersionName.WindowsVista">
<summary>
Windows Vista
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.OSVersionName.WindowsServer2008">
<summary>
Windows Server 2008
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.OSVersionName.Windows7">
<summary>
Windows 7
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.OSVersionName.WindowsServer2008R2">
<summary>
Windows Server 2008 R2
</summary>
</member>
<member name="F:Alphaleonis.Win32.Vss.OSVersionName.Later">
<summary>
A Windows version later than Windows Server 2008R2.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssDirectedTargetInfo">
<summary>
Represents information stored by a writer, at backup time, to the Backup Components Document to indicate that when a
file is to be restored, it (the source file) should be remapped. The file may be restored to a new restore target
and/or ranges of its data restored to different locations with the restore target.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.#ctor(System.String,System.String,System.String,System.String,System.String,System.String)">
<summary>Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDirectedTargetInfo"/> class.</summary>
<param name="sourcePath">The source path.</param>
<param name="sourceFileName">The source file name.</param>
<param name="sourceRangeList">The source range list.</param>
<param name="destinationPath">The destination path.</param>
<param name="destinationFileName">The destination file name.</param>
<param name="destinationRangeList">The destination range list.</param>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.SourcePath">
<summary>
The path to the directory that at backup time contained the file to be restored (the source file). This path should
match or be beneath the path of a file set already in the component or one of its Subcomponents
(if the component defines a component set).
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.SourceFileName">
<summary>
The name of the file (at backup time) that is to be remapped during a restore (the source file).
The name of this file should not contain any wildcard characters, and must be a member of the same
file set as the source path (<see cref="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.SourcePath"/>).
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.SourceRangeList">
<summary>
<para>
A comma-separated list of file offsets and lengths indicating the source file
support range (the sections of the file to be restored).
</para>
<para>
The number and length of the source file support ranges must match the number and size of destination file support ranges.
</para>
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.DestinationPath">
<summary>
The path to which source file data will be remapped at restore time.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.DestinationFileName">
<summary>
The name of the file to which source file data will be remapped at restore time.
</summary>
</member>
<member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.DestinationRangeList">
<summary>
<para>
A comma-separated list of file offsets and lengths indicating the destination file support range (locations to which
the sections of the source file are to be restored).
</para>
<para>
The number and length of the destination file support ranges must match the number and size of source file support ranges.
</para>
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.OperatingSystemInfo">
<summary>
Static class providing access to information about the operating system under which the
assembly is executing.
</summary>
</member>
<member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.IsWow64Process">
<summary>
Determines whether the current process is running under WOW64.
</summary>
<returns>
<c>true</c> if the current process is running under WOW64; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.IsAtLeast(Alphaleonis.Win32.Vss.OSVersionName)">
<summary>
Determines whether the operating system is of the specified version or later.
</summary>
<param name="version">The lowest version for which to return <c>true</c>.</param>
<returns>
<c>true</c> if the operating system is of the specified <paramref name="version"/> or later; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.IsAtLeast(Alphaleonis.Win32.Vss.OSVersionName,System.Int32)">
<summary>
Determines whether operating system is of the specified version or later, allowing specification of
a minimum service pack that must be installed on the lowest version.
</summary>
<param name="version">The minimum required version.</param>
<param name="servicePackVersion">The major version of the service pack that must be installed on the
minimum required version to return <c>true</c>. This can be 0 to indicate that no service pack is required.</param>
<returns>
<c>true</c> if the operating system matches the specified <paramref name="version"/> with the specified service pack, or if the operating system is of a later version; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.RequireServerOrClientAtLeast(Alphaleonis.Win32.Vss.OSVersionName,System.Int32,Alphaleonis.Win32.Vss.OSVersionName,System.Int32)">
<summary>
Determines whether operating system is of the specified server version or later or if it is of the specified client
version or later and throws <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> otherwise.
</summary>
<param name="serverVersion">The minimum server version.</param>
<param name="serverServicePackVersion">The minimum server service pack version (applies only if the version exactly matches the specified server version).</param>
<param name="clientVersion">The minimum client version.</param>
<param name="clientServicePackVersion">The minimum client service pack version (applies only if the version exactly matches the specified client version).</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.RequireServer(Alphaleonis.Win32.Vss.OSVersionName,System.Int32)">
<summary>
Determines whether the operating system is a server operating system of atleast the specified <paramref name="serverVersion"/> and
<paramref name="serverServicePackVersion"/> and throws an <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> otherwise.
</summary>
<param name="serverVersion">The server version.</param>
<param name="serverServicePackVersion">The server service pack version.</param>
</member>
<member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.RequireAtLeast(Alphaleonis.Win32.Vss.OSVersionName)">
<summary>
Determines whether the assembly is executing on the specified operating system version or later.
If not, an exception is thrown.
</summary>
<param name="osVersion">The minimum operating system version required.</param>
<exception cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">The current operating system is of a version earlier than the specified <paramref name="osVersion"/></exception>
</member>
<member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.RequireAtLeast(Alphaleonis.Win32.Vss.OSVersionName,System.Int32)">
<summary>
Determines whether the assembly is executing on the specified operating system version with
the specified service pack installed or any later version of windows. If not, an exception is thrown.
</summary>
<param name="osVersion">The minimum operating system version required.</param>
<param name="servicePackVersion">The minimum service pack version required.</param>
<exception cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">The current operating system is of a version earlier
than the specified <paramref name="osVersion"/> or the versions match but the operating system does not
have at least the specified service pack version <paramref name="servicePackVersion"/> installed.</exception>
</member>
<member name="P:Alphaleonis.Win32.Vss.OperatingSystemInfo.OSVersionName">
<summary>
Gets the named version of the operating system.
</summary>
<value>The named version of the operating system.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.OperatingSystemInfo.IsServer">
<summary>
Gets a value indicating whether the operating system is a server os.
</summary>
<value>
<c>true</c> if the current operating system is a server os; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.OperatingSystemInfo.OSVersion">
<summary>
Gets the numeric version of the operating system. This is the same as returned by
<see cref="P:System.Environment.OSVersion"/>.
</summary>
<value>The numeric version of the operating system.</value>
</member>
<member name="P:Alphaleonis.Win32.Vss.OperatingSystemInfo.ServicePackVersion">
<summary>
Gets the version of the service pack currently installed on the operating system.
</summary>
<value>The version of the service pack currently installed on the operating system.</value>
<remarks>Only the <see cref="P:System.Version.Major"/> and <see cref="P:System.Version.Minor"/> fields are
used.</remarks>
</member>
<member name="P:Alphaleonis.Win32.Vss.OperatingSystemInfo.ProcessorArchitecture">
<summary>
Gets the processor architecture for which the operating system is targeted.
</summary>
<value>The processor architecture for which the operating system is targeted.</value>
<remarks>If running under WOW64 this will return a 32-bit processor. Use <see cref="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.IsWow64Process"/> to
determine if this is the case.
</remarks>
</member>
</members>
</doc>
|