bin/PSFramework.xml
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 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 |
<?xml version="1.0"?>
<doc> <assembly> <name>PSFramework</name> </assembly> <members> <member name="T:PSFramework.Commands.InvokePSFCallbackCommand"> <summary> Command executing callbacks in functions </summary> </member> <member name="F:PSFramework.Commands.InvokePSFCallbackCommand.Data"> <summary> Data to pass to the callback scriptblocks </summary> </member> <member name="F:PSFramework.Commands.InvokePSFCallbackCommand.EnableException"> <summary> Whether to trigger a terminating exception in case the scriptblock errors out. Will be picked up automatically if not specified. </summary> </member> <member name="F:PSFramework.Commands.InvokePSFCallbackCommand.PSCmdlet"> <summary> The cmdlet object to use for triggering terminating errors. Will be picked up automatically if not specified. </summary> </member> <member name="F:PSFramework.Commands.InvokePSFCallbackCommand._Caller"> <summary> Information on the calling command, including name, module, file and line. </summary> </member> <member name="F:PSFramework.Commands.InvokePSFCallbackCommand._ErrorScript"> <summary> script used to write horrible errors on screen </summary> </member> <member name="M:PSFramework.Commands.InvokePSFCallbackCommand.BeginProcessing"> <summary> Prepare runtime information, such as calling command or cmdlet object </summary> </member> <member name="M:PSFramework.Commands.InvokePSFCallbackCommand.ProcessRecord"> <summary> Invoke callbacks </summary> </member> <member name="M:PSFramework.Commands.InvokePSFCallbackCommand.Terminate(PSFramework.FlowControl.CallbackException)"> <summary> Kill command with maximum prejudice </summary> <param name="error">The error to terminate with</param> </member> <member name="T:PSFramework.Commands.SortPSFObjectCommand"> <summary> Custom implementation of Sort-Object with PS7+ capabilities and custom property parsing </summary> </member> <member name="P:PSFramework.Commands.SortPSFObjectCommand.Stable"> <summary> Gets or sets a value indicating whether a stable sort is required. </summary> <value></value> <remarks> Items that are duplicates according to the sort algorithm will appear in the same relative order in a stable sort. </remarks> </member> <member name="P:PSFramework.Commands.SortPSFObjectCommand.Descending"> <summary> Gets or sets a value indicating whether the sort order is descending. </summary> </member> <member name="P:PSFramework.Commands.SortPSFObjectCommand.Unique"> <summary> Gets or sets a value indicating whether the sort filters out any duplicate objects. </summary> <value></value> </member> <member name="P:PSFramework.Commands.SortPSFObjectCommand.Top"> <summary> Gets or sets the number of items to return in a Top N sort. </summary> </member> <member name="P:PSFramework.Commands.SortPSFObjectCommand.Bottom"> <summary> Gets or sets the number of items to return in a Bottom N sort. </summary> </member> <member name="P:PSFramework.Commands.SortPSFObjectCommand.InputObject"> <summary> </summary> </member> <member name="P:PSFramework.Commands.SortPSFObjectCommand.Property"> <summary> Gets or Sets the Properties that would be used for Grouping, Sorting and Comparison. </summary> </member> <member name="P:PSFramework.Commands.SortPSFObjectCommand.Culture"> <summary> </summary> <value></value> </member> <member name="P:PSFramework.Commands.SortPSFObjectCommand.CaseSensitive"> <summary> </summary> <value></value> </member> <member name="F:PSFramework.Commands.SortPSFObjectCommand._NonclonedProperties"> <summary> List of properties to NOT clone into the hashtable used against Select-Object </summary> </member> <member name="F:PSFramework.Commands.SortPSFObjectCommand._PS7Properties"> <summary> List of properties that require at least PowerShell V7 </summary> </member> <member name="F:PSFramework.Commands.SortPSFObjectCommand._Pipeline"> <summary> The pipeline that is wrapped around Select-Object </summary> </member> <member name="F:PSFramework.Commands.SortPSFObjectCommand._VarName"> <summary> Name of the temporary variable created in the caller scope </summary> </member> <member name="M:PSFramework.Commands.SortPSFObjectCommand.BeginProcessing"> <summary> Execute begin step </summary> </member> <member name="M:PSFramework.Commands.SortPSFObjectCommand.ProcessRecord"> <summary> Execute process step </summary> </member> <member name="M:PSFramework.Commands.SortPSFObjectCommand.EndProcessing"> <summary> Execute end step </summary> </member> <member name="T:PSFramework.Commands.ConvertToPSFHashtableCommand"> <summary> Implements the ConvertTo-PSFHashtable command </summary> </member> <member name="F:PSFramework.Commands.ConvertToPSFHashtableCommand.Include"> <summary> The properties to include explicitly </summary> </member> <member name="F:PSFramework.Commands.ConvertToPSFHashtableCommand.Exclude"> <summary> Any properties to exclude explicitly </summary> </member> <member name="F:PSFramework.Commands.ConvertToPSFHashtableCommand.CaseSensitive"> <summary> Enables case sensitivity. </summary> </member> <member name="F:PSFramework.Commands.ConvertToPSFHashtableCommand.IncludeEmpty"> <summary> Enables adding empty keys for explicitly included keys that were not found on the input </summary> </member> <member name="F:PSFramework.Commands.ConvertToPSFHashtableCommand.Inherit"> <summary> Specifically designed for use in a command when passing through parameters with default values. Enabling this switch has the command inherit values from variables in the caller scope if their name has been specified in the Include parameter. </summary> </member> <member name="F:PSFramework.Commands.ConvertToPSFHashtableCommand.Remap"> <summary> Remap individual keys in the hashtable provided. Effectively renames entries in the hashtable. </summary> </member> <member name="F:PSFramework.Commands.ConvertToPSFHashtableCommand.InputObject"> <summary> The actual items to convert </summary> </member> <member name="F:PSFramework.Commands.ConvertToPSFHashtableCommand.ReferenceCommand"> <summary> Command to use as reference. Reads parameters from the command and use them as "Include" parameter. </summary> </member> <member name="M:PSFramework.Commands.ConvertToPSFHashtableCommand.BeginProcessing"> <summary> Initialize command, resolving the ReferenceCommand if specified </summary> </member> <member name="M:PSFramework.Commands.ConvertToPSFHashtableCommand.ProcessRecord"> <summary> Implements the basic processing logic to convert objects to hashtables </summary> </member> <member name="T:PSFramework.Commands.InvokePSFProtectedCommand"> <summary> A wrapper that will execute the specified scriptblock in a safe manner </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.ScriptBlock"> <summary> The scriptblock to execute. </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.Action"> <summary> Description of the action to perform </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.ActionString"> <summary> A string to use localized message for the prompt </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.ActionStringValues"> <summary> Values to format into the localized string </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.Target"> <summary> The target to perform the action against </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.EnableException"> <summary> Whether to trigger a terminating exception in case the scriptblock errors out. Will be picked up automatically if not specified. </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.PSCmdlet"> <summary> The cmdlet object to use for triggering terminating errors. Will be picked up automatically if not specified. </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.Continue"> <summary> Triggers the calling of 'continue' in case of error </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.ContinueLabel"> <summary> The label in which to continue </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.Tag"> <summary> Tags to add to the messages </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.RetryCount"> <summary> How many times shall an attempt be made to try again when execution fails? </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.RetryWait"> <summary> How long to wait inbetween retries? </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.RetryErrorType"> <summary> Only retry on errors of the following types </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.RetryCondition"> <summary> Only when this scriptblock returns $true will it try again. The scriptblock receives argument: The exception object. </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.ErrorEvent"> <summary> Code to execute if giving up in failure </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand.Level"> <summary> The message level at which to generate non-error messages written by this cmdlet </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand._Caller"> <summary> Information on the calling command, including name, module, file and line. </summary> </member> <member name="P:PSFramework.Commands.InvokePSFProtectedCommand._Message"> <summary> The message to print when prompting </summary> </member> <member name="P:PSFramework.Commands.InvokePSFProtectedCommand._ErrorMessage"> <summary> Error message to post when execution fails </summary> </member> <member name="F:PSFramework.Commands.InvokePSFProtectedCommand._ErrorScript"> <summary> script used to write horrible errors on screen </summary> </member> <member name="M:PSFramework.Commands.InvokePSFProtectedCommand.BeginProcessing"> <summary> Prepare runtime information, such as calling command or cmdlet object </summary> </member> <member name="M:PSFramework.Commands.InvokePSFProtectedCommand.ProcessRecord"> <summary> Perform the actual logic </summary> </member> <member name="T:PSFramework.Commands.PSFCmdlet"> <summary> Base class for all PSFramework Cmdlets, offering some shared tooling </summary> </member> <member name="F:PSFramework.Commands.PSFCmdlet.MessageScript"> <summary> Access a scriptblock that can be used to write a message </summary> </member> <member name="F:PSFramework.Commands.PSFCmdlet.LocalizedMessageScript"> <summary> Access a scriptblock that can be used to write a message </summary> </member> <member name="M:PSFramework.Commands.PSFCmdlet.Invoke(System.String)"> <summary> Invokes a string of text-based scriptcode </summary> <param name="ScriptCode">The script code to execute</param> <returns>Returns whatever it will return</returns> </member> <member name="M:PSFramework.Commands.PSFCmdlet.Invoke(System.Management.Automation.ScriptBlock,System.Boolean,System.Object,System.Object,System.Object,System.Object[])"> <summary> Do a rich invocation of the specified scriptblock </summary> <param name="ScriptBlock">The scriptblock to execute</param> <param name="UseLocalScope">Whether a new scope should be created for this</param> <param name="DollerUnder">The value to make available as $_</param> <param name="Input">The value to make available to $input</param> <param name="ScriptThis">The value to make available as $this</param> <param name="Args">The value to make available as $args</param> <returns>Whatever output this scriptblock generates</returns> </member> <member name="M:PSFramework.Commands.PSFCmdlet.Invoke(System.String,System.Boolean,System.Object,System.Object,System.Object,System.Object[])"> <summary> Do a rich invocation of the specified scriptblock </summary> <param name="ScriptCode">The scriptblock to execute</param> <param name="UseLocalScope">Whether a new scope should be created for this</param> <param name="DollerUnder">The value to make available as $_</param> <param name="Input">The value to make available to $input</param> <param name="ScriptThis">The value to make available as $this</param> <param name="Args">The value to make available as $args</param> <returns>Whatever output this scriptblock generates</returns> </member> <member name="M:PSFramework.Commands.PSFCmdlet.GetCaller(System.Int32)"> <summary> Returns the caller CallStackFrame item </summary> <param name="Level">How many levels to peek into the callstack</param> <returns>Returns the caller CallStackFrame item</returns> </member> <member name="M:PSFramework.Commands.PSFCmdlet.GetCallerInfo(System.Int32)"> <summary> Returns the caller information the specified levels upstack </summary> <param name="Level">How many levels to peek into the callstack</param> <returns>The caller information of the specified level</returns> </member> <member name="M:PSFramework.Commands.PSFCmdlet.TestFeature(System.String)"> <summary> Checks whether a certain feature flag applies or not to the current execution. </summary> <param name="Name">The name of the feature to check.</param> <returns>Whether the flag is enabled</returns> </member> <member name="M:PSFramework.Commands.PSFCmdlet.WriteMessage(System.String,PSFramework.Message.MessageLevel,System.String,System.String,System.String,System.Int32,System.String[],System.Object,System.Collections.Hashtable)"> <summary> Write a message using the PSFramework. Executed as scriptblock, so the current runspace must not be occupied elseways </summary> <param name="Message">The message to write</param> <param name="Level">The level to write it at</param> <param name="FunctionName">The name of the function / cmdlet to assume</param> <param name="ModuleName">The name of the module to assume</param> <param name="File">The file this message was written from</param> <param name="Line">The line in the file this message was written from</param> <param name="Tag">Tags to attach to this message</param> <param name="Target">A target object to specify</param> <param name="Data">Add additional metadata to the message written</param> </member> <member name="M:PSFramework.Commands.PSFCmdlet.WriteLocalizedMessage(System.String,System.Object[],PSFramework.Message.MessageLevel,System.String,System.String,System.String,System.Int32,System.String[],System.Object,System.Collections.Hashtable)"> <summary> Write a message using the PSFramework. Executed as scriptblock, so the current runspace must not be occupied elseways </summary> <param name="String">The localized string to write</param> <param name="StringValues">The values to format into the localized string</param> <param name="Level">The level to write it at</param> <param name="FunctionName">The name of the function / cmdlet to assume</param> <param name="ModuleName">The name of the module to assume</param> <param name="File">The file this message was written from</param> <param name="Line">The line in the file this message was written from</param> <param name="Tag">Tags to attach to this message</param> <param name="Target">A target object to specify</param> <param name="Data">Add additional metadata to the message written</param> </member> <member name="M:PSFramework.Commands.PSFCmdlet.StopCommand(System.String,System.Exception,System.Object,System.String,System.String,System.String,System.Int32,System.String[],System.Boolean)"> <summary> Stops the current command. Sets the stopping flag for non-terminal interruption. </summary> <param name="Message">The message to write as an error</param> <param name="Error">An exception object to include in the message system</param> <param name="Target">A target object to specify</param> <param name="FunctionName">The name of the function / cmdlet to assume</param> <param name="ModuleName">The name of the module to assume</param> <param name="File">The file this message was written from</param> <param name="Line">The line in the file this message was written from</param> <param name="Tag">Tags to attach to this message</param> <param name="EnableException">Whether the command should terminate in fire and death and terminating exceptions</param> </member> <member name="M:PSFramework.Commands.PSFCmdlet.StopLocalizedCommand(System.String,System.Object[],System.Exception,System.Object,System.String,System.String,System.String,System.Int32,System.String[],System.Boolean)"> <summary> Stops the current command. Sets the stopping flag for non-terminal interruption. </summary> <param name="String">The localized string to write</param> <param name="StringValues">The values to format into the localized string</param> <param name="Error">An exception object to include in the message system</param> <param name="Target">A target object to specify</param> <param name="FunctionName">The name of the function / cmdlet to assume</param> <param name="ModuleName">The name of the module to assume</param> <param name="File">The file this message was written from</param> <param name="Line">The line in the file this message was written from</param> <param name="Tag">Tags to attach to this message</param> <param name="EnableException">Whether the command should terminate in fire and death and terminating exceptions</param> </member> <member name="F:PSFramework.Commands.PSFCmdlet.IsStopping"> <summary> Whether the command has been set to terminate by StopCommand. Use when supporting EnableException </summary> </member> <member name="M:PSFramework.Commands.PSFCmdlet.InvokeCallback(System.Object,System.Boolean)"> <summary> Invokes all applicable callback scripts. </summary> <param name="Data">Data to send to the callback scriptblocks</param> <param name="EnableException">Whether a failed callback scriptblock fails this command in fire and terminating exception.</param> </member> <member name="T:PSFramework.Commands.RemovePSFNullCommand"> <summary> Implements the Remove-PSFNull command </summary> </member> <member name="F:PSFramework.Commands.RemovePSFNullCommand.InputObject"> <summary> The objects to process </summary> </member> <member name="F:PSFramework.Commands.RemovePSFNullCommand.AllowEmptyCollections"> <summary> Whether empty collections should be passed along </summary> </member> <member name="F:PSFramework.Commands.RemovePSFNullCommand.AllowEmptyStrings"> <summary> Whether empty strings should be legal </summary> </member> <member name="F:PSFramework.Commands.RemovePSFNullCommand.Enumerate"> <summary> Whether the output should be enumerated </summary> </member> <member name="M:PSFramework.Commands.RemovePSFNullCommand.ProcessRecord"> <summary> Process items as they are passed to the cmdlet </summary> </member> <member name="T:PSFramework.Commands.SelectPSFObjectCommand"> <summary> Implements the Select-PSFObject command </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.InputObject"> <summary> The actual input object that is being processed </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.Property"> <summary> The properties to select. Supports fancy DSL </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.ExcludeProperty"> <summary> Properties to skip </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.ExpandProperty"> <summary> A property to expand. </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.Alias"> <summary> Allow users to specify an alias property as part of the select </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.ScriptProperty"> <summary> Specify script properties at runtime as part of the select </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.ScriptMethod"> <summary> Specify script methods at runtime as part of the select </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.Unique"> <summary> Whether to exclude duplicates </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.Last"> <summary> The last number of items to pick </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.First"> <summary> Pick the first n items. </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.Skip"> <summary> Skip n items before picking items </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.SkipLast"> <summary> Skip the last n items </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.Wait"> <summary> </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.Index"> <summary> </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.ShowProperty"> <summary> THe properties to display by default </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.ShowExcludeProperty"> <summary> The properties to NOT display by default </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.TypeName"> <summary> The typename to assign to the psobject </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand.KeepInputObject"> <summary> Keep the original input object, just add to it. </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand._NonclonedProperties"> <summary> List of properties to NOT clone into the hashtable used against Select-Object </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand._NoAdjustment"> <summary> Whether some adjustments to the object need to be done or whether the Select-Object output can be simply passed through. </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand._DisplayPropertySet"> <summary> The set controlling what properties will be shown by default </summary> </member> <member name="F:PSFramework.Commands.SelectPSFObjectCommand._Pipeline"> <summary> THe pipeline that is wrapped around Select-Object </summary> </member> <member name="M:PSFramework.Commands.SelectPSFObjectCommand.BeginProcessing"> <summary> Implements the begin action of the command </summary> </member> <member name="M:PSFramework.Commands.SelectPSFObjectCommand.ProcessRecord"> <summary> Implements the process action of the command </summary> </member> <member name="M:PSFramework.Commands.SelectPSFObjectCommand.EndProcessing"> <summary> Implements the end action of the command </summary> </member> <member name="T:PSFramework.Commands.SetPSFConfigCommand"> <summary> Implements the Set-PSFConfig command </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.FullName"> <summary> The full name of the setting </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.Module"> <summary> The name of the module the setting belongs to. Is optional due to just specifying a name is legal, in which case the first name segment becomes the module name. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.Name"> <summary> The name of the setting within a module. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.Value"> <summary> The value to apply. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.PersistedValue"> <summary> The persisted value to apply. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.PersistedType"> <summary> The persisted type to apply. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.Description"> <summary> Add documentation to the setting. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.Validation"> <summary> The validation script to use. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.Handler"> <summary> The handling script to apply when changing the value. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.Hidden"> <summary> Whether the setting should be hidden from casual discovery. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.Default"> <summary> Whether the setting should be applied only when nothing exists yet. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.Initialize"> <summary> Whether this is the configuration initialization call. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.SimpleExport"> <summary> Enabling this will cause the module to use friendly json notation on export to file. This may result in loss of data precision, but is more userfriendly. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.ModuleExport"> <summary> Whether this setting applies to module scope file export. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.AllowDelete"> <summary> Allow the setting to be deleted from memory. Has no effect after initialization. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.DisableValidation"> <summary> Do not apply the validation script when changing values. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.DisableHandler"> <summary> Do not run the handler script when changing values. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.PassThru"> <summary> Return the changed configuration setting. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand.EnableException"> <summary> Enable throwing exceptions. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand._Config"> <summary> The configuration item changed </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand._Initialize"> <summary> Whether this is an initialization execution. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand._Persisted"> <summary> Whether persisted values need to be restored. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand._Exists"> <summary> Whether the setting already exists. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand._PolicyEnforced"> <summary> The setting to be affected was enforced by policy and cannot be changed by the user. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand._NameModule"> <summary> Processed name of module. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand._NameName"> <summary> Processed name of setting within module. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand._NameFull"> <summary> Processed full name of setting. </summary> </member> <member name="F:PSFramework.Commands.SetPSFConfigCommand._ValidationErrorMessage"> <summary> The reason validation failed. Filled by ApplyValue. </summary> </member> <member name="M:PSFramework.Commands.SetPSFConfigCommand.ProcessRecord"> <summary> Implements the process action of Set-PSFConfig </summary> </member> <member name="M:PSFramework.Commands.SetPSFConfigCommand.ApplyValue(System.Object)"> <summary> Applies a value to a configuration item, invoking validation and handler scriptblocks. </summary> <param name="Value">The value to apply</param> </member> <member name="M:PSFramework.Commands.SetPSFConfigCommand.ApplyCommonSettings"> <summary> Abstracts out the regular settings that keep getting applied </summary> </member> <member name="T:PSFramework.Commands.TestPSFShouldProcessCommand"> <summary> Implements the Test-PSFShouldProcess command </summary> </member> <member name="F:PSFramework.Commands.TestPSFShouldProcessCommand.Target"> <summary> The target object to process </summary> </member> <member name="F:PSFramework.Commands.TestPSFShouldProcessCommand.Action"> <summary> Description of the action to perform </summary> </member> <member name="F:PSFramework.Commands.TestPSFShouldProcessCommand.ActionString"> <summary> A string to use localized message for the prompt </summary> </member> <member name="F:PSFramework.Commands.TestPSFShouldProcessCommand.ActionStringValues"> <summary> Values to format into the localized string </summary> </member> <member name="F:PSFramework.Commands.TestPSFShouldProcessCommand.PSCmdlet"> <summary> The PSCmdlet object of the calling command </summary> </member> <member name="F:PSFramework.Commands.TestPSFShouldProcessCommand._PSCmdlet"> <summary> Private copy of the specified or found cmdlet object </summary> </member> <member name="P:PSFramework.Commands.TestPSFShouldProcessCommand._Action"> <summary> THe resolved action string to display </summary> </member> <member name="M:PSFramework.Commands.TestPSFShouldProcessCommand.BeginProcessing"> <summary> Clarifies Cmdlet object during begin </summary> </member> <member name="M:PSFramework.Commands.TestPSFShouldProcessCommand.ProcessRecord"> <summary> Perform the query </summary> </member> <member name="T:PSFramework.Commands.WritePSFMessageCommand"> <summary> Cmdlet performing message handling and logging </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.Level"> <summary> This parameter represents the verbosity of the message. The lower the number, the more important it is for a human user to read the message. By default, the levels are distributed like this: - 1-3 Direct verbose output to the user (using Write-Host) - 4-6 Output only visible when requesting extra verbosity (using Write-Verbose) - 1-9 Debugging information, written using Write-Debug In addition, it is possible to select the level "Warning" which moves the message out of the configurable range: The user will always be shown this message, unless he silences the entire verbosity. Possible levels: Critical (1), Important / Output / Host (2), Significant (3), VeryVerbose (4), Verbose (5), SomewhatVerbose (6), System (7), Debug (8), InternalComment (9), Warning (666) Either one of the strings or its respective number will do as input. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.Message"> <summary> The message to write/log. The function name and timestamp will automatically be prepended. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.String"> <summary> A stored string to use to write the log. Used in combination with the localization component. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.StringValues"> <summary> Values to format into the localized string referred to in String. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.Tag"> <summary> Tags to add to the message written. This allows filtering and grouping by category of message, targeting specific messages. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.Data"> <summary> Specify additional data points that are furnished to the logging providers. Data provided is arbitrary and not touched by the logging system itself. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.FunctionName"> <summary> The name of the calling function. Will be automatically set, but can be overridden when necessary. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.ModuleName"> <summary> The name of the module, the calling function is part of. Will be automatically set, but can be overridden when necessary. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.File"> <summary> The file in which Write-PSFMessage was called. Will be automatically set, but can be overridden when necessary. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.Line"> <summary> The line on which Write-PSFMessage was called. Will be automatically set, but can be overridden when necessary. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.ErrorRecord"> <summary> If an error record should be noted with the message, add the full record here. Especially designed for use with Warning-mode, it can legally be used in either mode. The error will be added to the $Error variable and enqued in the logging/debugging system. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.Exception"> <summary> Allows specifying an inner exception as input object. This will be passed on to the logging and used for messages. When specifying both ErrorRecord AND Exception, Exception wins, but ErrorRecord is still used for record metadata. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.Once"> <summary> Setting this parameter will cause this function to write the message only once per session. The string passed here and the calling function's name are used to create a unique ID, which is then used to register the action in the configuration system. Thus will the lockout only be written if called once and not burden the system unduly. This lockout will be written as a hidden value, to see it use Get-PSFConfig -Force. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.OverrideExceptionMessage"> <summary> Disables automatic appending of exception messages. Use in cases where you already have a speaking message interpretation and do not need the original message. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.Target"> <summary> Add the object the message is all about, in order to simplify debugging / troubleshooting. For example, when calling this from a function targeting a remote computer, the computername could be specified here, allowing all messages to easily be correlated to the object processed. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.NoNewLine"> <summary> Skip adding a new line after writing the message to screen. It is still logged as a single message though. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.EnableException"> <summary> This parameters disables user-friendly warnings and enables the throwing of exceptions. This is less user friendly, but allows catching exceptions in calling scripts. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.Breakpoint"> <summary> Enables breakpoints on the current message. By default, setting '-Debug' will NOT cause an interrupt on the current position. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.PSCmdlet"> <summary> The cmdlet object to use for writing errors. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._timestamp"> <summary> The start time of the cmdlet </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._silent"> <summary> Whether this cmdlet is run in silent mode </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._fromStopFunction"> <summary> Whether this cmdlet was called by Stop-PSFFunction </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._callStack"> <summary> The current callstack </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._stackDepth"> <summary> How many items exist on the callstack </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._message"> <summary> The message to write </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._messageSimple"> <summary> The message simplified without timestamps. Used for logging. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._messageColor"> <summary> The message to write in color </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._messageDeveloper"> <summary> Non-colored version of developermode </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._messageDeveloperColor"> <summary> Colored version of developermode </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._writeHostScript"> <summary> Scriptblock that writes the host messages </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._Tags"> <summary> List of tags to process </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._isDebug"> <summary> Whether debug mode is enabled </summary> </member> <member name="P:PSFramework.Commands.WritePSFMessageCommand._errorQualifiedMessage"> <summary> The input message with the error content included if desired </summary> </member> <member name="P:PSFramework.Commands.WritePSFMessageCommand._ResolvedMessage"> <summary> Unified representation of the various ways messages can be specified </summary> </member> <member name="P:PSFramework.Commands.WritePSFMessageCommand._MessageSystem"> <summary> The final message to use for internal logging </summary> </member> <member name="P:PSFramework.Commands.WritePSFMessageCommand._MessageStreams"> <summary> The final message to use for writing to streams, such as verbose or warning </summary> </member> <member name="P:PSFramework.Commands.WritePSFMessageCommand._MessageHost"> <summary> The final message to use for host messages (write using Write-PSFHostColor) </summary> </member> <member name="P:PSFramework.Commands.WritePSFMessageCommand._BreadCrumbsString"> <summary> Provide breadcrumb queue of the callstack </summary> </member> <member name="P:PSFramework.Commands.WritePSFMessageCommand._BreadCrumbsStringColored"> <summary> Provide a breadcrumb queue of the callstack in color tags </summary> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.BeginProcessing"> <summary> Processes the begin phase of the cmdlet </summary> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.ProcessRecord"> <summary> Processes the process phase of the cmdlet </summary> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.ResolveTarget(System.Object)"> <summary> Processes the target transform rules on an input object </summary> <param name="Item">The item to transform</param> <returns>The transformed object</returns> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.ResolveException(System.Exception)"> <summary> Processes the specified exception specified </summary> <param name="Item">The exception to process</param> <returns>The transformed exception</returns> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.ResolveLevel(PSFramework.Message.MessageLevel)"> <summary> Processs the input level and apply policy and rules </summary> <param name="Level">The original level of the message</param> <returns>The processed level</returns> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.GetMessage"> <summary> Builds the message item for display of Verbose, Warning and Debug streams </summary> <returns>The message to return</returns> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.GetMessageSimple"> <summary> Builds the base message for internal system use. </summary> <returns>The message to return</returns> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.GetMessageColor"> <summary> Builds the message item if needed and returns it </summary> <returns>The message to return</returns> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.GetMessageDeveloper"> <summary> Non-host output in developermode </summary> <returns>The string to write on messages that don't go straight to Write-PSFHostColor</returns> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.GetMessageDeveloperColor"> <summary> Host output in developermode </summary> <returns>The string to write on messages that go straight to Write-PSFHostColor</returns> </member> <member name="T:PSFramework.Filter.Condition"> <summary> An individual filter condition. Building block of a PSFramework filter expression. </summary> </member> <member name="P:PSFramework.Filter.Condition.Name"> <summary> Name of the condition. The String used within the expression. </summary> </member> <member name="F:PSFramework.Filter.Condition.Module"> <summary> Name of the module owning the condition. </summary> </member> <member name="F:PSFramework.Filter.Condition.Version"> <summary> Version of the condition. Multiple versions can coexist. </summary> </member> <member name="F:PSFramework.Filter.Condition.ScriptBlock"> <summary> The actual script-code that is run when evaluating this condition </summary> </member> <member name="F:PSFramework.Filter.Condition.Type"> <summary> What kind of condition is this? Static conditions are evaluated once only and are generally used for environment-conditions that are unlikely to change at runtime (e.g.: Operating System, PowerShell Version, runtime environment). Dynamic conditions are evaluated each time they are invoked. </summary> </member> <member name="M:PSFramework.Filter.Condition.#ctor(System.String,System.String,PSFramework.Utility.PsfScriptBlock,System.Version,PSFramework.Filter.ConditionType)"> <summary> Create a new condition. </summary> <param name="Name">Name of the condition</param> <param name="Module">Name of the module owning the condition</param> <param name="ScriptBlock">The scriptblock that evaluates the condition</param> <param name="Version">The version of the condition</param> <param name="Type">The type of the condition</param> </member> <member name="M:PSFramework.Filter.Condition.Invoke(System.Object)"> <summary> Evaluate the condition. This will run the stored scriptblock unless it is a static condition and has previously been invoked. </summary> <param name="Argument">An argument to pass to the scriptblock, available inside as $_</param> <returns>Whether the condition is met or not.</returns> </member> <member name="M:PSFramework.Filter.Condition.ToString"> <summary> Simple string representation of the condition </summary> <returns>The name of the condition</returns> </member> <member name="T:PSFramework.Filter.ConditionSet"> <summary> A set of conditions that can be applied to expressions. A filter expression can only contain conditions defined in the ConditionSet assigned. </summary> </member> <member name="P:PSFramework.Filter.ConditionSet.Name"> <summary> Name of the condition set </summary> </member> <member name="F:PSFramework.Filter.ConditionSet.Module"> <summary> The module defining the condition set </summary> </member> <member name="F:PSFramework.Filter.ConditionSet.Version"> <summary> Version of the condition set. </summary> </member> <member name="P:PSFramework.Filter.ConditionSet.Conditions"> <summary> Returns the list of conditions included in the set. Mostly for display purposes. </summary> </member> <member name="F:PSFramework.Filter.ConditionSet.ConditionTable"> <summary> The conditions contained within the condition set </summary> </member> <member name="M:PSFramework.Filter.ConditionSet.#ctor(System.String,System.String,System.Version,System.Collections.Generic.List{PSFramework.Filter.Condition})"> <summary> Create a new condition set </summary> <param name="Name">Name of the set</param> <param name="Module">Module under which the condition set is defined</param> <param name="Version">Version of the set</param> <param name="Conditions">Conditions to include in the set.</param> </member> <member name="M:PSFramework.Filter.ConditionSet.ToString"> <summary> Default string representation. </summary> <returns>The name of the condition set</returns> </member> <member name="M:PSFramework.Filter.ConditionSet.Add(PSFramework.Filter.Condition)"> <summary> Add a condition object to the condition set. </summary> <param name="Condition">The condition object to add</param> </member> <member name="T:PSFramework.Filter.ConditionType"> <summary> What kind of condition is it? </summary> </member> <member name="F:PSFramework.Filter.ConditionType.Static"> <summary> The condition is static - its value needs only be processed once. </summary> </member> <member name="F:PSFramework.Filter.ConditionType.Dynamic"> <summary> The condition is dynamic - its value may change and should be evaluated each time. May accept arguments. </summary> </member> <member name="T:PSFramework.Filter.Expression"> <summary> Stores a filter expression and executes it as needed. </summary> </member> <member name="P:PSFramework.Filter.Expression.ExpressionString"> <summary> The filter expression string </summary> </member> <member name="F:PSFramework.Filter.Expression.ConditionSet"> <summary> The ConditionSet under which this expression will be executed. </summary> </member> <member name="P:PSFramework.Filter.Expression.Conditions"> <summary> Name of the conditions that make up this expression </summary> </member> <member name="M:PSFramework.Filter.Expression.#ctor(System.String,PSFramework.Filter.ConditionSet)"> <summary> Create a new expression object based off a filter expression. </summary> <param name="Expression">The filter expression that will be evaluated</param> <param name="ConditionSet">The condition set under which the expression will be evaluated. Every condition used in the expression must be part of this set.</param> </member> <member name="M:PSFramework.Filter.Expression.Evaluate(System.Object,PSFramework.Filter.ConditionSet)"> <summary> Evaluates the filter expression. </summary> <param name="Argument">Optional argument, in case the conditions are designed to evaluate a specific object</param> <param name="ConditionSet">Optional argument, in case the ConditionSet was not specified at creation time.</param> <returns>Whether the expression is true or not</returns> </member> <member name="M:PSFramework.Filter.Expression.Clone"> <summary> Clones the existing expression </summary> <returns>A clone of the current expression object</returns> </member> <member name="T:PSFramework.Filter.FilterContainer"> <summary> A container object designed to hold all the stored conditions and condition sets included in a runspace. </summary> </member> <member name="P:PSFramework.Filter.FilterContainer.Filters"> <summary> Returns the filter data for the current runspace. </summary> </member> <member name="M:PSFramework.Filter.FilterContainer.FindCondition(System.String,System.String,System.Version,System.Boolean)"> <summary> Retrieve registered conditions based on the information provided </summary> <param name="Module">The modulename to filter by.</param> <param name="Name">The condition name to filter by.</param> <param name="Version">The version number to select.</param> <param name="AllVersions">Return all versions of a given condition</param> <returns>All conditions matching the search criteria.</returns> </member> <member name="M:PSFramework.Filter.FilterContainer.GetCondition(System.String,System.String,System.Version,System.Boolean)"> <summary> Retrieve registered conditions based on the information provided </summary> <param name="Module">The modulename to filter by.</param> <param name="Name">The condition name to filter by.</param> <param name="Version">The version number to select.</param> <param name="AllVersions">Return all versions of a given condition</param> <returns>All conditions matching the search criteria.</returns> </member> <member name="M:PSFramework.Filter.FilterContainer.FindConditionSet(System.String,System.String,System.Version,System.Boolean)"> <summary> Retrieve registered condition sets based on the information provided </summary> <param name="Module">The modulename to filter by.</param> <param name="Name">The conditionset name to filter by.</param> <param name="Version">The version number to select.</param> <param name="AllVersions">Return all versions of a given conditionset</param> <returns>All condition sets matching the search criteria.</returns> </member> <member name="M:PSFramework.Filter.FilterContainer.GetConditionSet(System.String,System.String,System.Version,System.Boolean)"> <summary> Retrieve registered condition sets based on the information provided </summary> <param name="Module">The modulename to select.</param> <param name="Name">The condition name to select.</param> <param name="Version">The version number to select.</param> <param name="AllVersions">Return all versions of a given condition</param> <returns>All conditions matching the search criteria.</returns> </member> <member name="M:PSFramework.Filter.FilterContainer.AddCondition(System.String,System.String,PSFramework.Utility.PsfScriptBlock,System.Version,PSFramework.Filter.ConditionType)"> <summary> Create a new condition. </summary> <param name="Name">Name of the condition</param> <param name="Module">Name of the module owning the condition</param> <param name="ScriptBlock">The scriptblock that evaluates the condition</param> <param name="Version">The version of the condition</param> <param name="Type">The type of the condition</param> <returns>The newly created condition</returns> </member> <member name="M:PSFramework.Filter.FilterContainer.AddConditionSet(System.String,System.String,System.Version,System.Collections.Generic.List{PSFramework.Filter.Condition})"> <summary> Create a new condition set </summary> <param name="Name">Name of the set</param> <param name="Module">Module under which the condition set is defined</param> <param name="Version">Version of the set</param> <param name="Conditions">Conditions to include in the set.</param> <returns>The newly created condition set</returns> </member> <member name="M:PSFramework.Filter.FilterContainer.AddConditionSet(System.String,System.String,System.Version,PSFramework.Filter.Condition[])"> <summary> Create a new condition set </summary> <param name="Name">Name of the set</param> <param name="Module">Module under which the condition set is defined</param> <param name="Version">Version of the set</param> <param name="Conditions">Conditions to include in the set.</param> <returns>The newly created condition set</returns> </member> <member name="M:PSFramework.Filter.FilterContainer.Add(PSFramework.Filter.Condition)"> <summary> Add a predefined condition object to the container </summary> <param name="Condition">The condition object to add</param> </member> <member name="M:PSFramework.Filter.FilterContainer.Add(PSFramework.Filter.ConditionSet)"> <summary> Add a predefined condition set object to the container </summary> <param name="ConditionSet">The condition set object to add</param> </member> <member name="T:PSFramework.FlowControl.CallbackException"> <summary> A custom exception, including the callback that failed </summary> </member> <member name="F:PSFramework.FlowControl.CallbackException.Callback"> <summary> The callback that failed </summary> </member> <member name="M:PSFramework.FlowControl.CallbackException.#ctor(PSFramework.FlowControl.Callback,System.Exception)"> <summary> Creates a new callback exception, including the Callback that failed </summary> <param name="Callback">The callback that failed</param> <param name="InnerException">The exception it failed with</param> </member> <member name="T:PSFramework.FlowControl.Callback"> <summary> Data structure representing a registered callback scriptblock </summary> </member> <member name="F:PSFramework.FlowControl.Callback.Name"> <summary> The name of the callback script. Used to build the unique ID to prevent accidental duplication </summary> </member> <member name="F:PSFramework.FlowControl.Callback.ModuleName"> <summary> Name of the module the callback applies to. Only when invoked from within this module will it trigger </summary> </member> <member name="F:PSFramework.FlowControl.Callback.CommandName"> <summary> Name of the command the callback applies to. Only when invoked from a command with a similar name will it trigger </summary> </member> <member name="F:PSFramework.FlowControl.Callback.Runspace"> <summary> The runspace the callback belongs to. If this is set, only when invoked from that runspace will it trigger. </summary> </member> <member name="F:PSFramework.FlowControl.Callback.BreakAffinity"> <summary> Whether the scriptblock's runspace affinity should be broken. Setting this to true will execute the scriptblock in the runspace that triggered it, rather than the one that defined it. </summary> </member> <member name="F:PSFramework.FlowControl.Callback.ScriptBlock"> <summary> The actual callback scriptcode </summary> </member> <member name="P:PSFramework.FlowControl.Callback.Identity"> <summary> The full identity of the callback. Used for internal callback management. </summary> </member> <member name="M:PSFramework.FlowControl.Callback.Applies(System.String,System.String)"> <summary> Whether the callback applies to the current command. </summary> <param name="ModuleName">Module the current command is part of</param> <param name="CommandName">Command that is currently executing</param> <returns>True if it applies, otherwise False</returns> </member> <member name="M:PSFramework.FlowControl.Callback.Invoke(PSFramework.Meta.CallerInfo,System.Management.Automation.PSCmdlet,System.Object)"> <summary> Invokes the callback scriptblock as configured. </summary> <param name="Caller">The object containing the information pertaining to the calling command.</param> <param name="Invoker">The meta object representing the invoking command.</param> <param name="Data">Extra data that was passed to the event</param> </member> <member name="M:PSFramework.FlowControl.Callback.ToString"> <summary> Returns the string representation of the callback </summary> <returns>The string representation of the callback</returns> </member> <member name="T:PSFramework.FlowControl.CallbackHost"> <summary> Host class providing statics needed to operate the callback feature. </summary> </member> <member name="F:PSFramework.FlowControl.CallbackHost.Callbacks"> <summary> Grand dictionary of callbacks </summary> </member> <member name="M:PSFramework.FlowControl.CallbackHost.Add(PSFramework.FlowControl.Callback)"> <summary> Adds a callback item to the list of registered callbacks </summary> <param name="Callback">The callback to add</param> </member> <member name="M:PSFramework.FlowControl.CallbackHost.Get(System.String,System.Boolean)"> <summary> Returns a list of callbacks </summary> <param name="Name">The name to filter by</param> <param name="All">Whether also callbacks from other runspaces should be included</param> <returns>The list of matching callbacks</returns> </member> <member name="M:PSFramework.FlowControl.CallbackHost.Remove(PSFramework.FlowControl.Callback)"> <summary> Removes a given callback from the list of registered callbacks </summary> <param name="Callback">The callback object to remove</param> </member> <member name="M:PSFramework.FlowControl.CallbackHost.RemoveRunspaceOwned"> <summary> Removes all callbacks specific to the current runspace. Use this during the shutdown sequence of a runspace. </summary> </member> <member name="M:PSFramework.FlowControl.CallbackHost.Invoke(PSFramework.Meta.CallerInfo,System.Management.Automation.PSCmdlet,System.Object)"> <summary> Invokes the callback scriptblocks that apply to the current scenario </summary> <param name="Caller">The object containing the information pertaining to the command calling the command invoking the callback.</param> <param name="Invoker">The meta object representing the invoking command.</param> <param name="Data">Extra data that was passed to the event</param> </member> <member name="T:PSFramework.FlowControl.OperatingSystem"> <summary> The various operating systems PowerShell can run on </summary> </member> <member name="F:PSFramework.FlowControl.OperatingSystem.Windows"> <summary> Common windows OS </summary> </member> <member name="F:PSFramework.FlowControl.OperatingSystem.Linux"> <summary> Any Linux distribution </summary> </member> <member name="F:PSFramework.FlowControl.OperatingSystem.MacOS"> <summary> Any Mac Operating System </summary> </member> <member name="T:PSFramework.FlowControl.PSEdition"> <summary> The powershell edition </summary> </member> <member name="F:PSFramework.FlowControl.PSEdition.Desktop"> <summary> The desktop edition of PowerShell - all editions 5.1 or below </summary> </member> <member name="F:PSFramework.FlowControl.PSEdition.Core"> <summary> .NET core based editions of PowerShell </summary> </member> <member name="T:PSFramework.ComputerManagement.ComputerManagementHost"> <summary> Host class containing static iresources for the computer management component </summary> </member> <member name="F:PSFramework.ComputerManagement.ComputerManagementHost.PSSessionIdleTimeout"> <summary> The timespan a PSSession may be idle before it is cleared for cleanup </summary> </member> <member name="F:PSFramework.ComputerManagement.ComputerManagementHost.KnownSessionTypes"> <summary> List of known session types that can be used in a SessionContainer. </summary> </member> <member name="T:PSFramework.ComputerManagement.PSSessionContainer"> <summary> A class designed to contain PSSessionInfo objects </summary> </member> <member name="M:PSFramework.ComputerManagement.PSSessionContainer.#ctor"> <summary> Creeates a session container dictionary, that is not opinionated about casing. </summary> </member> <member name="M:PSFramework.ComputerManagement.PSSessionContainer.GetExpired"> <summary> Returns a list of all expired sessions </summary> <returns>The list of expired sessions</returns> </member> <member name="M:PSFramework.ComputerManagement.PSSessionContainer.GetBroken"> <summary> Returns a list of all sessions that have broken (generally by having hit the hard wsman limits or the remote computer being down) </summary> <returns>The list of broken sessions.</returns> </member> <member name="T:PSFramework.ComputerManagement.PSSessionInfo"> <summary> Runtime information object on a PSSession connection. Used to implement session caching and disconnection. </summary> </member> <member name="F:PSFramework.ComputerManagement.PSSessionInfo.Session"> <summary> The session object to inform upon </summary> </member> <member name="F:PSFramework.ComputerManagement.PSSessionInfo.LastUsed"> <summary> The time this session object was last used </summary> </member> <member name="P:PSFramework.ComputerManagement.PSSessionInfo.IsExpired"> <summary> Shows whether the session has expired </summary> </member> <member name="P:PSFramework.ComputerManagement.PSSessionInfo.ComputerName"> <summary> Name of the remote session </summary> </member> <member name="P:PSFramework.ComputerManagement.PSSessionInfo.Availability"> <summary> The current state of the session </summary> </member> <member name="M:PSFramework.ComputerManagement.PSSessionInfo.ResetTimestamp"> <summary> Resets the LastUsed timestamp, ensuring this session is not discarded prematurely. </summary> </member> <member name="M:PSFramework.ComputerManagement.PSSessionInfo.#ctor(System.Management.Automation.Runspaces.PSSession)"> <summary> Creates a session info object from a session object. </summary> <param name="Session">The session to wrap inside an info object</param> </member> <member name="T:PSFramework.ComputerManagement.SessionContainer"> <summary> Container for multiple session objects, to pass through to internal commands </summary> </member> <member name="F:PSFramework.ComputerManagement.SessionContainer.ComputerName"> <summary> Name of the computer </summary> </member> <member name="F:PSFramework.ComputerManagement.SessionContainer.Connections"> <summary> The connections payload. One connection per connection type. </summary> </member> <member name="M:PSFramework.ComputerManagement.SessionContainer.op_Implicit(PSFramework.ComputerManagement.SessionContainer)~System.Management.Automation.Runspaces.PSSession"> <summary> Converts the session container to PSSession, if one is included </summary> <param name="Container">The container from which to gather the PSSession</param> </member> <member name="M:PSFramework.ComputerManagement.SessionContainer.op_Implicit(PSFramework.ComputerManagement.SessionContainer)~Microsoft.Management.Infrastructure.CimSession"> <summary> Converts the session container to CImSession, if one is included </summary> <param name="Container">The container from which to gather the CimSession</param> </member> <member name="M:PSFramework.ComputerManagement.SessionContainer.ToString"> <summary> The default string representation </summary> <returns></returns> </member> <member name="T:PSFramework.Configuration.Config"> <summary> Configuration Manager as well as individual configuration object. </summary> </member> <member name="F:PSFramework.Configuration.Config.Name"> <summary> The Name of the setting </summary> </member> <member name="P:PSFramework.Configuration.Config.FullName"> <summary> The full name of the configuration entry, comprised of both Module and Name. </summary> </member> <member name="F:PSFramework.Configuration.Config.Module"> <summary> The module of the setting. Helps being able to group configurations. </summary> </member> <member name="F:PSFramework.Configuration.Config.Description"> <summary> A description of the specific setting </summary> </member> <member name="P:PSFramework.Configuration.Config.Type"> <summary> The data type of the value stored in the configuration element. </summary> </member> <member name="P:PSFramework.Configuration.Config.Value"> <summary> The value stored in the configuration element </summary> </member> <member name="P:PSFramework.Configuration.Config.SafeValue"> <summary> The value stored in the configuration element, but without deserializing objects. </summary> </member> <member name="P:PSFramework.Configuration.Config.Unchanged"> <summary> Whether the value of the configuration setting has been changed since its initialization. </summary> </member> <member name="F:PSFramework.Configuration.Config.Handler"> <summary> The handler script that is run whenever the configuration value is set. </summary> </member> <member name="F:PSFramework.Configuration.Config.Validation"> <summary> Validates the user input </summary> </member> <member name="F:PSFramework.Configuration.Config.Hidden"> <summary> Setting this to true will cause the element to not be discovered unless using the '-Force' parameter on "Get-DbaConfig" </summary> </member> <member name="P:PSFramework.Configuration.Config.AllowDelete"> <summary> Whether the setting can be legally deleted. </summary> </member> <member name="P:PSFramework.Configuration.Config.Initialized"> <summary> Whether the setting has been initialized. This handles module imports and avoids modules overwriting settings when imported in multiple runspaces. </summary> </member> <member name="F:PSFramework.Configuration.Config.PolicySet"> <summary> Whether this setting was set by policy </summary> </member> <member name="P:PSFramework.Configuration.Config.PolicyEnforced"> <summary> Whether this setting was set by policy and forbids changes to the configuration. </summary> </member> <member name="F:PSFramework.Configuration.Config.SimpleExport"> <summary> Enabling this causes export to json to use simple json serialization for data transmission. This is suitable for simple data that is not sensitive to conversion losses. Simple export leads to exports more easily readable to the human eye. </summary> </member> <member name="F:PSFramework.Configuration.Config.ModuleExport"> <summary> Whether this setting should be exported to a module specific file when exporting to json by modulename. </summary> </member> <member name="P:PSFramework.Configuration.Config.RegistryData"> <summary> The finalized value to put into the registry value when using policy to set this setting. Deprecated property. </summary> </member> <member name="F:PSFramework.Configuration.Config.DefaultValue"> <summary> The default value the configuration item was set to when initializing </summary> </member> <member name="M:PSFramework.Configuration.Config.SetPersistedValue(PSFramework.Configuration.ConfigurationValueType,System.String)"> <summary> Applies the persisted value to the configuration item. This method should only be called by PSFramework internals </summary> <param name="Type">The type of data being specified</param> <param name="ValueString">The value string to register</param> </member> <member name="M:PSFramework.Configuration.Config.ResetValue"> <summary> Resets the configuration value to its configured default value </summary> </member> <member name="T:PSFramework.Configuration.ConfigScope"> <summary> The location where a setting was applied </summary> </member> <member name="F:PSFramework.Configuration.ConfigScope.UserDefault"> <summary> The configuration is set as default value for the user </summary> </member> <member name="F:PSFramework.Configuration.ConfigScope.UserMandatory"> <summary> The configuration is enforced for the user </summary> </member> <member name="F:PSFramework.Configuration.ConfigScope.SystemDefault"> <summary> The configuration is set as default value for all users on the system </summary> </member> <member name="F:PSFramework.Configuration.ConfigScope.SystemMandatory"> <summary> The configuration is enforced for all users on the system. </summary> </member> <member name="F:PSFramework.Configuration.ConfigScope.FileUserLocal"> <summary> The configuration is stored as Json in the per user local machine config directory. </summary> </member> <member name="F:PSFramework.Configuration.ConfigScope.FileUserShared"> <summary> The configuration is stored as Json in the per user config directory shared across machines. </summary> </member> <member name="F:PSFramework.Configuration.ConfigScope.FileSystem"> <summary> The configuration is stored as Json in the local computer config directory. </summary> </member> <member name="F:PSFramework.Configuration.ConfigScope.Environment"> <summary> The configuration is stored in environment variables with full data syntax. </summary> </member> <member name="F:PSFramework.Configuration.ConfigScope.EnvironmentSimple"> <summary> The configuration is stored in environment variables with simplified data syntax. </summary> </member> <member name="T:PSFramework.Configuration.ConfigurationHost"> <summary> Host class providing static configuration settings that are constant across all runspaces within the process. </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationHost.Configurations"> <summary> Hashtable containing all the configuration entries </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationHost.Validation"> <summary> Hashtable containing all the registered validations </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationHost.Schemata"> <summary> The list of configuration definitions, controlling how configuration data is ingested. </summary> </member> <member name="M:PSFramework.Configuration.ConfigurationHost.DeleteConfiguration(System.String)"> <summary> Deletes a configuration setting in compliance with policy. </summary> <param name="FullName">The full name of the setting the remove</param> <returns>Whether the deletion was successful</returns> </member> <member name="F:PSFramework.Configuration.ConfigurationHost.ImportFromRegistryDone"> <summary> Whether the import from registry has been completed. Prevents multiple imports and overwrites when importing the module multiple times. </summary> </member> <member name="M:PSFramework.Configuration.ConfigurationHost.ConvertToPersistedValue(System.Object)"> <summary> Converts any object into its persisted state. </summary> <param name="Item">The item to convert.</param> <returns>Its persisted state representation.</returns> </member> <member name="M:PSFramework.Configuration.ConfigurationHost.ConvertFromPersistedValue(System.String,PSFramework.Configuration.ConfigurationValueType)"> <summary> Converts a persisted value back to its original data type </summary> <param name="PersistedValue">The value in its persisted state</param> <param name="Type">The type of the persisted value</param> <returns>The natural state of the value originally persisted</returns> </member> <member name="M:PSFramework.Configuration.ConfigurationHost.ConvertFromPersistedValue(System.String)"> <summary> Converts a persisted value back to its original data type </summary> <param name="TypeQualifiedPersistedValue">The value in its persisted state, with a prefixed type identifier.</param> <returns>The natural state of the value originally persisted</returns> </member> <member name="M:PSFramework.Configuration.ConfigurationHost.GetConfigValue(System.String)"> <summary> Retrieve the configuration value only. Returns null if the configuration entry does not exist. </summary> <param name="FullName">The full name of the configuration object of which to return the value</param> <returns>The value of the configuration entry.</returns> </member> <member name="M:PSFramework.Configuration.ConfigurationHost.Utf8ToBase64(System.String)"> <summary> Converts a plain text into a base64 string </summary> <param name="Value">The string to convert</param> <returns>base64 encoded version of string.</returns> </member> <member name="M:PSFramework.Configuration.ConfigurationHost.Base64ToUtf8(System.String)"> <summary> Converts a base64 encoded string into plain text </summary> <param name="Value">The string to convert</param> <returns>Plain Text string</returns> </member> <member name="T:PSFramework.Configuration.ConfigurationValue"> <summary> Contains all information about a configuration item's value </summary> </member> <member name="P:PSFramework.Configuration.ConfigurationValue.Value"> <summary> The runtime value of the setting. </summary> </member> <member name="P:PSFramework.Configuration.ConfigurationValue.PersistedValue"> <summary> The value in its persisted state </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValue.PersistedType"> <summary> The kind of </summary> </member> <member name="P:PSFramework.Configuration.ConfigurationValue.TypeQualifiedPersistedValue"> <summary> The type qualified representation of the persisted value </summary> </member> <member name="P:PSFramework.Configuration.ConfigurationValue.SafeValue"> <summary> Ensures wanton Get-PSFConfig will not deserialize persisted objects that might have registered deserialization in their module. </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValue._Value"> <summary> Internal storage for the Value property </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValue._PersistedValue"> <summary> Internal storage for the PersistedValue property </summary> </member> <member name="M:PSFramework.Configuration.ConfigurationValue.ToString"> <summary> The string representation of its actual value </summary> <returns>Returns the type-qualified string representation of its value</returns> </member> <member name="M:PSFramework.Configuration.ConfigurationValue.#ctor(System.String,PSFramework.Configuration.ConfigurationValueType)"> <summary> Creates a value object from persisted data </summary> <param name="PersistedValue">The value that will be persisted</param> <param name="PersistedType">The type of the value to be persisted</param> </member> <member name="M:PSFramework.Configuration.ConfigurationValue.#ctor(System.Object)"> <summary> Creates a value object from runtime data </summary> <param name="Value">The value that will be stored</param> </member> <member name="T:PSFramework.Configuration.ConfigurationValueType"> <summary> The data types supported by the configuration system. </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Unknown"> <summary> An unknown type, should be prevented </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Null"> <summary> The value is as empty as the void. </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Bool"> <summary> The value is of a true/false kind </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Int"> <summary> The value is a regular integer </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Double"> <summary> The value is a double numeric value </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Long"> <summary> The value is a long type </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.String"> <summary> The value is a common string </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Timespan"> <summary> The value is a regular timespan </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Datetime"> <summary> The value is a plain datetime </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.ConsoleColor"> <summary> The value is a fancy console color </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Array"> <summary> The value is an array full of booty </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Hashtable"> <summary> The value is a hashtable </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Object"> <summary> The value is something indeterminate, but possibly complex </summary> </member> <member name="T:PSFramework.Feature.FeatureHost"> <summary> Manages the feature flag component </summary> </member> <member name="F:PSFramework.Feature.FeatureHost._ModuleFeatureFlags"> <summary> Repository of features modules may opt into or out of </summary> </member> <member name="F:PSFramework.Feature.FeatureHost._ExperimentalFeatureFlags"> <summary> Repository of features and their global enablement state </summary> </member> <member name="F:PSFramework.Feature.FeatureHost.Features"> <summary> List of all registered features. </summary> </member> <member name="M:PSFramework.Feature.FeatureHost.WriteModuleFlag(System.String,System.String,System.Boolean)"> <summary> Sets a module-scope feature flag </summary> <param name="ModuleName">The module for which to set the feature flag</param> <param name="FeatureFlag">The flag to set it to</param> <param name="Value">The value to set it to</param> </member> <member name="M:PSFramework.Feature.FeatureHost.WriteGlobalFlag(System.String,System.Boolean)"> <summary> Sets a global feature flag </summary> <param name="FeatureFlag">The flag to set</param> <param name="Value">The value to apply</param> </member> <member name="M:PSFramework.Feature.FeatureHost.ReadFlag(System.String,System.String)"> <summary> Returns whether a given feature is enabled either globally or module locally </summary> <param name="FeatureFlag">The flag to test</param> <param name="ModuleName">The module to look up (specifying this is optional, omitting this parameter will cause it to only test global flags)</param> <returns>Whether the feature is enabled</returns> </member> <member name="M:PSFramework.Feature.FeatureHost.ReadModuleFlag(System.String,System.String)"> <summary> Returns whether a module specific feature is enabled or not </summary> <param name="FeatureFlag">The feature flag to check for</param> <param name="ModuleName">The module to check in</param> <returns>Whether the features asked for is enabled for the module specified</returns> </member> <member name="T:PSFramework.Feature.FeatureItem"> <summary> Represents a feature a module offers </summary> </member> <member name="F:PSFramework.Feature.FeatureItem.Name"> <summary> The name of the feature </summary> </member> <member name="F:PSFramework.Feature.FeatureItem.Owner"> <summary> The owning module </summary> </member> <member name="F:PSFramework.Feature.FeatureItem.Global"> <summary> Whether the feature can be set globally </summary> </member> <member name="F:PSFramework.Feature.FeatureItem.ModuleSpecific"> <summary> Whether the feature can be overridden on a per module bases. </summary> </member> <member name="F:PSFramework.Feature.FeatureItem.Description"> <summary> The general description of the feature for human consumption </summary> </member> <member name="M:PSFramework.Feature.FeatureItem.#ctor"> <summary> Creates an empty feature </summary> </member> <member name="M:PSFramework.Feature.FeatureItem.#ctor(System.String,System.String,System.Boolean,System.Boolean,System.String)"> <summary> Creates a feature all fileld out. </summary> <param name="Name"></param> <param name="Owner"></param> <param name="Global"></param> <param name="ModuleSpecific"></param> <param name="Description"></param> </member> <member name="T:PSFramework.License.License"> <summary> Contains license information for a single product </summary> </member> <member name="F:PSFramework.License.License.Product"> <summary> The name of the product the license is for. </summary> </member> <member name="F:PSFramework.License.License.Manufacturer"> <summary> Who made the license product? </summary> </member> <member name="F:PSFramework.License.License.ProductVersion"> <summary> The version of the product covered by the license. </summary> </member> <member name="F:PSFramework.License.License.ProductType"> <summary> The type of product the licensed product is. </summary> </member> <member name="F:PSFramework.License.License.LicenseName"> <summary> The name of the license. Useful for the usual public licenses. </summary> </member> <member name="F:PSFramework.License.License.LicenseVersion"> <summary> The version of the license. Useful for the usual public licenses. </summary> </member> <member name="F:PSFramework.License.License.LicenseDate"> <summary> When was the product licensed with the specified license. </summary> </member> <member name="F:PSFramework.License.License.LicenseType"> <summary> The type of the license. This allows filtering licenses by their limitations. </summary> </member> <member name="F:PSFramework.License.License.LicenseText"> <summary> The full license text for the pleasure of the reader. </summary> </member> <member name="F:PSFramework.License.License.Description"> <summary> Add some desription to how it is used. </summary> </member> <member name="F:PSFramework.License.License.Parent"> <summary> A parent license to indicate a product used within a product. </summary> </member> <member name="M:PSFramework.License.License.ToString"> <summary> The default string representation of the license object </summary> <returns>The default string representation of the license object</returns> </member> <member name="T:PSFramework.License.LicenseHost"> <summary> Host class covering all static needs of the licensing system. </summary> </member> <member name="F:PSFramework.License.LicenseHost.Licenses"> <summary> The list containing all registered licenses. </summary> </member> <member name="M:PSFramework.License.LicenseHost.Add(PSFramework.License.License)"> <summary> Adds a new licenses to the list of registerd licenses. </summary> <param name="License">The license to add</param> </member> <member name="M:PSFramework.License.LicenseHost.Clear"> <summary> Removes all registered Licenses </summary> </member> <member name="M:PSFramework.License.LicenseHost.Get"> <summary> Returns all registered licenses </summary> <returns>All registerd licenses</returns> </member> <member name="M:PSFramework.License.LicenseHost.Get(PSFramework.License.License)"> <summary> Returns a license that matches the specified license in content </summary> <param name="ReferenceLicense">The license based on which to search</param> <returns>The matching license object</returns> </member> <member name="M:PSFramework.License.LicenseHost.Remove(PSFramework.License.License)"> <summary> Removes a spceific licenses from the list of registerd licenses </summary> <param name="License">License to remove</param> </member> <member name="T:PSFramework.License.LicenseType"> <summary> What kind of License is this? By default, a license is a free license allowing modification but requiring attribution. </summary> </member> <member name="F:PSFramework.License.LicenseType.Free"> <summary> No special type is present </summary> </member> <member name="F:PSFramework.License.LicenseType.Commercial"> <summary> The license is for a commercial product. This means you have to acquire use permission, such as software licenses, user CALs et al. </summary> </member> <member name="F:PSFramework.License.LicenseType.NoAttribution"> <summary> Reusing this product requires no attribution. Just use it and call it your own. </summary> </member> <member name="F:PSFramework.License.LicenseType.NoModify"> <summary> This product may be used, but must not be modified in any way. </summary> </member> <member name="T:PSFramework.License.ProductType"> <summary> What kind of product is being licensed </summary> </member> <member name="F:PSFramework.License.ProductType.Module"> <summary> The product is a PowerShell module </summary> </member> <member name="F:PSFramework.License.ProductType.Script"> <summary> The Product is a Script of any kind </summary> </member> <member name="F:PSFramework.License.ProductType.Library"> <summary> The Product is a library, bringing functionality to the Shell </summary> </member> <member name="F:PSFramework.License.ProductType.Application"> <summary> The Product is a standalone application, that happens to utilize PowerShell </summary> </member> <member name="F:PSFramework.License.ProductType.Other"> <summary> The Product is anything other than the default types </summary> </member> <member name="T:PSFramework.Localization.LocalizationHost"> <summary> Helper class that offers static resources for the localization component </summary> </member> <member name="F:PSFramework.Localization.LocalizationHost.Language"> <summary> The language to display text with by default. Will use thread information if not set. </summary> </member> <member name="F:PSFramework.Localization.LocalizationHost.LoggingLanguage"> <summary> The default language to log in. </summary> </member> <member name="F:PSFramework.Localization.LocalizationHost.Strings"> <summary> List of strings registered </summary> </member> <member name="F:PSFramework.Localization.LocalizationHost.ModuleLoggingLanguage"> <summary> Mapping module name to the language to use for logging. </summary> </member> <member name="M:PSFramework.Localization.LocalizationHost.SetLoggingLanguage(System.String,System.String)"> <summary> Configure the module specific logging language. </summary> <param name="Module">The module to configure</param> <param name="Language">The language to set. Leave empty to remove entry.</param> </member> <member name="M:PSFramework.Localization.LocalizationHost.Write(System.String,System.String,System.String)"> <summary> Writes a localized string. If needed creates it, then sets the text of the specified language. </summary> <param name="FullName">The name of the value to set</param> <param name="Language">The language to set it for</param> <param name="Text">The text to register</param> </member> <member name="M:PSFramework.Localization.LocalizationHost.Write(System.String,System.String,System.String,System.String)"> <summary> Writes a localized string. If needed creates it, then sets the text of the specified language. </summary> <param name="Module">The name of the module for which to set a value</param> <param name="Name">The name of the text for which to set the value</param> <param name="Language">The language to set it for</param> <param name="Text">The text to register</param> </member> <member name="M:PSFramework.Localization.LocalizationHost.Read(System.String)"> <summary> Reads a localized string from the list of available strings </summary> <param name="FullName">The name of the string to request. Include the modulename</param> <returns>The localized string requested. Empty string if nothing.</returns> </member> <member name="M:PSFramework.Localization.LocalizationHost.Read(System.String,System.Object[])"> <summary> Reads a localized string from the list of available strings </summary> <param name="FullName">The name of the string to request. Include the modulename</param> <param name="StringValues">The values to format into the string</param> <returns>The localized string requested. Empty string if nothing.</returns> </member> <member name="M:PSFramework.Localization.LocalizationHost.Read(System.String,System.String,System.Object[])"> <summary> Reads a localized string from the list of available strings </summary> <param name="ModuleName">The name of the module the string belongs to.</param> <param name="Name">The individual name of the setting.</param> <param name="StringValues">The values to format into the string</param> <returns>The localized string requested. Empty string if nothing.</returns> </member> <member name="M:PSFramework.Localization.LocalizationHost.ReadLog(System.String)"> <summary> Reads a localized string from the list of available strings for the purpose of logging </summary> <param name="FullName">The name of the string to request. Include the modulename</param> <returns>The localized string requested. Empty string if nothing.</returns> </member> <member name="M:PSFramework.Localization.LocalizationHost.ReadLog(System.String,System.Object[])"> <summary> Reads a localized string from the list of available strings for the purpose of logging </summary> <param name="FullName">The name of the string to request. Include the modulename</param> <param name="StringValues">The values to format into the string</param> <returns>The localized string requested. Empty string if nothing.</returns> </member> <member name="M:PSFramework.Localization.LocalizationHost.ReadLog(System.String,System.String,System.Object[])"> <summary> Reads a localized string from the list of available strings for the purpose of logging </summary> <param name="ModuleName">The name of the module the string belongs to.</param> <param name="Name">The individual name of the setting.</param> <param name="StringValues">The values to format into the string</param> <returns>The localized string requested. Empty string if nothing.</returns> </member> <member name="T:PSFramework.Localization.LocalString"> <summary> A string used for localized text </summary> </member> <member name="F:PSFramework.Localization.LocalString.Module"> <summary> The name of the module the string is a part of </summary> </member> <member name="F:PSFramework.Localization.LocalString.Name"> <summary> The name of the string </summary> </member> <member name="P:PSFramework.Localization.LocalString.FullName"> <summary> The full, public name of the string </summary> </member> <member name="P:PSFramework.Localization.LocalString.Value"> <summary> The actual string value of the text </summary> </member> <member name="P:PSFramework.Localization.LocalString.LogValue"> <summary> The string value to use for logging purposes </summary> </member> <member name="M:PSFramework.Localization.LocalString.Set(System.String,System.String)"> <summary> Sets the text for a specific language </summary> <param name="Language">The language to set it for (eg: en-US; not case sensitive)</param> <param name="Text">The text to apply</param> </member> <member name="M:PSFramework.Localization.LocalString.GetAll"> <summary> Returns a list of all strings </summary> <returns>The strings in all languages available</returns> </member> <member name="M:PSFramework.Localization.LocalString.#ctor(System.String,System.String)"> <summary> Creates a new localized string </summary> <param name="Module"></param> <param name="Name"></param> </member> <member name="M:PSFramework.Localization.LocalString.#ctor(System.String)"> <summary> Creates a new localized string </summary> <param name="FullName"></param> </member> <member name="T:PSFramework.Localization.LocalStrings"> <summary> An accessor, designed to make strings more accessible from within powershell script code </summary> </member> <member name="F:PSFramework.Localization.LocalStrings._ModuleName"> <summary> The name of the module to map with this accessor </summary> </member> <member name="M:PSFramework.Localization.LocalStrings.Qualify(System.String)"> <summary> Helper method that qualifies names with the module </summary> <param name="Name"></param> <returns></returns> </member> <member name="M:PSFramework.Localization.LocalStrings.ContainsKey(System.String)"> <summary> </summary> <param name="Key"></param> <returns></returns> </member> <member name="M:PSFramework.Localization.LocalStrings.Add(System.String,System.String)"> <summary> </summary> <param name="Key"></param> <param name="Value"></param> </member> <member name="M:PSFramework.Localization.LocalStrings.Remove(System.String)"> <summary> </summary> <param name="Key"></param> <returns></returns> </member> <member name="M:PSFramework.Localization.LocalStrings.TryGetValue(System.String,System.String@)"> <summary> </summary> <param name="Key"></param> <param name="Value"></param> <returns></returns> </member> <member name="M:PSFramework.Localization.LocalStrings.Add(System.Collections.Generic.KeyValuePair{System.String,System.String})"> <summary> </summary> <param name="item"></param> </member> <member name="M:PSFramework.Localization.LocalStrings.Clear"> <summary> </summary> </member> <member name="M:PSFramework.Localization.LocalStrings.Contains(System.Collections.Generic.KeyValuePair{System.String,System.String})"> <summary> </summary> <param name="item"></param> <returns></returns> </member> <member name="M:PSFramework.Localization.LocalStrings.CopyTo(System.Collections.Generic.KeyValuePair{System.String,System.String}[],System.Int32)"> <summary> </summary> <param name="array"></param> <param name="arrayIndex"></param> </member> <member name="M:PSFramework.Localization.LocalStrings.Remove(System.Collections.Generic.KeyValuePair{System.String,System.String})"> <summary> </summary> <param name="item"></param> <returns></returns> </member> <member name="M:PSFramework.Localization.LocalStrings.GetEnumerator"> <summary> </summary> <returns></returns> </member> <member name="M:PSFramework.Localization.LocalStrings.System#Collections#IEnumerable#GetEnumerator"> <summary> </summary> <returns></returns> </member> <member name="M:PSFramework.Localization.LocalStrings.Contains(System.Object)"> <summary> </summary> <param name="key"></param> <returns></returns> </member> <member name="M:PSFramework.Localization.LocalStrings.Add(System.Object,System.Object)"> <summary> </summary> <param name="key"></param> <param name="value"></param> </member> <member name="M:PSFramework.Localization.LocalStrings.System#Collections#IDictionary#GetEnumerator"> <summary> </summary> <returns></returns> </member> <member name="M:PSFramework.Localization.LocalStrings.Remove(System.Object)"> <summary> </summary> <param name="key"></param> </member> <member name="M:PSFramework.Localization.LocalStrings.CopyTo(System.Array,System.Int32)"> <summary> </summary> <param name="array"></param> <param name="index"></param> </member> <member name="P:PSFramework.Localization.LocalStrings.Keys"> <summary> </summary> </member> <member name="P:PSFramework.Localization.LocalStrings.Values"> <summary> </summary> </member> <member name="P:PSFramework.Localization.LocalStrings.Count"> <summary> </summary> </member> <member name="P:PSFramework.Localization.LocalStrings.IsReadOnly"> <summary> </summary> </member> <member name="P:PSFramework.Localization.LocalStrings.System#Collections#IDictionary#Keys"> <summary> </summary> </member> <member name="P:PSFramework.Localization.LocalStrings.System#Collections#IDictionary#Values"> <summary> </summary> </member> <member name="P:PSFramework.Localization.LocalStrings.IsFixedSize"> <summary> </summary> </member> <member name="P:PSFramework.Localization.LocalStrings.SyncRoot"> <summary> </summary> </member> <member name="P:PSFramework.Localization.LocalStrings.IsSynchronized"> <summary> </summary> </member> <member name="P:PSFramework.Localization.LocalStrings.Item(System.Object)"> <summary> </summary> <param name="key"></param> <returns></returns> </member> <member name="P:PSFramework.Localization.LocalStrings.Item(System.String)"> <summary> </summary> <param name="key"></param> <returns></returns> </member> <member name="M:PSFramework.Localization.LocalStrings.#ctor(System.String)"> <summary> Creates a wrapper around the string collection </summary> <param name="ModuleName">The name of the module to wrap</param> </member> <member name="T:PSFramework.Logging.LogFileFileType"> <summary> The data format to log to in the logfile logging provider </summary> </member> <member name="F:PSFramework.Logging.LogFileFileType.Csv"> <summary> Write as comma separated value </summary> </member> <member name="F:PSFramework.Logging.LogFileFileType.Html"> <summary> Write as Html fragment </summary> </member> <member name="F:PSFramework.Logging.LogFileFileType.Json"> <summary> Write as Json fragment </summary> </member> <member name="F:PSFramework.Logging.LogFileFileType.Xml"> <summary> Write as Xml fragment </summary> </member> <member name="F:PSFramework.Logging.LogFileFileType.CMTrace"> <summary> Write as CMTrace compatible entry </summary> </member> <member name="T:PSFramework.Logging.LoggingState"> <summary> Used to signal the current processing state of the logging runspace </summary> </member> <member name="F:PSFramework.Logging.LoggingState.Unstarted"> <summary> The initial state before the logging runspace is spun up </summary> </member> <member name="F:PSFramework.Logging.LoggingState.Initializing"> <summary> Spinning up logging providers </summary> </member> <member name="F:PSFramework.Logging.LoggingState.Ready"> <summary> Ready to process messages </summary> </member> <member name="F:PSFramework.Logging.LoggingState.Writing"> <summary> Currently busy writing messages </summary> </member> <member name="F:PSFramework.Logging.LoggingState.Broken"> <summary> A critical error in the logging runspaces has occured, logging has terminated </summary> </member> <member name="F:PSFramework.Logging.LoggingState.Stopped"> <summary> The logging has been fully stopped </summary> </member> <member name="T:PSFramework.Logging.Provider"> <summary> Class containing all information/content needed for a logging provider </summary> </member> <member name="F:PSFramework.Logging.Provider.Name"> <summary> Each logging provider has a name. Make sure it's unique </summary> </member> <member name="F:PSFramework.Logging.Provider.Enabled"> <summary> Whether the logging provider is enabled. Only when this is set to true will the logging script execute its events. </summary> </member> <member name="F:PSFramework.Logging.Provider.Initialized"> <summary> The provider has had its initial runtime configuration (what is stored in the BeginEvent) applied. </summary> </member> <member name="F:PSFramework.Logging.Provider.InstallationOptional"> <summary> Whether the provider must be installed, in order for it to be used. </summary> </member> <member name="F:PSFramework.Logging.Provider.ProviderVersion"> <summary> The generation of the logging provider. </summary> </member> <member name="P:PSFramework.Logging.Provider.IncludeModules"> <summary> List of modules to include in the logging. Only messages generated from these modules will be considered by the provider instance. </summary> </member> <member name="P:PSFramework.Logging.Provider.ExcludeModules"> <summary> List of modules to exclude in the logging. Messages generated from these modules will be ignored by this provider instance. </summary> </member> <member name="P:PSFramework.Logging.Provider.IncludeFunctions"> <summary> List of functions to include in the logging. Only messages generated from these functions will be considered by the provider instance. </summary> </member> <member name="P:PSFramework.Logging.Provider.ExcludeFunctions"> <summary> List of functions to exclude in the logging. Messages generated from these functions will be ignored by this provider instance. </summary> </member> <member name="P:PSFramework.Logging.Provider.IncludeTags"> <summary> List of tags to include. Only messages with these tags will be considered by this provider instance. </summary> </member> <member name="P:PSFramework.Logging.Provider.ExcludeTags"> <summary> List of tags to exclude. Messages with these tags will be ignored by this provider instance. </summary> </member> <member name="P:PSFramework.Logging.Provider.IncludeRunspaces"> <summary> List of runspaces to include. Only messages from one of these runspaces will be considered by this provider. </summary> </member> <member name="P:PSFramework.Logging.Provider.ExcludeRunspaces"> <summary> List of runspaces to exclude. Messages from these runspaces will be ignored by this provider. </summary> </member> <member name="P:PSFramework.Logging.Provider.MinLevel"> <summary> The minimum level of message to log. Note, the lower the level, the higher the priority. </summary> </member> <member name="P:PSFramework.Logging.Provider.MaxLevel"> <summary> The maximum level of message to log. Note, the lower the level, the higher the priority. </summary> </member> <member name="F:PSFramework.Logging.Provider.IncludeWarning"> <summary> Whether to include warning messages in the log </summary> </member> <member name="F:PSFramework.Logging.Provider.IncludeError"> <summary> Whether to include error messages in the log </summary> </member> <member name="M:PSFramework.Logging.Provider.MessageApplies(PSFramework.Message.LogEntry)"> <summary> Tests whether a log entry applies to the provider instance </summary> <param name="Entry">The Entry to validate</param> <returns>Whether it applies</returns> </member> <member name="M:PSFramework.Logging.Provider.MessageApplies(PSFramework.Message.PsfExceptionRecord)"> <summary> Tests whether an error record applies to the provider instance </summary> <param name="Record">The error record to test</param> <returns>Whether it applies to the provider instance</returns> </member> <member name="F:PSFramework.Logging.Provider.BeginEvent"> <summary> Event that is executed once per logging script execution, before logging occurs </summary> </member> <member name="F:PSFramework.Logging.Provider.StartEvent"> <summary> Event that is executed each logging cycle, right before processing items. </summary> </member> <member name="F:PSFramework.Logging.Provider.MessageEvent"> <summary> Event that is executed for each message written </summary> </member> <member name="F:PSFramework.Logging.Provider.ErrorEvent"> <summary> Event that is executed for each error written </summary> </member> <member name="F:PSFramework.Logging.Provider.EndEvent"> <summary> Event that is executed once per logging cycle, after processing all message and error items. </summary> </member> <member name="F:PSFramework.Logging.Provider.FinalEvent"> <summary> Final Event that is executed when stopping the logging script. </summary> </member> <member name="M:PSFramework.Logging.Provider.LocalizeEvents"> <summary> This will import the events into the current execution context, breaking runspace affinity </summary> </member> <member name="F:PSFramework.Logging.Provider.IsInstalledScript"> <summary> Script that recognizes, whether the provider has been isntalled correctly. Some providers require installation, in order to function properly. </summary> </member> <member name="F:PSFramework.Logging.Provider.InstallationScript"> <summary> Script that installs the provider </summary> </member> <member name="F:PSFramework.Logging.Provider.InstallationParameters"> <summary> Script that generates dynamic parameters for installing the provider. </summary> </member> <member name="F:PSFramework.Logging.Provider.ConfigurationParameters"> <summary> Scriptblock that adds additional parameters as needed to the Set-PSFLoggingProvider function </summary> </member> <member name="F:PSFramework.Logging.Provider.ConfigurationScript"> <summary> The configuration steps taken by the Set-PSFLoggingProvider function </summary> </member> <member name="F:PSFramework.Logging.Provider.Errors"> <summary> List of errors that happened on the logging runspace. </summary> </member> <member name="M:PSFramework.Logging.Provider.ToString"> <summary> Returns the name of the provider. </summary> <returns>Returns the name of the provider.</returns> </member> <member name="T:PSFramework.Logging.ProviderHost"> <summary> Provides infrastructure services for the logging provider system </summary> </member> <member name="F:PSFramework.Logging.ProviderHost.Providers"> <summary> Dictionary with all registered logging providers </summary> </member> <member name="F:PSFramework.Logging.ProviderHost.LoggingState"> <summary> The current state of the logging system </summary> </member> <member name="M:PSFramework.Logging.ProviderHost.GetEnabled"> <summary> Returns all enabled logging providers </summary> <returns>All enabled logging providers</returns> </member> <member name="M:PSFramework.Logging.ProviderHost.GetInitialized(System.Boolean)"> <summary> Returns all enabled & initialized logging provider </summary> /// <param name="IncludeDisabled">Whether disabled providers should also be returned</param> <returns></returns> </member> <member name="M:PSFramework.Logging.ProviderHost.GetEnabledInstances"> <summary> Returns all enabled provider instances </summary> <returns>All enabled provider instances</returns> </member> <member name="M:PSFramework.Logging.ProviderHost.GetInitializedInstances(System.Boolean)"> <summary> Returns all enabled and initialized provider instances </summary> <param name="IncludeDisabled">Whether disabled instances should also be returned</param> <returns>All enabled and initialized provider instances</returns> </member> <member name="F:PSFramework.Logging.ProviderHost.ProviderV2ModuleScript"> <summary> The scriptblock used to create the dynamic module implementing the logging provider generation 2 logging instance. </summary> </member> <member name="M:PSFramework.Logging.ProviderHost.InitializeProviderInstance(PSFramework.Logging.ProviderInstance)"> <summary> Initializes a logging provider instance, creating the dynamic module needed and updating its metadata to reflect this change. </summary> <param name="Instance">The instance to initialize</param> </member> <member name="M:PSFramework.Logging.ProviderHost.UpdateAllInstances"> <summary> Updates all V2 provider instances, creating new ones depending on configuration. </summary> </member> <member name="T:PSFramework.Logging.ProviderInstance"> <summary> Active instance of a logging provider </summary> </member> <member name="F:PSFramework.Logging.ProviderInstance.Name"> <summary> name of the instance </summary> </member> <member name="F:PSFramework.Logging.ProviderInstance.Provider"> <summary> The logging provider it is an instance of </summary> </member> <member name="F:PSFramework.Logging.ProviderInstance.Enabled"> <summary> Whether the logging provider instance is enabled. Only when this is set to true will the logging script execute its events. </summary> </member> <member name="F:PSFramework.Logging.ProviderInstance.Initialized"> <summary> The provider instance has had its initial runtime configuration (what is stored in the BeginEvent) applied. </summary> </member> <member name="M:PSFramework.Logging.ProviderInstance.#ctor(PSFramework.Logging.ProviderV2,System.String)"> <summary> Creates a new instance of a logging provider </summary> <param name="Provider">The provider from which to create an instance.</param> <param name="Name">The name of the instance to create.</param> </member> <member name="M:PSFramework.Logging.ProviderInstance.ImportConfig"> <summary> Refreshes the filter and enablement settings from configuration </summary> </member> <member name="F:PSFramework.Logging.ProviderInstance.RequiresInclude"> <summary> Whether any include rule must apply before the instance accepts a message. </summary> </member> <member name="P:PSFramework.Logging.ProviderInstance.IncludeModules"> <summary> List of modules to include in the logging. Only messages generated from these modules will be considered by the provider instance. </summary> </member> <member name="P:PSFramework.Logging.ProviderInstance.ExcludeModules"> <summary> List of modules to exclude in the logging. Messages generated from these modules will be ignored by this provider instance. </summary> </member> <member name="P:PSFramework.Logging.ProviderInstance.IncludeFunctions"> <summary> List of functions to include in the logging. Only messages generated from these functions will be considered by the provider instance. </summary> </member> <member name="P:PSFramework.Logging.ProviderInstance.ExcludeFunctions"> <summary> List of functions to exclude in the logging. Messages generated from these functions will be ignored by this provider instance. </summary> </member> <member name="P:PSFramework.Logging.ProviderInstance.IncludeTags"> <summary> List of tags to include. Only messages with these tags will be considered by this provider instance. </summary> </member> <member name="P:PSFramework.Logging.ProviderInstance.ExcludeTags"> <summary> List of tags to exclude. Messages with these tags will be ignored by this provider instance. </summary> </member> <member name="P:PSFramework.Logging.ProviderInstance.IncludeRunspaces"> <summary> List of runspaces to include. Only messages from one of these runspaces will be considered by this provider instance. </summary> </member> <member name="P:PSFramework.Logging.ProviderInstance.ExcludeRunspaces"> <summary> List of runspaces to exclude. Messages from these runspaces will be ignored by this provider instance. </summary> </member> <member name="P:PSFramework.Logging.ProviderInstance.MinLevel"> <summary> The minimum level of message to log. Note, the lower the level, the higher the priority. </summary> </member> <member name="P:PSFramework.Logging.ProviderInstance.MaxLevel"> <summary> The maximum level of message to log. Note, the lower the level, the higher the priority. </summary> </member> <member name="F:PSFramework.Logging.ProviderInstance.IncludeWarning"> <summary> Whether to include warning messages in the log </summary> </member> <member name="F:PSFramework.Logging.ProviderInstance.IncludeError"> <summary> Whether to include error messages in the log </summary> </member> <member name="M:PSFramework.Logging.ProviderInstance.MessageApplies(PSFramework.Message.LogEntry)"> <summary> Tests whether a log entry applies to the provider instance </summary> <param name="Entry">The Entry to validate</param> <returns>Whether it applies</returns> </member> <member name="M:PSFramework.Logging.ProviderInstance.MessageApplies(PSFramework.Message.PsfExceptionRecord)"> <summary> Tests whether an error record applies to the provider instance </summary> <param name="Record">The error record to test</param> <returns>Whether it applies to the provider instance</returns> </member> <member name="F:PSFramework.Logging.ProviderInstance.Module"> <summary> The module containing the instance content </summary> </member> <member name="F:PSFramework.Logging.ProviderInstance.BeginCommand"> <summary> The function to use to execute in the begin phase </summary> </member> <member name="F:PSFramework.Logging.ProviderInstance.StartCommand"> <summary> The function to use to execute the start phase </summary> </member> <member name="F:PSFramework.Logging.ProviderInstance.MessageCommand"> <summary> The function to use to execute the message phase </summary> </member> <member name="F:PSFramework.Logging.ProviderInstance.ErrorCommand"> <summary> The function to use to execute the error phase </summary> </member> <member name="F:PSFramework.Logging.ProviderInstance.EndCommand"> <summary> the function to use to execute the end phase </summary> </member> <member name="F:PSFramework.Logging.ProviderInstance.FinalCommand"> <summary> The function to use to execute the final phase </summary> </member> <member name="M:PSFramework.Logging.ProviderInstance.AddRunspace(System.Guid)"> <summary> Add a runspace ID to the list of included runspaces. This is threadsafe. </summary> <param name="Runspace">ID of the runspace to add.</param> </member> <member name="M:PSFramework.Logging.ProviderInstance.RemoveRunspace(System.Guid)"> <summary> Remove a runspace ID from the list of included runspaces. This is threadsafe. </summary> <param name="Runspace">The runspace to remove.</param> </member> <member name="F:PSFramework.Logging.ProviderInstance.Errors"> <summary> The last 128 errors that happenend to the provider instance </summary> </member> <member name="M:PSFramework.Logging.ProviderInstance.ToString"> <summary> Returns the name of the provider instance. </summary> <returns>Returns the name of the provider instance.</returns> </member> <member name="T:PSFramework.Logging.ProviderV2"> <summary> A generation 2 logging provider, supporting resource isolation and multi-instance operation </summary> </member> <member name="F:PSFramework.Logging.ProviderV2.ProviderVersion"> <summary> The generation of the logging provider. </summary> </member> <member name="F:PSFramework.Logging.ProviderV2.Instances"> <summary> The list of instances currently enabled </summary> </member> <member name="F:PSFramework.Logging.ProviderV2.ConfigurationRoot"> <summary> The root configuration name. Used by instances to facilitate instance-specific configuration retrieval. </summary> </member> <member name="F:PSFramework.Logging.ProviderV2.InstanceProperties"> <summary> List of configuration properties one can assign to a logging provider instance. Maps directly to instance-specific configuration keys. Mostly for documentation purposes. </summary> </member> <member name="F:PSFramework.Logging.ProviderV2.Functions"> <summary> Functions used by the logging provider instances. </summary> </member> <member name="P:PSFramework.Logging.ProviderV2.EnabledInstances"> <summary> List of enabled instances </summary> </member> <member name="P:PSFramework.Logging.ProviderV2.DisabledInstances"> <summary> List of disabled instances </summary> </member> <member name="F:PSFramework.Logging.ProviderV2.ConfigurationDefaultValues"> <summary> The default values to include in configuration for new instances </summary> </member> <member name="M:PSFramework.Logging.ProviderV2.UpdateInstances"> <summary> Creates provider instances based on configuration. </summary> </member> <member name="T:PSFramework.Logging.ProviderVersion"> <summary> The generation of the Logging Provider Type </summary> </member> <member name="F:PSFramework.Logging.ProviderVersion.Version_1"> <summary> The initial, now legacy version of logging providers, where all providers share the same variable scope. </summary> </member> <member name="F:PSFramework.Logging.ProviderVersion.Version_2"> <summary> Generation 2 logging provider, where each provider is handled as a dynamically created module, properly isolating resource from each other. </summary> </member> <member name="T:PSFramework.Message.CallStack"> <summary> Container for a callstack, to create a non-volatile copy of the relevant information </summary> </member> <member name="F:PSFramework.Message.CallStack.Entries"> <summary> The entries that make up the callstack </summary> </member> <member name="M:PSFramework.Message.CallStack.ToString"> <summary> String representation of the callstack copy </summary> <returns></returns> </member> <member name="M:PSFramework.Message.CallStack.#ctor"> <summary> Create an empty callstack </summary> </member> <member name="M:PSFramework.Message.CallStack.#ctor(System.Collections.Generic.IEnumerable{System.Management.Automation.CallStackFrame})"> <summary> Initialize a callstack from a live callstack frame </summary> <param name="CallStack">The live powershell callstack</param> </member> <member name="T:PSFramework.Message.CallStackEntry"> <summary> A single entry within the callstack </summary> </member> <member name="F:PSFramework.Message.CallStackEntry.FunctionName"> <summary> The name of the command that executed </summary> </member> <member name="P:PSFramework.Message.CallStackEntry.File"> <summary> The file the command was defined in </summary> </member> <member name="F:PSFramework.Message.CallStackEntry.Line"> <summary> THe line in the scriptblock that has been executed </summary> </member> <member name="F:PSFramework.Message.CallStackEntry.InvocationInfo"> <summary> The full invocation info object </summary> </member> <member name="M:PSFramework.Message.CallStackEntry.#ctor"> <summary> Create an empty callstack entry. </summary> </member> <member name="M:PSFramework.Message.CallStackEntry.#ctor(System.String,System.String,System.Int32,System.Management.Automation.InvocationInfo)"> <summary> Creates a prefilled callstack entry. </summary> <param name="FunctionName"></param> <param name="File"></param> <param name="Line"></param> <param name="InvocationInfo"></param> </member> <member name="M:PSFramework.Message.CallStackEntry.ToString"> <summary> The string notation of the callstack entry </summary> <returns></returns> </member> <member name="T:PSFramework.Message.LogEntry"> <summary> An individual entry for the message log </summary> </member> <member name="P:PSFramework.Message.LogEntry.Message"> <summary> The message logged </summary> </member> <member name="P:PSFramework.Message.LogEntry.LogMessage"> <summary> The message to use for logging purposes. Using the localized string feature, this allows maintaining uniform logging languages while still supporting localized </summary> </member> <member name="F:PSFramework.Message.LogEntry.Type"> <summary> What kind of entry was this? </summary> </member> <member name="F:PSFramework.Message.LogEntry.Timestamp"> <summary> When was the message logged? </summary> </member> <member name="F:PSFramework.Message.LogEntry.FunctionName"> <summary> What function wrote the message </summary> </member> <member name="F:PSFramework.Message.LogEntry.ModuleName"> <summary> The name of the module of the function that wrote the message </summary> </member> <member name="F:PSFramework.Message.LogEntry.Tags"> <summary> The tags applied to the message </summary> </member> <member name="F:PSFramework.Message.LogEntry.Data"> <summary> Additional metadata provided by the message writer </summary> </member> <member name="F:PSFramework.Message.LogEntry.Level"> <summary> What level was the message? </summary> </member> <member name="F:PSFramework.Message.LogEntry.Runspace"> <summary> What runspace was the message written from? </summary> </member> <member name="F:PSFramework.Message.LogEntry.ComputerName"> <summary> The computer the message was generated on </summary> </member> <member name="F:PSFramework.Message.LogEntry.TargetObject"> <summary> The object that was the focus of this message. </summary> </member> <member name="F:PSFramework.Message.LogEntry.File"> <summary> The file from which the message was written. </summary> </member> <member name="F:PSFramework.Message.LogEntry.Line"> <summary> The line on which the message was written. </summary> </member> <member name="F:PSFramework.Message.LogEntry.CallStack"> <summary> The callstack when the message was written. </summary> </member> <member name="F:PSFramework.Message.LogEntry.Username"> <summary> The user that did the writing. </summary> </member> <member name="F:PSFramework.Message.LogEntry.ErrorRecord"> <summary> An error record associated with the message. </summary> </member> <member name="F:PSFramework.Message.LogEntry.String"> <summary> The string key to use when retrieving localized strings. </summary> </member> <member name="F:PSFramework.Message.LogEntry.StringValue"> <summary> Values to format into the localized string </summary> </member> <member name="M:PSFramework.Message.LogEntry.#ctor"> <summary> Creates an empty log entry </summary> </member> <member name="M:PSFramework.Message.LogEntry.#ctor(System.String,PSFramework.Message.LogEntryType,System.DateTime,System.String,System.String,System.Collections.Generic.List{System.String},System.Collections.Hashtable,PSFramework.Message.MessageLevel,System.Guid,System.String,System.Object,System.String,System.Int32,PSFramework.Message.CallStack,System.String,PSFramework.Message.PsfExceptionRecord,System.String,System.Object[])"> <summary> Creates a filled out log entry </summary> <param name="Message">The message that was logged</param> <param name="Type">The type(s) of message written</param> <param name="Timestamp">When was the message logged</param> <param name="FunctionName">What function wrote the message</param> <param name="ModuleName">Name of the module the function writing this message came from</param> <param name="Tags">Tags that were applied to the message</param> <param name="Data">Additional data provided by the message writer</param> <param name="Level">What level was the message written at.</param> <param name="Runspace">The ID of the runspace that wrote the message.</param> <param name="ComputerName">The computer the message was generated on.</param> <param name="TargetObject">The object this message was all about.</param> <param name="File">The file of the code that wrote the message.</param> <param name="Line">The line on which the message was written.</param> <param name="CallStack">The callstack that triggered the write.</param> <param name="Username">The user responsible for running the code that is writing the message.</param> <param name="ErrorRecord">An associated error item.</param> <param name="String">The string key to use for retrieving localized strings</param> <param name="StringValue">The values to format into the localized string</param> </member> <member name="T:PSFramework.Message.LogEntryType"> <summary> The kind of information the logged entry was. </summary> </member> <member name="F:PSFramework.Message.LogEntryType.None"> <summary> This entry wasn't written to any stream </summary> </member> <member name="F:PSFramework.Message.LogEntryType.Information"> <summary> A message that was written to the current host equivalent, if available also to the information stream </summary> </member> <member name="F:PSFramework.Message.LogEntryType.Verbose"> <summary> A message that was written to the verbose stream </summary> </member> <member name="F:PSFramework.Message.LogEntryType.Debug"> <summary> A message that was written to the Debug stream </summary> </member> <member name="F:PSFramework.Message.LogEntryType.Warning"> <summary> A message written to the warning stream </summary> </member> <member name="T:PSFramework.Message.LogHost"> <summary> Provides static information storage for logging related settings, as well as housing the logging queues. </summary> </member> <member name="F:PSFramework.Message.LogHost.MaxErrorCount"> <summary> The maximum numbers of error records maintained in-memory. </summary> </member> <member name="F:PSFramework.Message.LogHost.MaxMessageCount"> <summary> The maximum number of messages that can be maintained in the in-memory message queue </summary> </member> <member name="F:PSFramework.Message.LogHost.MaxMessagefileBytes"> <summary> The maximum size of a given logfile. When reaching this limit, the file will be abandoned and a new log created. Set to 0 to not limit the size. </summary> </member> <member name="F:PSFramework.Message.LogHost.MaxMessagefileCount"> <summary> The maximum number of logfiles maintained at a time. Exceeding this number will cause the oldest to be culled. Set to 0 to disable the limit. </summary> </member> <member name="F:PSFramework.Message.LogHost.MaxErrorFileBytes"> <summary> The maximum size all error files combined may have. When this number is exceeded, the oldest entry is culled. </summary> </member> <member name="F:PSFramework.Message.LogHost.MaxTotalFolderSize"> <summary> This is the upper limit of length all items in the log folder may have combined across all processes. </summary> </member> <member name="F:PSFramework.Message.LogHost.LoggingPath"> <summary> Path to where the logfiles live. </summary> </member> <member name="F:PSFramework.Message.LogHost.MaxLogFileAge"> <summary> Any logfile older than this will automatically be cleansed </summary> </member> <member name="F:PSFramework.Message.LogHost.MessageLogFileEnabled"> <summary> Governs, whether a log file for the system messages is written </summary> </member> <member name="F:PSFramework.Message.LogHost.MessageLogEnabled"> <summary> Governs, whether a log of recent messages is kept in memory </summary> </member> <member name="F:PSFramework.Message.LogHost.ErrorLogFileEnabled"> <summary> Governs, whether log files for errors are written </summary> </member> <member name="F:PSFramework.Message.LogHost.ErrorLogEnabled"> <summary> Governs, whether a log of recent errors is kept in memory </summary> </member> <member name="F:PSFramework.Message.LogHost.FileSystemModernLog"> <summary> Whether the filesystem logging provider uses the modern logging style with CSV headers and extra columns </summary> </member> <member name="F:PSFramework.Message.LogHost.FileSystemSerializationDepth"> <summary> The depth to which the target object should serialized. </summary> </member> <member name="F:PSFramework.Message.LogHost.TimeFormat"> <summary> The time pattern used when writing logfiles using the filesystem provider </summary> </member> <member name="F:PSFramework.Message.LogHost.Interval"> <summary> The interval at which the loging runspace runs. Increase to improve performance, reduce the minimize writing latency. </summary> </member> <member name="F:PSFramework.Message.LogHost.IntervalIdle"> <summary> The interval at which the loging runspace runs, when there is nothing to do. </summary> </member> <member name="F:PSFramework.Message.LogHost.IntervalIdleDuration"> <summary> The time with no message written that needs to occur for the logging runspace to switch to idle mode. </summary> </member> <member name="F:PSFramework.Message.LogHost.LastLogged"> <summary> The time the last message or error were written. </summary> </member> <member name="F:PSFramework.Message.LogHost.LoggingEnabled"> <summary> Whether the logging is enabled at all. Setting this to false will stop and prevent the start of the logging runspace. </summary> </member> <member name="P:PSFramework.Message.LogHost.NextInterval"> <summary> The next interval to use. </summary> </member> <member name="F:PSFramework.Message.LogHost.OutQueueError"> <summary> The outbound queue for errors. These will be processed and written to xml </summary> </member> <member name="F:PSFramework.Message.LogHost.OutQueueLog"> <summary> The outbound queue for logs. These will be processed and written to logfile </summary> </member> <member name="M:PSFramework.Message.LogHost.GetErrors"> <summary> Retrieves a copy of the Error stack </summary> <returns>All errors thrown by functions using the message or flowcontrol system</returns> </member> <member name="M:PSFramework.Message.LogHost.GetLog"> <summary> Retrieves a copy of the message log </summary> <returns>All messages logged this session.</returns> </member> <member name="M:PSFramework.Message.LogHost.ClearLog"> <summary> Clears the current in-memory log </summary> </member> <member name="M:PSFramework.Message.LogHost.WriteErrorEntry(System.Management.Automation.ErrorRecord[],System.String,System.String,System.Collections.Generic.List{System.String},System.DateTime,System.String,System.Guid,System.String)"> <summary> Write an error record to the log </summary> <param name="Record">The actual error record as powershell wrote it</param> <param name="FunctionName">The name of the function writing the error</param> <param name="ModuleName">The name of the module the function writing the error came from</param> <param name="Tags">The tags that were assigned to the error event</param> <param name="Timestamp">When was the error written</param> <param name="Message">What message was passed to the user</param> <param name="Runspace">The runspace the message was written from</param> <param name="ComputerName">The computer the error was written on</param> <returns>The error entry, so it may be included in the message generated</returns> </member> <member name="M:PSFramework.Message.LogHost.WriteLogEntry(System.String,PSFramework.Message.LogEntryType,System.DateTime,System.String,System.String,System.Collections.Generic.List{System.String},System.Collections.Hashtable,PSFramework.Message.MessageLevel,System.Guid,System.String,System.String,System.Int32,System.Collections.Generic.IEnumerable{System.Management.Automation.CallStackFrame},System.String,PSFramework.Message.PsfExceptionRecord,System.Object)"> <summary> Write a new entry to the log </summary> <param name="Message">The message to log</param> <param name="Type">The type of the message logged</param> <param name="Timestamp">When was the message generated</param> <param name="FunctionName">What function wrote the message</param> <param name="ModuleName">What module did the function writing this message come from?</param> <param name="Tags">The tags that were applied to the message</param> <param name="Data">Additional data provided by the message</param> <param name="Level">At what level was the function written</param> <param name="Runspace">The runspace the message is coming from</param> <param name="ComputerName">The computer the message was generated on</param> <param name="File">The file from which the message was written</param> <param name="Line">The line on which the message was written</param> <param name="TargetObject">The object associated with a given message.</param> <param name="CallStack">The callstack at the moment the message was written.</param> <param name="Username">The name of the user under which the code being executed</param> <param name="ErrorRecord">An associated error record</param> <returns>The entry that is being written</returns> </member> <member name="M:PSFramework.Message.LogHost.WriteLogEntry(System.String,PSFramework.Message.LogEntryType,System.DateTime,System.String,System.String,System.Collections.Generic.List{System.String},System.Collections.Hashtable,PSFramework.Message.MessageLevel,System.Guid,System.String,System.String,System.Int32,System.Collections.Generic.IEnumerable{System.Management.Automation.CallStackFrame},System.String,PSFramework.Message.PsfExceptionRecord,System.String,System.Object[],System.Object)"> <summary> Write a new entry to the log </summary> <param name="Message">The message to log</param> <param name="Type">The type of the message logged</param> <param name="Timestamp">When was the message generated</param> <param name="FunctionName">What function wrote the message</param> <param name="ModuleName">What module did the function writing this message come from?</param> <param name="Tags">The tags that were applied to the message</param> <param name="Data">Additional data provided by the message</param> <param name="Level">At what level was the function written</param> <param name="Runspace">The runspace the message is coming from</param> <param name="ComputerName">The computer the message was generated on</param> <param name="File">The file from which the message was written</param> <param name="Line">The line on which the message was written</param> <param name="TargetObject">The object associated with a given message.</param> <param name="CallStack">The callstack at the moment the message was written.</param> <param name="Username">The name of the user under which the code being executed</param> <param name="String">The string key to use for retrieving localized strings</param> <param name="StringValue">The values to format into the localized string</param> <param name="ErrorRecord">An associated error record</param> <returns>The entry that is being written</returns> </member> <member name="T:PSFramework.Message.MessageEventSubscription"> <summary> Condition and logic to be executed on message events </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription.Name"> <summary> Name of the event subscription, must be unique. </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription.ScriptBlock"> <summary> Scriptblock to execute if the condition is met </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription._MessageFilter"> <summary> The internally stored filter value for Message </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.MessageFilter"> <summary> The value the Message is filtered by </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.MessageFilterSet"> <summary> Whether filtering by Message was enabled </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription._ModuleNameFilter"> <summary> The internally stored filter value for ModuleName </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.ModuleNameFilter"> <summary> The value the ModuleName is filtered by </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.ModuleNameFilterSet"> <summary> Whether filtering by ModuleName was enabled </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription._FunctionNameFilter"> <summary> The internally stored filter value for FunctionName </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.FunctionNameFilter"> <summary> The value the FunctionName is filtered by </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.FunctionNameFilterSet"> <summary> Whether filtering by FunctionName was enabled </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription._TargetFilter"> <summary> The internally stored filter value for Target </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.TargetFilter"> <summary> The value the Target is filtered by </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.TargetFilterSet"> <summary> Whether filtering by Target was enabled </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription._LevelFilter"> <summary> The internally stored filter value for Level </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.LevelFilter"> <summary> The value the Level is filtered by </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.LevelFilterSet"> <summary> Whether filtering by Level was enabled </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription._TagFilter"> <summary> The internally stored filter value for Tag </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.TagFilter"> <summary> The value the Tag is filtered by </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.TagFilterSet"> <summary> Whether filtering by Tag was enabled </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription._RunspaceFilter"> <summary> The internally stored filter value for Runspace </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.RunspaceFilter"> <summary> The value the Runspace is filtered by </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.RunspaceFilterSet"> <summary> Whether filtering by Runspace was enabled </summary> </member> <member name="M:PSFramework.Message.MessageEventSubscription.Applies(PSFramework.Message.LogEntry)"> <summary> Checks, whether a given entry matches the filter defined in this subscription </summary> <param name="Entry">The entry to validate</param> <returns>Whether the subscription should react to this entry</returns> </member> <member name="T:PSFramework.Message.MessageHost"> <summary> Provides static resources to the messaging subsystem </summary> </member> <member name="F:PSFramework.Message.MessageHost.MaximumInformation"> <summary> The maximum message level to still display to the user directly. </summary> </member> <member name="F:PSFramework.Message.MessageHost.MaximumVerbose"> <summary> The maxium message level where verbose information is still written. </summary> </member> <member name="F:PSFramework.Message.MessageHost.MaximumDebug"> <summary> The maximum message level where debug information is still written. </summary> </member> <member name="F:PSFramework.Message.MessageHost.MinimumInformation"> <summary> The minimum required message level for messages that will be shown to the user. </summary> </member> <member name="F:PSFramework.Message.MessageHost.MinimumVerbose"> <summary> The minimum required message level where verbose information is written. </summary> </member> <member name="F:PSFramework.Message.MessageHost.MinimumDebug"> <summary> The minimum required message level where debug information is written. </summary> </member> <member name="F:PSFramework.Message.MessageHost.InfoColor"> <summary> The color stuff gets written to the console in </summary> </member> <member name="F:PSFramework.Message.MessageHost.InfoColorEmphasis"> <summary> The color important stuff gets written to the console in </summary> </member> <member name="F:PSFramework.Message.MessageHost.InfoColorSubtle"> <summary> The color background stuff gets written to the console in </summary> </member> <member name="F:PSFramework.Message.MessageHost.DeveloperColor"> <summary> The color stuff gets written to the console in, when developer mode is enabled and the message would not have been written after all </summary> </member> <member name="F:PSFramework.Message.MessageHost.DeveloperMode"> <summary> Enables the developer mode. In this all messages are written to the console, in order to make it easier to troubleshoot issues. </summary> </member> <member name="F:PSFramework.Message.MessageHost.NestedLevelDecrement"> <summary> Message levels can decrease by nested level. This causes messages to have an increasingly reduced level as the size of the callstack increases. </summary> </member> <member name="F:PSFramework.Message.MessageHost.DisableVerbosity"> <summary> Globally override all verbosity </summary> </member> <member name="F:PSFramework.Message.MessageHost.EnableMessageTimestamp"> <summary> Include message timestamps in verbose message output </summary> </member> <member name="F:PSFramework.Message.MessageHost.EnableMessagePrefix"> <summary> Include message prefix in verbose message output </summary> </member> <member name="F:PSFramework.Message.MessageHost.EnableMessageDisplayCommand"> <summary> Include the message display command in the verbose message output </summary> </member> <member name="F:PSFramework.Message.MessageHost.EnableMessageBreadcrumbs"> <summary> Include the entire callstack in the verbose message output </summary> </member> <member name="F:PSFramework.Message.MessageHost.NoColor"> <summary> Whether the console messages should be written with only one color, rather than respecting color tags </summary> </member> <member name="F:PSFramework.Message.MessageHost.PrefixValueError"> <summary> Define the message prefix value for the critical level </summary> </member> <member name="F:PSFramework.Message.MessageHost.PrefixValueWarning"> <summary> Define the message prefix value for the warning level </summary> </member> <member name="F:PSFramework.Message.MessageHost.PrefixValueVerbose"> <summary> Define the message prefix value for the verbose level </summary> </member> <member name="F:PSFramework.Message.MessageHost.PrefixValueHost"> <summary> Define the message prefix value for the host level </summary> </member> <member name="F:PSFramework.Message.MessageHost.PrefixValueSignificant"> <summary> Define the message prefix value for the important level </summary> </member> <member name="F:PSFramework.Message.MessageHost.TransformErrorQueueSize"> <summary> The size of the transform error queue. When adding more than this, the oldest entry will be discarded </summary> </member> <member name="F:PSFramework.Message.MessageHost.ExceptionTransforms"> <summary> Provides the option to transform exceptions based on the original exception type </summary> </member> <member name="F:PSFramework.Message.MessageHost.TargetTransforms"> <summary> Provides the option to transform target objects based on type. This is sometimes important when working with live state objects that should not be serialized. </summary> </member> <member name="F:PSFramework.Message.MessageHost.TransformErrors"> <summary> The list of transformation errors that occured. </summary> </member> <member name="M:PSFramework.Message.MessageHost.GetTransformErrors"> <summary> Returns the current queue of failed transformations </summary> <returns>The list of transformations that failed</returns> </member> <member name="M:PSFramework.Message.MessageHost.WriteTransformError(System.Management.Automation.ErrorRecord,System.String,System.String,System.Object,PSFramework.Message.TransformType,System.Guid)"> <summary> Writes a new transform error </summary> <param name="Record">The record of what went wrong</param> <param name="FunctionName">The name of the function writing the transformed message</param> <param name="ModuleName">The module the function writing the transformed message is part of</param> <param name="Object">The object that should have been transformed</param> <param name="Type">The type of transform that was attempted</param> <param name="Runspace">The runspace it all happened on</param> </member> <member name="F:PSFramework.Message.MessageHost.ExceptionTransformList"> <summary> List of custom transforms for exceptions </summary> </member> <member name="F:PSFramework.Message.MessageHost.TargetTransformlist"> <summary> List of custom transforms for targets </summary> </member> <member name="F:PSFramework.Message.MessageHost.MessageLevelModifiers"> <summary> List of all modifiers that apply to message levels </summary> </member> <member name="F:PSFramework.Message.MessageHost.Events"> <summary> List of events that subscribe to messages being written </summary> </member> <member name="T:PSFramework.Message.MessageLevel"> <summary> The various levels of verbosity available. </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Critical"> <summary> Very important message, should be shown to the user as a high priority </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Important"> <summary> Important message, the user should read this </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Output"> <summary> Important message, the user should read this </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Host"> <summary> Important message, the user should read this </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Significant"> <summary> Message relevant to the user. </summary> </member> <member name="F:PSFramework.Message.MessageLevel.VeryVerbose"> <summary> Not important to the regular user, still of some interest to the curious </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Verbose"> <summary> Background process information, in case the user wants some detailed information on what is currently happening. </summary> </member> <member name="F:PSFramework.Message.MessageLevel.SomewhatVerbose"> <summary> A footnote in current processing, rarely of interest to the user </summary> </member> <member name="F:PSFramework.Message.MessageLevel.System"> <summary> A message of some interest from an internal system persepctive, but largely irrelevant to the user. </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Debug"> <summary> Something only of interest to a debugger </summary> </member> <member name="F:PSFramework.Message.MessageLevel.InternalComment"> <summary> This message barely made the cut from being culled. Of purely development internal interest, and even there is 'interest' a strong word for it. </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Warning"> <summary> This message is a warning, sure sign something went badly wrong </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Error"> <summary> This message is even more of a warning, sure sign something went really, really wrong </summary> </member> <member name="T:PSFramework.Message.MessageLevelModifier"> <summary> A modification to a given message's level </summary> </member> <member name="F:PSFramework.Message.MessageLevelModifier.Name"> <summary> Name of the modifier. Prevents duplication in a multi-runspace scenario. </summary> </member> <member name="F:PSFramework.Message.MessageLevelModifier.Modifier"> <summary> The amount to modify the level by </summary> </member> <member name="F:PSFramework.Message.MessageLevelModifier.IncludeFunctionName"> <summary> Apply modifier only to messages from this function. </summary> </member> <member name="F:PSFramework.Message.MessageLevelModifier.ExcludeFunctionName"> <summary> Apply modifier not when the message is written by this function. </summary> </member> <member name="F:PSFramework.Message.MessageLevelModifier.IncludeModuleName"> <summary> Apply modifier only to messages from this module </summary> </member> <member name="F:PSFramework.Message.MessageLevelModifier.ExcludeModuleName"> <summary> Do not apply modifier to messages from this module </summary> </member> <member name="F:PSFramework.Message.MessageLevelModifier.IncludeTags"> <summary> Only apply this modifier to a message that includes at least one of these tags </summary> </member> <member name="F:PSFramework.Message.MessageLevelModifier.ExcludeTags"> <summary> Do not apply this modifier to a message that includes any of the following tags </summary> </member> <member name="M:PSFramework.Message.MessageLevelModifier.AppliesTo(System.String,System.String,System.Collections.Generic.List{System.String})"> <summary> Tests, whether a message a message should be modified by this modiier </summary> <param name="FunctionName">The name of the function writing the message</param> <param name="ModuleName">The name of the module, the function writing this message comes from</param> <param name="Tags">The tags of the message written</param> <returns>Whether the message applies</returns> </member> <member name="T:PSFramework.Message.PsfException"> <summary> Wrapper class that can emulate any exception for purpose of serialization without blowing up the storage space consumed </summary> </member> <member name="M:PSFramework.Message.PsfException.GetException"> <summary> Returns the original exception object that we interpreted. This is on purpose not a property, as we want to avoid messing with serialization size. </summary> <returns>The original exception that got thrown</returns> </member> <member name="F:PSFramework.Message.PsfException.Message"> <summary> The actual Exception Message </summary> </member> <member name="F:PSFramework.Message.PsfException.Source"> <summary> The original source of the Exception </summary> </member> <member name="F:PSFramework.Message.PsfException.StackTrace"> <summary> Where on the callstack did the exception occur? </summary> </member> <member name="F:PSFramework.Message.PsfException.TargetSite"> <summary> What was the target site on the code that caused it. This property has been altered to avoid export issues, if a string representation is not sufficient, access the original exception using GetException() </summary> </member> <member name="F:PSFramework.Message.PsfException.HResult"> <summary> The HResult of the exception. Useful in debugging native code errors. </summary> </member> <member name="F:PSFramework.Message.PsfException.HelpLink"> <summary> Link to a proper help article. </summary> </member> <member name="F:PSFramework.Message.PsfException.Data"> <summary> Additional data that has been appended </summary> </member> <member name="F:PSFramework.Message.PsfException.InnerException"> <summary> The inner exception in a chain of exceptions. </summary> </member> <member name="F:PSFramework.Message.PsfException.ExceptionTypeName"> <summary> The full namespace name of the exception that has been wrapped. </summary> </member> <member name="F:PSFramework.Message.PsfException.ExceptionData"> <summary> Contains additional properties other exceptions might contain. </summary> </member> <member name="F:PSFramework.Message.PsfException.CategoryInfo"> <summary> The category of the error </summary> </member> <member name="F:PSFramework.Message.PsfException.ErrorDetails"> <summary> The details on the error </summary> </member> <member name="F:PSFramework.Message.PsfException.FullyQualifiedErrorId"> <summary> The specific error identity, used to identify the target </summary> </member> <member name="F:PSFramework.Message.PsfException.InvocationInfo"> <summary> The details of how this was called. </summary> </member> <member name="F:PSFramework.Message.PsfException.ScriptStackTrace"> <summary> The script's stacktrace </summary> </member> <member name="F:PSFramework.Message.PsfException.TargetObject"> <summary> The object being processed </summary> </member> <member name="F:PSFramework.Message.PsfException.FunctionName"> <summary> The name of the function throwing the error </summary> </member> <member name="F:PSFramework.Message.PsfException.Timestamp"> <summary> When was the error thrown </summary> </member> <member name="F:PSFramework.Message.PsfException.Runspace"> <summary> The runspace the error occured on. </summary> </member> <member name="F:PSFramework.Message.PsfException.ComputerName"> <summary> The computer the error occured on. </summary> </member> <member name="M:PSFramework.Message.PsfException.#ctor"> <summary> Creates an empty exception object. Mostly for serialization support </summary> </member> <member name="M:PSFramework.Message.PsfException.#ctor(System.Exception)"> <summary> Creates an exception based on an original exception object </summary> <param name="Except">The exception to wrap around</param> </member> <member name="M:PSFramework.Message.PsfException.#ctor(System.Management.Automation.ErrorRecord)"> <summary> Creates a rich information exception object based on a full error record as recorded by PowerShell </summary> <param name="Record">The error record to copy from</param> </member> <member name="M:PSFramework.Message.PsfException.#ctor(System.Exception,System.String,System.DateTime,System.String,System.Guid,System.String)"> <summary> Creates a new exception object with rich meta information from the PowerShell runtime. </summary> <param name="Except">The exception thrown</param> <param name="FunctionName">The name of the function in which the error occured</param> <param name="Timestamp">When did the error occur</param> <param name="Message">The message to add to the exception</param> <param name="Runspace">The ID of the runspace from which the exception was thrown. Useful in multi-runspace scenarios.</param> <param name="ComputerName">The computer the error occured on.</param> </member> <member name="M:PSFramework.Message.PsfException.#ctor(System.Management.Automation.ErrorRecord,System.String,System.DateTime,System.String,System.Guid,System.String)"> <summary> Creates a new exception object with rich meta information from the PowerShell runtime. </summary> <param name="Record">The error record written</param> <param name="FunctionName">The name of the function in which the error occured</param> <param name="Timestamp">When did the error occur</param> <param name="Message">The message to add to the exception</param> <param name="Runspace">The ID of the runspace from which the exception was thrown. Useful in multi-runspace scenarios.</param> <param name="ComputerName">The computer the error occured on.</param> </member> <member name="M:PSFramework.Message.PsfException.ToString"> <summary> Returns a string representation of the exception. </summary> <returns></returns> </member> <member name="T:PSFramework.Message.PsfExceptionRecord"> <summary> Carrier class, designed to hold an arbitrary number of exceptions. Used for exporting to XML in nice per-incident packages. </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.Runspace"> <summary> Runspace where shit happened. </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.ComputerName"> <summary> The computer name the exception was written on </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.Timestamp"> <summary> When did things go bad? </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.FunctionName"> <summary> Name of the function, where fail happened. </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.ModuleName"> <summary> The module of the function where fail happened </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.Tags"> <summary> The tags that were applied to the failure </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.Message"> <summary> The message the poor user was shown. </summary> </member> <member name="P:PSFramework.Message.PsfExceptionRecord.ExceptionType"> <summary> Displays the name of the exception, the make scanning exceptions easier. </summary> </member> <member name="P:PSFramework.Message.PsfExceptionRecord.TargetObject"> <summary> The target object of the first exception in the list, if any </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.Exceptions"> <summary> List of Exceptions that are part of the incident (usually - but not always - only one). </summary> </member> <member name="M:PSFramework.Message.PsfExceptionRecord.ToString"> <summary> The default string display of this message </summary> <returns>The message text of the exception</returns> </member> <member name="M:PSFramework.Message.PsfExceptionRecord.#ctor"> <summary> Creates an empty container. Ideal for the homeworker who loves doing it all himself. </summary> </member> <member name="M:PSFramework.Message.PsfExceptionRecord.#ctor(PSFramework.Message.PsfException)"> <summary> Creates a container filled with the first exception. </summary> <param name="Exception"></param> </member> <member name="M:PSFramework.Message.PsfExceptionRecord.#ctor(System.Guid,System.String,System.DateTime,System.String,System.String,System.Collections.Generic.List{System.String},System.String)"> <summary> Creates a container filled with the meta information but untouched by exceptions </summary> <param name="Runspace">The runspace where it all happened</param> <param name="ComputerName">The computer the error was recorded</param> <param name="Timestamp">When did it happen?</param> <param name="FunctionName">Where did it happen?</param> <param name="ModuleName">The name of the module where fail happened</param> <param name="Tags">The tags that were assigned to the failure</param> <param name="Message">What did the witness have to say?</param> </member> <member name="T:PSFramework.Message.TransformCondition"> <summary> A condition, under which the object shall be transaformed </summary> </member> <member name="F:PSFramework.Message.TransformCondition.TypeName"> <summary> Name of the type. All similar types (as determined by the '-like' operator) will be transformed. </summary> </member> <member name="F:PSFramework.Message.TransformCondition.ModuleName"> <summary> The name of the module to consider, using the -Like operator </summary> </member> <member name="F:PSFramework.Message.TransformCondition.FunctionName"> <summary> The name of the function name to consider, using the -Like operator </summary> </member> <member name="F:PSFramework.Message.TransformCondition.ScriptBlock"> <summary> The scriptblock that performs the transformation </summary> </member> <member name="F:PSFramework.Message.TransformCondition.Type"> <summary> What kind of transformation is being performed? </summary> </member> <member name="M:PSFramework.Message.TransformCondition.#ctor(System.String,System.String,System.String,System.Management.Automation.ScriptBlock,PSFramework.Message.TransformType)"> <summary> Initializes a transform condition </summary> <param name="TypeName">Only objects of similar name will be transformed</param> <param name="ModuleName">Only objects coming from similar modules will be considered</param> <param name="FunctionName">Only objects coming from similar functions will be considered</param> <param name="ScriptBlock">The scriptblock used for the transformation</param> <param name="Type">What kind of transformation this is</param> </member> <member name="T:PSFramework.Message.TransformError"> <summary> An error occured during a message transformation </summary> </member> <member name="F:PSFramework.Message.TransformError.Record"> <summary> The error record of what went wrong </summary> </member> <member name="F:PSFramework.Message.TransformError.FunctionName"> <summary> The name of the function writing the message that failed to transform </summary> </member> <member name="F:PSFramework.Message.TransformError.ModuleName"> <summary> The name of the module the command writing the message came from </summary> </member> <member name="F:PSFramework.Message.TransformError.Timestamp"> <summary> When did it all happen? </summary> </member> <member name="F:PSFramework.Message.TransformError.Object"> <summary> The object that was supposed to be transformed </summary> </member> <member name="F:PSFramework.Message.TransformError.Type"> <summary> The kind of transform that failed </summary> </member> <member name="F:PSFramework.Message.TransformError.Runspace"> <summary> The runspace it all happened on </summary> </member> <member name="M:PSFramework.Message.TransformError.#ctor(System.Management.Automation.ErrorRecord,System.String,System.String,System.Object,PSFramework.Message.TransformType,System.Guid)"> <summary> Creates a new transform error </summary> <param name="Record">The record of what went wrong</param> <param name="FunctionName">The name of the function writing the transformed message</param> <param name="ModuleName">The module the function writing the transformed message is part of</param> <param name="Object">The object that should have been transformed</param> <param name="Type">The type of transform that was attempted</param> <param name="Runspace">The runspace it all happened on</param> </member> <member name="T:PSFramework.Message.TransformList"> <summary> List engine, managing the lists for a message transformation type </summary> </member> <member name="M:PSFramework.Message.TransformList.GetAll"> <summary> Returns all entries in the list. </summary> <returns>The list of transforms contained within</returns> </member> <member name="M:PSFramework.Message.TransformList.IsListed(PSFramework.Message.TransformCondition)"> <summary> Returns whether the actual object is part of the list </summary> <param name="Condition">The object to test for list membership</param> <returns>Whether the object is listed</returns> </member> <member name="M:PSFramework.Message.TransformList.IsContained(PSFramework.Message.TransformCondition)"> <summary> Returns whether a condition with equal conditions already exists </summary> <param name="Condition">The condition to test</param> <returns>Whether the referenced condition is already listed</returns> </member> <member name="M:PSFramework.Message.TransformList.Add(PSFramework.Message.TransformCondition)"> <summary> Adds a condition to the list, if there is no equivalent condition present. </summary> <param name="Condition">The condition to add</param> </member> <member name="M:PSFramework.Message.TransformList.Remove(PSFramework.Message.TransformCondition)"> <summary> Removes a condition from the lsit of conditional transforms </summary> <param name="Condition">The condition to remove</param> </member> <member name="M:PSFramework.Message.TransformList.Get(System.String,System.String,System.String)"> <summary> Returns the first transform whose filter is similar enough to work out. </summary> <param name="TypeName">The name of the type to check for a transform</param> <param name="ModuleName">The module of the command that wrote the message with the transformable object</param> <param name="Functionname">The command that wrote the message with the transformable object</param> <returns>Either a transform or null, if no fitting transform was found</returns> </member> <member name="T:PSFramework.Message.TransformType"> <summary> The messaging system provides these kinds of transformations for input. </summary> </member> <member name="F:PSFramework.Message.TransformType.Target"> <summary> A target transform can transform the target object specified. Used for live-state objects that should not be serialized on a second thread. </summary> </member> <member name="F:PSFramework.Message.TransformType.Exception"> <summary> An exception transform allows automatic transformation of exceptions. Primarily used to unwrap exceptions from an API that wraps all exceptions. </summary> </member> <member name="T:PSFramework.Meta.CallerInfo"> <summary> Helper Class parsing CallStackInfo into something usable </summary> </member> <member name="F:PSFramework.Meta.CallerInfo.CallerFunction"> <summary> The name of the function in the callstackframe </summary> </member> <member name="F:PSFramework.Meta.CallerInfo.CallerModule"> <summary> The name of the module the function in the callstackframe is part of </summary> </member> <member name="F:PSFramework.Meta.CallerInfo.CallerFile"> <summary> The file this was called from </summary> </member> <member name="F:PSFramework.Meta.CallerInfo.CallerLine"> <summary> The line in the file this was called from </summary> </member> <member name="M:PSFramework.Meta.CallerInfo.#ctor(System.Management.Automation.CallStackFrame)"> <summary> Constructs the detailed information needed from a CallStackFrame </summary> <param name="Frame">The frame to parse</param> </member> <member name="M:PSFramework.Meta.CallerInfo.GetCaller(System.Int32)"> <summary> Returns the caller CallStackFrame item </summary> <param name="Level">How many levels to peek into the callstack</param> <returns>Returns the caller CallStackFrame item</returns> </member> <member name="T:PSFramework.Meta.PipelineCommand"> <summary> Information object for a command on the pipeline </summary> </member> <member name="F:PSFramework.Meta.PipelineCommand.PipelineId"> <summary> ID of the pipeline the command was read from </summary> </member> <member name="F:PSFramework.Meta.PipelineCommand.Index"> <summary> Index of the command within the pipeline </summary> </member> <member name="F:PSFramework.Meta.PipelineCommand.Command"> <summary> Information on the command itself </summary> </member> <member name="P:PSFramework.Meta.PipelineCommand.InvocationName"> <summary> Under what name was the command called? </summary> </member> <member name="F:PSFramework.Meta.PipelineCommand.InvocationInfo"> <summary> The full invocation information </summary> </member> <member name="P:PSFramework.Meta.PipelineCommand.BoundParameters"> <summary> The parameters that were bound to the command </summary> </member> <member name="F:PSFramework.Meta.PipelineCommand.CommandItem"> <summary> The actual PowerShell internal object representing the command on the pipeline </summary> </member> <member name="M:PSFramework.Meta.PipelineCommand.IsCommand(System.Management.Automation.PSCmdlet)"> <summary> Tests whether the specified cmdlet variable is the same instance of its class as this one. </summary> <param name="CmdletItem">The cmdlet to compare</param> <returns>Whether the specified cmdlet is the same instance as this one</returns> </member> <member name="M:PSFramework.Meta.PipelineCommand.#ctor(System.Int32,System.Int32,System.Management.Automation.CommandInfo,System.Management.Automation.InvocationInfo,System.Object)"> <summary> Create a new pipelinecommand object </summary> <param name="PipelineId">ID of the pipeline the command was read from</param> <param name="Index">Index of the command within the pipeline</param> <param name="Command">Information on the command itself</param> <param name="InvocationInfo">The full invocation information</param> <param name="CommandItem">The actual PowerShell internal object representing the command on the pipeline</param> </member> <member name="T:PSFramework.Meta.Pipeline"> <summary> Object representing a pipeline at runtime </summary> </member> <member name="F:PSFramework.Meta.Pipeline.InstanceId"> <summary> The unique ID of the pipeline </summary> </member> <member name="F:PSFramework.Meta.Pipeline.StartTime"> <summary> When the pipeline was created </summary> </member> <member name="F:PSFramework.Meta.Pipeline.Commands"> <summary> The commands that make up the pipeline </summary> </member> <member name="F:PSFramework.Meta.Pipeline.Text"> <summary> The full text of the pipeline </summary> </member> <member name="F:PSFramework.Meta.Pipeline.Ast"> <summary> The Ast of the pipeline </summary> </member> <member name="F:PSFramework.Meta.Pipeline.OutputAssigned"> <summary> Whether the output is getting assigned to something </summary> </member> <member name="F:PSFramework.Meta.Pipeline.OutputAssignedTo"> <summary> What the output gets assigned to </summary> </member> <member name="F:PSFramework.Meta.Pipeline.InputFromVariable"> <summary> Does the pipeline receive input from a variable? </summary> </member> <member name="F:PSFramework.Meta.Pipeline.InputVariable"> <summary> What variable does the pipeline receive input from </summary> </member> <member name="F:PSFramework.Meta.Pipeline.InputDirect"> <summary> Does the pipeline receive a constant as input value directly? </summary> </member> <member name="F:PSFramework.Meta.Pipeline.InputValue"> <summary> What is the value it receives? </summary> </member> <member name="F:PSFramework.Meta.Pipeline.PipelineItem"> <summary> The actual PowerShell internal pipeline object </summary> </member> <member name="T:PSFramework.Parameter.ComputerParameter"> <summary> Parameter class that converts various input into a unified input representation </summary> </member> <member name="P:PSFramework.Parameter.ComputerParameter.ComputerName"> <summary> The resolved computername </summary> </member> <member name="P:PSFramework.Parameter.ComputerParameter.IsLocalhost"> <summary> Whether the computername is actually localhost or one of its equivalents </summary> </member> <member name="F:PSFramework.Parameter.ComputerParameter.Type"> <summary> What kind of object was passed. This makes it easier to detect and reuse specific kinds of live object in circumstances where that is desirable. </summary> </member> <member name="M:PSFramework.Parameter.ComputerParameter.op_Implicit(PSFramework.Parameter.ComputerParameter)~System.String"> <summary> Implicitly converts the parameter class to string </summary> <param name="Parameter">The parameter to convert</param> </member> <member name="M:PSFramework.Parameter.ComputerParameter.ToString"> <summary> Overrides the default ToString() method </summary> <returns></returns> </member> <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(System.String)"> <summary> Generates a Computer Parameter object from string </summary> <param name="ComputerName">The name to use as input</param> </member> <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(System.Net.IPAddress)"> <summary> Creates a Computer Parameter from an IPAddress </summary> <param name="Address"></param> </member> <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(System.Management.Automation.Runspaces.PSSession)"> <summary> Creates a Computer Parameter from a PSSession </summary> <param name="Session">The session to use</param> </member> <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(PSFramework.ComputerManagement.SessionContainer)"> <summary> Creates a Computer Parameter from a Session Container object. </summary> <param name="Container">A container that can be used to store multiple types of session objects in parallel.</param> </member> <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(PSFramework.ComputerManagement.PSSessionInfo)"> <summary> Creates a Computer Parameter from a PSSessionInfo object. Shouldn't happen in the wild, but still a legal inmput. </summary> <param name="SessionInfo">The session information object to interpret</param> </member> <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(Microsoft.Management.Infrastructure.CimSession)"> <summary> Creates a Computer Parameter from a CimSession </summary> <param name="Session">The session to create the parameter from</param> </member> <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(System.Net.NetworkInformation.PingReply)"> <summary> Creates a Computer Parameter from the reply to a ping </summary> <param name="Ping">The result of a ping</param> </member> <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(System.Net.IPHostEntry)"> <summary> Creates a Computer Parameter from the result of a dns resolution </summary> <param name="Entry">The result of a dns resolution</param> </member> <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(System.Data.SqlClient.SqlConnection)"> <summary> Creates a Computer Parameter from an established SQL Connection </summary> <param name="Connection">The connection to use</param> </member> <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(System.Object)"> <summary> Generates a Computer Parameter object from anything </summary> <param name="InputObject"></param> </member> <member name="T:PSFramework.Parameter.ComputerParameterInputType"> <summary> The kind of object that was bound to the parameter class </summary> </member> <member name="F:PSFramework.Parameter.ComputerParameterInputType.Default"> <summary> The input object is just any non-special kind of input. </summary> </member> <member name="F:PSFramework.Parameter.ComputerParameterInputType.PSSession"> <summary> The input object is a PowerShell Session object </summary> </member> <member name="F:PSFramework.Parameter.ComputerParameterInputType.SMOServer"> <summary> The input object is a live SMO Server object </summary> </member> <member name="F:PSFramework.Parameter.ComputerParameterInputType.CimSession"> <summary> The input object is a live cim session object </summary> </member> <member name="F:PSFramework.Parameter.ComputerParameterInputType.Container"> <summary> The input object is a session container object, potentially containing live session objects of various types at the same time. </summary> </member> <member name="T:PSFramework.Parameter.DateTimeParameter"> <summary> Parameter class for interpreting timespans </summary> </member> <member name="F:PSFramework.Parameter.DateTimeParameter.Value"> <summary> The resolved datetime value </summary> </member> <member name="M:PSFramework.Parameter.DateTimeParameter.ToString"> <summary> The string value of the datetime object contained within. </summary> <returns>The string value of the datetime object contained within.</returns> </member> <member name="M:PSFramework.Parameter.DateTimeParameter.op_Implicit(PSFramework.Parameter.DateTimeParameter)~System.DateTime"> <summary> Implicitly converts the parameter to datetime, allowing it to be used on parameters requiring the type </summary> <param name="Parameter">The parameterclass object to convert</param> </member> <member name="M:PSFramework.Parameter.DateTimeParameter.op_Implicit(System.DateTime)~PSFramework.Parameter.DateTimeParameter"> <summary> Implicitly converts a datetime to this parameterclass object. </summary> <param name="Value">The timespan object to convert</param> </member> <member name="M:PSFramework.Parameter.DateTimeParameter.#ctor(System.DateTime)"> <summary> Creates a DateTimeParameter from a DateTime object (not the hardest challenge) </summary> <param name="Value">The timespan object to accept</param> </member> <member name="M:PSFramework.Parameter.DateTimeParameter.#ctor(System.Int32)"> <summary> Creates a DateTimeParameter with a DateTime value in seconds relative to the specifiewd number. </summary> <param name="Seconds">The seconds to differ from the current time.</param> </member> <member name="M:PSFramework.Parameter.DateTimeParameter.#ctor(System.String)"> <summary> Creates a TimeSpanParameter from a string object </summary> <param name="Value">The string to interpret</param> </member> <member name="M:PSFramework.Parameter.DateTimeParameter.#ctor(System.Object)"> <summary> Creates a TimeSpanParameter from any kind of object it has been taught to understand </summary> <param name="InputObject">The object to interpret</param> </member> <member name="M:PSFramework.Parameter.DateTimeParameter.ParseDateTime(System.String)"> <summary> Parses an input string as timespan </summary> <param name="Value">The string to interpret</param> <returns>The interpreted timespan value</returns> </member> <member name="T:PSFramework.Parameter.EncodingParameter"> <summary> Class that interprets input as an encoding </summary> </member> <member name="F:PSFramework.Parameter.EncodingParameter.Encoding"> <summary> The parsed encoding to use. </summary> </member> <member name="M:PSFramework.Parameter.EncodingParameter.op_Implicit(PSFramework.Parameter.EncodingParameter)~System.Text.Encoding"> <summary> Implicitly convert the value to an encoding object </summary> <param name="Parameter">The parameterclass object to convert</param> </member> <member name="M:PSFramework.Parameter.EncodingParameter.op_Implicit(System.Text.Encoding)~PSFramework.Parameter.EncodingParameter"> <summary> Implicitly convert encoding to the parameterclass by calling the correct constructor </summary> <param name="Encoding">The encoding to encapsule</param> </member> <member name="M:PSFramework.Parameter.EncodingParameter.#ctor(System.Text.Encoding)"> <summary> Encapsule an encoding object in the parameter class </summary> <param name="Encoding">The encoding to wrap</param> </member> <member name="M:PSFramework.Parameter.EncodingParameter.#ctor(System.String)"> <summary> Converts a string value to encoding </summary> <param name="EncodingString">A string value to interpret as encoding.</param> </member> <member name="M:PSFramework.Parameter.EncodingParameter.#ctor(System.Object)"> <summary> Convert just about anything to encoding if registered. </summary> <param name="InputObject">The object to convert</param> </member> <member name="M:PSFramework.Parameter.EncodingParameter.GetEncoding(System.String)"> <summary> Returns the correct encoding for a given string </summary> <param name="Text">The string to convert to encoding</param> <returns>The encoding to retrieve.</returns> </member> <member name="M:PSFramework.Parameter.EncodingParameter.GetEncodingString(System.Text.Encoding)"> <summary> Returns the user-expected string from the specified encoding. "Expected" in the context of PowerShell usage. </summary> <param name="EncodingItem">The item to convert to string</param> <returns>The powershell string representation</returns> </member> <member name="M:PSFramework.Parameter.EncodingParameter.ToString"> <summary> String representation of the parameter class </summary> <returns>The returned encoding string</returns> </member> <member name="M:PSFramework.Parameter.EncodingParameter.IsUTF8BOM(System.Text.Encoding)"> <summary> Accepts a UTF8 encoding and returns, whether it includes writing a ByteOrderMark </summary> <param name="Encoding">The encoding object to interpret</param> <returns>Whether it is with BOM or without</returns> </member> <member name="T:PSFramework.Parameter.ParameterClass"> <summary> Base class of all parameter classes </summary> </member> <member name="F:PSFramework.Parameter.ParameterClass.InputObject"> <summary> The original item presented as input </summary> </member> <member name="F:PSFramework.Parameter.ParameterClass._PropertyMapping"> <summary> Contains the list of property mappings. Types can be registered to it, allowing the parameter class to blindly interpret unknown types </summary> </member> <member name="M:PSFramework.Parameter.ParameterClass.SetTypePropertyMapping(System.String,System.Collections.Generic.List{System.String})"> <summary> Assigns a property mapping for a given type, allowing the parameter class to handle unknown types </summary> <param name="Name">The name of the type. Use the FullName of the type</param> <param name="PropertyName">The property names to register. When parsing input, it will move down this list until a valid property was found</param> </member> <member name="M:PSFramework.Parameter.ParameterClass.ToString"> <summary> Returns the string representation of the parameter. Should be overridden by inheriting classes. </summary> <returns>The string representation of the object</returns> </member> <member name="T:PSFramework.Parameter.ParameterClassAttribute"> <summary> Attribute marking a class </summary> </member> <member name="T:PSFramework.Parameter.ParameterClasses"> <summary> List of available parameter classes </summary> </member> <member name="F:PSFramework.Parameter.ParameterClasses.Computer"> <summary> The computer parameter class allows easily targeting a computer </summary> </member> <member name="F:PSFramework.Parameter.ParameterClasses.DateTime"> <summary> The datetime parameter class allows for an easy way to specify a datetime </summary> </member> <member name="F:PSFramework.Parameter.ParameterClasses.TimeSpan"> <summary> The timespan parameter class allows for an easy way to specify a timespan </summary> </member> <member name="F:PSFramework.Parameter.ParameterClasses.Encoding"> <summary> The encoing parameter class allows to consistently accept encodings as input. </summary> </member> <member name="T:PSFramework.Parameter.ParameterContractAttribute"> <summary> The attribute used to define the elements of a ParameterClass contract </summary> </member> <member name="P:PSFramework.Parameter.ParameterContractAttribute.Type"> <summary> Returns the type of the element this attribute is supposed to be attached to. </summary> </member> <member name="P:PSFramework.Parameter.ParameterContractAttribute.Behavior"> <summary> Returns the behavior to expect from the contracted element. This sets the expectations on how this element is likely to act. </summary> </member> <member name="M:PSFramework.Parameter.ParameterContractAttribute.#ctor(PSFramework.Parameter.ParameterContractType,PSFramework.Parameter.ParameterContractBehavior)"> <summary> Ceates a perfectly common parameter contract attribute. For use with all parameter classes' public elements. </summary> <param name="Type"></param> <param name="Behavior"></param> </member> <member name="T:PSFramework.Parameter.ParameterContractBehavior"> <summary> Defines how this element will behave </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractBehavior.NotContracted"> <summary> This elements is not actually part of the contract. Generally you wouldn't want to add the attribute at all in that case. However, in some places it helps avoiding confusion. </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractBehavior.Mandatory"> <summary> This element may never be null and must be considered in all assignments. Even if the element is de facto not nullable, all constructors must assign it. </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractBehavior.Optional"> <summary> This element may contain data, but is not required to. In case of a method, it may simply do nothing </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractBehavior.Failable"> <summary> This method may throw an error when executing and should always be handled with try/catch. Use this on methods that use external calls. </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractBehavior.Arbiter"> <summary> The content of the thus marked field determines the dependent's state. Generally, only if the arbiter is true, will the dependent elements be mandatory. This behavior may only be assigned to boolean fields. </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractBehavior.Conditional"> <summary> This behavior can be assigned together with the 'Mandatory' behavior. It means the field is only mandatory if an arbiter field is present and set to true. </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractBehavior.Conversion"> <summary> Converts content. Generally applied only to operators, but some methods may also convert information. </summary> </member> <member name="T:PSFramework.Parameter.ParameterContractType"> <summary> Defines what kind of element is granted the contract </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractType.Field"> <summary> The contracted element is a field containing a value </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractType.Method"> <summary> The contracted element is a method, performing an action </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractType.Operator"> <summary> The contracted element is an operator, facilitating type conversion. Generally into a dedicated object type this parameterclass abstracts. </summary> </member> <member name="T:PSFramework.Parameter.SelectAliasParameter"> <summary> A parameter class for binding specific alias property mappings </summary> </member> <member name="F:PSFramework.Parameter.SelectAliasParameter.Value"> <summary> The aliases to map </summary> </member> <member name="P:PSFramework.Parameter.SelectAliasParameter.Aliases"> <summary> The alias objects to use. Will be cached on first retrieval </summary> </member> <member name="M:PSFramework.Parameter.SelectAliasParameter.#ctor(System.Collections.Hashtable)"> <summary> Convert hashtables to alias properties </summary> <param name="Hashtable">A hashtable mapping alias name to reference property</param> </member> <member name="M:PSFramework.Parameter.SelectAliasParameter.#ctor(System.String)"> <summary> Parses a string input into one or multiple alias expressions. </summary> <param name="StringValue">the string to parse</param> </member> <member name="M:PSFramework.Parameter.SelectAliasParameter.ToString"> <summary> Builds the string display of the parameter class </summary> <returns>The string representation of the aliases to create</returns> </member> <member name="T:PSFramework.Parameter.SelectParameter"> <summary> Class that automatically parses input chosen for the -Property parameter of Select-PSUObject </summary> </member> <member name="F:PSFramework.Parameter.SelectParameter.Value"> <summary> The value as Select-Object wants it </summary> </member> <member name="M:PSFramework.Parameter.SelectParameter.#ctor(System.String)"> <summary> Builds a property parameter from string </summary> <param name="Value">The string to interpret</param> </member> <member name="M:PSFramework.Parameter.SelectParameter.#ctor(System.Collections.Hashtable)"> <summary> Builds a select parameter from a hashtable (pretty straightforward) </summary> <param name="Hash">The hashtable to accept</param> </member> <member name="M:PSFramework.Parameter.SelectParameter.ToString"> <summary> The default string representation of the wrapped object </summary> <returns>The string representation of the wrapped object</returns> </member> <member name="T:PSFramework.Parameter.SelectScriptMethodParameter"> <summary> Parameter class parsing various inputs for scriptmethod properties </summary> </member> <member name="F:PSFramework.Parameter.SelectScriptMethodParameter.Value"> <summary> The name to script mappings that make up the script properties or methods </summary> </member> <member name="P:PSFramework.Parameter.SelectScriptMethodParameter.Methods"> <summary> Retrieve a list of script methods. Results will be automatically cached on first retrieval </summary> </member> <member name="M:PSFramework.Parameter.SelectScriptMethodParameter.#ctor(System.Collections.Hashtable)"> <summary> Convert hashtables to scriptmethod properties </summary> <param name="Hashtable">A hashtable mapping name to scriptblock</param> </member> <member name="M:PSFramework.Parameter.SelectScriptMethodParameter.#ctor(System.String)"> <summary> Parses a string input into one or multiple alias expressions. </summary> <param name="StringValue">the string to parse</param> </member> <member name="M:PSFramework.Parameter.SelectScriptMethodParameter.#ctor(System.Management.Automation.ScriptBlock)"> <summary> Create a script method from a scriptblock. Scriptblock is processed as string! </summary> <param name="ScriptBlock">The scriptblock to evaluate</param> </member> <member name="M:PSFramework.Parameter.SelectScriptMethodParameter.#ctor(System.Management.Automation.PSScriptMethod)"> <summary> Create a scriptmethod from ... a scriptmethod! </summary> <param name="Method">The scriptmethod to integrate</param> </member> <member name="M:PSFramework.Parameter.SelectScriptMethodParameter.ToString"> <summary> Returnd the string representation of the scriptmethod </summary> <returns></returns> </member> <member name="T:PSFramework.Parameter.SelectScriptPropertyParameter"> <summary> Parameter class that handles script property input </summary> </member> <member name="F:PSFramework.Parameter.SelectScriptPropertyParameter.Value"> <summary> The actual properties </summary> </member> <member name="M:PSFramework.Parameter.SelectScriptPropertyParameter.#ctor(System.Management.Automation.PSScriptProperty)"> <summary> Create a script property from a script property </summary> <param name="Property">The property to add</param> </member> <member name="M:PSFramework.Parameter.SelectScriptPropertyParameter.#ctor(System.String)"> <summary> Create a script property from a string </summary> <param name="StringValue">The string to interpret into a scriptproperty</param> </member> <member name="M:PSFramework.Parameter.SelectScriptPropertyParameter.#ctor(System.Management.Automation.ScriptBlock)"> <summary> Create a script property from a scriptblock. Scriptblock is processed as string! </summary> <param name="ScriptBlock">The scriptblock to evaluate</param> </member> <member name="M:PSFramework.Parameter.SelectScriptPropertyParameter.#ctor(System.Collections.Hashtable)"> <summary> Create one or multiple script properties from hashtable </summary> <param name="Hashtable">The hashtable to build from</param> </member> <member name="M:PSFramework.Parameter.SelectScriptPropertyParameter.ToString"> <summary> Print things to string </summary> <returns>The string representation of these properties</returns> </member> <member name="T:PSFramework.Parameter.SortParameter"> <summary> Input parser for wrapping around Sort-Object </summary> </member> <member name="F:PSFramework.Parameter.SortParameter.Value"> <summary> The value passed to Sort-Object </summary> </member> <member name="M:PSFramework.Parameter.SortParameter.#ctor(System.String)"> <summary> Parse Input strings </summary> <param name="Property">The string to parse as property to sort by</param> </member> <member name="M:PSFramework.Parameter.SortParameter.#ctor(System.Object)"> <summary> Any other input is passed straight through </summary> <param name="InputObject">The input object to pass through</param> </member> <member name="M:PSFramework.Parameter.SortParameter.ToString"> <summary> Returns the string representation of the resultant sort property </summary> <returns>Some text</returns> </member> <member name="T:PSFramework.Parameter.TimeSpanParameter"> <summary> Parameter class for interpreting timespans </summary> </member> <member name="F:PSFramework.Parameter.TimeSpanParameter.Value"> <summary> The resolved timespan value </summary> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.ToString"> <summary> The string value of the timespan object contained within. </summary> <returns>The string value of the timespan object contained within.</returns> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.op_Implicit(PSFramework.Parameter.TimeSpanParameter)~System.TimeSpan"> <summary> Implicitly converts the parameter to timespan, allowing it to be used on parameters requiring the type </summary> <param name="Parameter">The parameterclass object to convert</param> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.op_Implicit(System.TimeSpan)~PSFramework.Parameter.TimeSpanParameter"> <summary> Implicitly converts a timespan to this parameterclass object. </summary> <param name="Value">The timespan object to convert</param> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.#ctor(System.TimeSpan)"> <summary> Creates a TimeSpanParameter from a TimeSpan object (not the hardest challenge) </summary> <param name="Value">The timespan object to accept</param> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.#ctor(System.Int32)"> <summary> Creates a TimeSpanParameter from integer, assuming it to mean seconds </summary> <param name="Seconds">The seconds to run</param> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.#ctor(System.String)"> <summary> Creates a TimeSpanParameter from a string object </summary> <param name="Value">The string to interpret</param> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.#ctor(System.Object)"> <summary> Creates a TimeSpanParameter from any kind of object it has been taught to understand </summary> <param name="InputObject">The object to interpret</param> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.ParseTimeSpan(System.String)"> <summary> Parses an input string as timespan </summary> <param name="Value">The string to interpret</param> <returns>The interpreted timespan value</returns> </member> <member name="T:PSFramework.PSFCore.DebugData"> <summary> Debug data container </summary> </member> <member name="F:PSFramework.PSFCore.DebugData.Timestamp"> <summary> TImestamp the data was created at </summary> </member> <member name="F:PSFramework.PSFCore.DebugData.Label"> <summary> Label for the data written </summary> </member> <member name="F:PSFramework.PSFCore.DebugData.Data"> <summary> Data submitted by the writer </summary> </member> <member name="F:PSFramework.PSFCore.DebugData.ScriptCallstack"> <summary> Callstack at the moment of the call </summary> </member> <member name="F:PSFramework.PSFCore.DebugData.Runspace"> <summary> Runspace the message was written from </summary> </member> <member name="M:PSFramework.PSFCore.DebugData.#ctor(System.String,System.Object)"> <summary> Create debug information for troubleshooting purposes </summary> <param name="Data">The data to write</param> <param name="Label">A label to store with the data to better track its origin</param> </member> <member name="T:PSFramework.PSFCore.NoJeaCommandAttribute"> <summary> Decorator attribute declaring a command in its entirety unsafe for making publicly available in JEA </summary> </member> <member name="T:PSFramework.PSFCore.NoJeaParameterAttribute"> <summary> The thus tagged parameter is not safe to publish with JEA </summary> </member> <member name="T:PSFramework.PSFCore.PSFCoreHost"> <summary> Class containing static settings and values used to globally handle things </summary> </member> <member name="F:PSFramework.PSFCore.PSFCoreHost.Unattended"> <summary> Whether the current console is in unattended mode </summary> </member> <member name="P:PSFramework.PSFCore.PSFCoreHost.ModuleRoot"> <summary> The path to where the module was imported from </summary> </member> <member name="M:PSFramework.PSFCore.PSFCoreHost.Initialize"> <summary> Initializes the PSFramework library. Required for some components to work correctly. </summary> </member> <member name="M:PSFramework.PSFCore.PSFCoreHost.Uninitialize"> <summary> Reverses the initialization of the PSFramework library. Should be called when destroying the main runspace </summary> </member> <member name="P:PSFramework.PSFCore.PSFCoreHost.DebugMode"> <summary> The master switch to enable debug mode. </summary> </member> <member name="F:PSFramework.PSFCore.PSFCoreHost.VerboseDebug"> <summary> Whether to write debug messages to the screen </summary> </member> <member name="P:PSFramework.PSFCore.PSFCoreHost.DebugQueueSize"> <summary> The total capacity of the debug queue </summary> </member> <member name="M:PSFramework.PSFCore.PSFCoreHost.WriteDebug(System.String,System.Object)"> <summary> Write a debug message </summary> <param name="Label">The label to apply to the data</param> <param name="Data">The data to write</param> </member> <member name="F:PSFramework.PSFCore.PSFCoreHost.DebugData"> <summary> The data storage containing the debug messages. </summary> </member> <member name="P:PSFramework.PSFCore.PSFCoreHost.PSVersion"> <summary> Reliably access the PowerShell Version </summary> </member> <member name="T:PSFramework.PSFCore.PsfInternalAttribute"> <summary> Attribute designating something as reserved as PSFramework-internal. Changes to any component marked thus is not considered a breaking change. </summary> </member> <member name="F:PSFramework.PSFCore.PsfInternalAttribute.Description"> <summary> Allows specifying a description or comments along with the attribute. </summary> </member> <member name="T:PSFramework.Extension.ScriptBlockExt"> <summary> Class that extends the scriptblock type </summary> </member> <member name="M:PSFramework.Extension.ScriptBlockExt.DoInvokeReturnAsIs(System.Management.Automation.ScriptBlock,System.Boolean,System.Int32,System.Object,System.Object,System.Object,System.Object[])"> <summary> Implements the internal copy of DoInvokeReturnAsIs </summary> <param name="ScriptBlock">The scriptblock to execute</param> <param name="UseLocalScope">Whether a new scope should be created for this</param> <param name="ErrorHandlingBehavior">How to handle errors. 2 should be the default</param> <param name="DollerUnder">The value to make available as $_</param> <param name="Input">The value to make available to $input</param> <param name="ScriptThis">The value to make available as $this</param> <param name="Args">The value to make available as $args</param> <returns>Whatever output this scriptblock generates</returns> </member> <member name="M:PSFramework.Extension.ScriptBlockExt.Clone(System.Management.Automation.ScriptBlock)"> <summary> Clones the specified scriptblock maintaining its language mode. </summary> <param name="ScriptBlock">The Scriptblock to clone</param> <returns>A clone of the scriptblock with the languagemode intact</returns> </member> <member name="M:PSFramework.Extension.ScriptBlockExt.ToGlobal(System.Management.Automation.ScriptBlock)"> <summary> Resets the current scriptblock's sessionstate to the current runspace's global sessionstate. </summary> <param name="ScriptBlock">The scriptblock to globalize</param> <returns>The globalized scriptblock</returns> </member> <member name="M:PSFramework.Extension.ScriptBlockExt.ToLocal(System.Management.Automation.ScriptBlock)"> <summary> Resets the current scriptblock's sessionstate to the current runspace's current sessionstate. </summary> <param name="ScriptBlock">The scriptblock to import</param> <returns>The imported scriptblock</returns> </member> <member name="M:PSFramework.Extension.ScriptBlockExt.Import(System.Management.Automation.ScriptBlock,System.Boolean)"> <summary> Resets the current scriptblock's sessionstate to either the current runspace's current sessionstate or its global sessionstate. </summary> <param name="ScriptBlock">The scriptblock to import</param> <param name="Global">Whether to import into the global sessionstate</param> <returns>The imported ScriptBlock</returns> </member> <member name="T:PSFramework.ResultCache.ResultCache"> <summary> The class containing all things related to the result cache functionality. </summary> </member> <member name="P:PSFramework.ResultCache.ResultCache.Result"> <summary> The actually cached result </summary> </member> <member name="F:PSFramework.ResultCache.ResultCache.Function"> <summary> The function that wrote the cache. </summary> </member> <member name="P:PSFramework.ResultCache.ResultCache.Timestamp"> <summary> Returns, when the cache was last set </summary> </member> <member name="M:PSFramework.ResultCache.ResultCache.Clear"> <summary> Clears all cache properties to null </summary> </member> <member name="T:PSFramework.Runspace.RunspaceBoundValue"> <summary> Wrapper class that offers the tools to make Values runspace specific </summary> </member> <member name="F:PSFramework.Runspace.RunspaceBoundValue.OfferDefaultValue"> <summary> Whether the default value should be offered when asking from a runspace without custom settings </summary> </member> <member name="F:PSFramework.Runspace.RunspaceBoundValue.DefaultValue"> <summary> The default value to offer </summary> </member> <member name="F:PSFramework.Runspace.RunspaceBoundValue.Values"> <summary> The values available on a "per runspace" basis </summary> </member> <member name="P:PSFramework.Runspace.RunspaceBoundValue.Value"> <summary> The value to offer or set, specific per runspace from which it is called </summary> </member> <member name="M:PSFramework.Runspace.RunspaceBoundValue.PurgeExpired"> <summary> Removes all value entries whose corresponding Runspace has been destroyed </summary> </member> <member name="M:PSFramework.Runspace.RunspaceBoundValue.Dispose"> <summary> Destruction logic, eliminating all data stored in the object. Since handles to this object are automatically stored and maintained, it is impossible to otherwise guarantee releasing the object's data for the GC. </summary> </member> <member name="M:PSFramework.Runspace.RunspaceBoundValue.#ctor"> <summary> Create an empty runspace bound value object </summary> </member> <member name="M:PSFramework.Runspace.RunspaceBoundValue.#ctor(System.Object)"> <summary> Create a runspace bound value object with its initial value </summary> <param name="Value">The object to set as the initial value</param> </member> <member name="M:PSFramework.Runspace.RunspaceBoundValue.#ctor(System.Object,System.Boolean)"> <summary> Create a runspace bound value object with its initial value </summary> <param name="Value">The object to set as the initial value</param> <param name="OfferDefaultValue">Whether the initial / default value should be offered when accessed from runspaces that do not have a runspace-local value</param> </member> <member name="T:PSFramework.Runspace.RunspaceBoundValueGeneric`1"> <summary> Generic implementation of RunspaceBoundValue </summary> <typeparam name="T">The type to use for wrapping</typeparam> </member> <member name="F:PSFramework.Runspace.RunspaceBoundValueGeneric`1.DefaultValue"> <summary> The default value to offer </summary> </member> <member name="F:PSFramework.Runspace.RunspaceBoundValueGeneric`1.Values"> <summary> The values available on a "per runspace" basis </summary> </member> <member name="P:PSFramework.Runspace.RunspaceBoundValueGeneric`1.Value"> <summary> The value to offer or set, specific per runspace from which it is called </summary> </member> <member name="M:PSFramework.Runspace.RunspaceBoundValueGeneric`1.PurgeExpired"> <summary> Removes all value entries whose corresponding Runspace has been destroyed </summary> </member> <member name="M:PSFramework.Runspace.RunspaceBoundValueGeneric`1.#ctor"> <summary> Create an empty runspace bound value object </summary> </member> <member name="M:PSFramework.Runspace.RunspaceBoundValueGeneric`1.#ctor(`0)"> <summary> Create a runspace bound value object with its initial value </summary> <param name="Value">The object to set as the initial value</param> </member> <member name="M:PSFramework.Runspace.RunspaceBoundValueGeneric`1.#ctor(`0,System.Boolean)"> <summary> Create a runspace bound value object with its initial value </summary> <param name="Value">The object to set as the initial value</param> <param name="OfferDefaultValue">Whether the initial / default value should be offered when accessed from runspaces that do not have a runspace-local value</param> </member> <member name="T:PSFramework.Runspace.RunspaceContainer"> <summary> Class that contains the logic necessary to manage a unique runspace </summary> </member> <member name="F:PSFramework.Runspace.RunspaceContainer.Name"> <summary> The name of the runspace. </summary> </member> <member name="P:PSFramework.Runspace.RunspaceContainer.RunspaceGuid"> <summary> The Guid of the running Runspace </summary> </member> <member name="M:PSFramework.Runspace.RunspaceContainer.SetScript(System.Management.Automation.ScriptBlock)"> <summary> Sets the script to execute in the runspace. Will NOT take immediate effect. Only after restarting the runspace will it be used. </summary> <param name="Script">The scriptblock to execute</param> </member> <member name="P:PSFramework.Runspace.RunspaceContainer.State"> <summary> The state the runspace currently is in. </summary> </member> <member name="M:PSFramework.Runspace.RunspaceContainer.Start"> <summary> Starts the Runspace. </summary> </member> <member name="M:PSFramework.Runspace.RunspaceContainer.SetName(System.Management.Automation.Runspaces.Runspace)"> <summary> Sets the name on a runspace. This WILL FAIL for PowerShell v3! </summary> <param name="Runspace">The runspace to be named</param> </member> <member name="M:PSFramework.Runspace.RunspaceContainer.Stop"> <summary> Gracefully stops the Runspace </summary> </member> <member name="M:PSFramework.Runspace.RunspaceContainer.Kill"> <summary> Very ungracefully kills the runspace. Use only in the most dire emergency. </summary> </member> <member name="M:PSFramework.Runspace.RunspaceContainer.SignalStopped"> <summary> Signals the registered runspace has stopped execution </summary> </member> <member name="M:PSFramework.Runspace.RunspaceContainer.#ctor(System.String,System.Management.Automation.ScriptBlock)"> <summary> Creates a new runspace container with the basic information needed </summary> <param name="Name">The name of the Runspace</param> <param name="Script">The code using the runspace logic</param> </member> <member name="T:PSFramework.Runspace.RunspaceHost"> <summary> Provides hosting for all registered runspaces </summary> </member> <member name="F:PSFramework.Runspace.RunspaceHost.StopTimeoutSeconds"> <summary> The number of seconds before a Stop command is interrupted and instead the runspace is gracelessly shut down. </summary> </member> <member name="P:PSFramework.Runspace.RunspaceHost.RbvCleanupInterval"> <summary> The interval (in milliseonds) in which Runspace-Bound Values will be leaned up </summary> </member> <member name="F:PSFramework.Runspace.RunspaceHost.Runspaces"> <summary> The dictionary containing the definitive list of unique Runspace </summary> </member> <member name="P:PSFramework.Runspace.RunspaceHost._RunspaceBoundValues"> <summary> List of all runspace bound values in use </summary> </member> <member name="M:PSFramework.Runspace.RunspaceHost.StartRbvTimer"> <summary> Starts the timer that in the background will periodically clean up runspace-bound variable-values that no longer have a hosting runspace. </summary> </member> <member name="M:PSFramework.Runspace.RunspaceHost.StopRbvTimer"> <summary> Stops the timer that in the background will periodically clean up runspace-bound variable-values that no longer have a hosting runspace. Should only be called when destroying the primary runspace. </summary> </member> <member name="M:PSFramework.Runspace.RunspaceHost.PurgeAllRunspaceBoundVariables"> <summary> Purge all RBVs of datasets from all expired runspaces </summary> </member> <member name="T:PSFramework.Runspace.PsfRunspaceState"> <summary> Contains the state a managed, unique runspace can be in. </summary> </member> <member name="F:PSFramework.Runspace.PsfRunspaceState.Running"> <summary> The runspace is up and running </summary> </member> <member name="F:PSFramework.Runspace.PsfRunspaceState.Stopping"> <summary> The runspace has received the stop order, but has not yet obeyed it </summary> </member> <member name="F:PSFramework.Runspace.PsfRunspaceState.Stopped"> <summary> The runspace has followed its order to stop and is currently disabled </summary> </member> <member name="T:PSFramework.Serialization.ClixmlDataStyle"> <summary> The serialization output options available </summary> </member> <member name="F:PSFramework.Serialization.ClixmlDataStyle.String"> <summary> Serialize to and from string </summary> </member> <member name="F:PSFramework.Serialization.ClixmlDataStyle.Byte"> <summary> Serialize to and from byte </summary> </member> <member name="T:PSFramework.Serialization.ClixmlSerializer"> <summary> Class providing tools to convert to and from clixml, compressed and uncompressed, string and bytes </summary> </member> <member name="M:PSFramework.Serialization.ClixmlSerializer.ToByteCompressed(System.Object)"> <summary> Converts an object into compressed bytes </summary> <param name="Item">The arbitrary object to serialize</param> <returns>A compressed byte array containing the serialized inputobject</returns> </member> <member name="M:PSFramework.Serialization.ClixmlSerializer.ToByteCompressed(System.Object,System.Int32)"> <summary> Converts an object into compressed bytes </summary> <param name="Item">The arbitrary object to serialize</param> <param name="Depth">The depth to which to serialize</param> <returns>A compressed byte array containing the serialized inputobject</returns> </member> <member name="M:PSFramework.Serialization.ClixmlSerializer.ToByte(System.Object)"> <summary> Converts an object into bytes </summary> <param name="Item">The arbitrary object to serialize</param> <returns>A byte array containing the serialized inputobject</returns> </member> <member name="M:PSFramework.Serialization.ClixmlSerializer.ToByte(System.Object,System.Int32)"> <summary> Converts an object into bytes </summary> <param name="Item">The arbitrary object to serialize</param> <param name="Depth">Overrrides the default serialization depth</param> <returns>A byte array containing the serialized inputobject</returns> </member> <member name="M:PSFramework.Serialization.ClixmlSerializer.ToStringCompressed(System.Object)"> <summary> Converts an object into compressed string </summary> <param name="Item">The arbitrary object to serialize</param> <returns>A compressed string containing the serialized inputobject</returns> </member> <member name="M:PSFramework.Serialization.ClixmlSerializer.ToStringCompressed(System.Object,System.Int32)"> <summary> Converts an object into compressed string </summary> <param name="Item">The arbitrary object to serialize</param> <param name="Depth">The depth to which to serialize</param> <returns>A compressed string containing the serialized inputobject</returns> </member> <member name="M:PSFramework.Serialization.ClixmlSerializer.ToString(System.Object)"> <summary> Converts an object into string </summary> <param name="Item">The arbitrary object to serialize</param> <returns>A string containing the serialized inputobject</returns> </member> <member name="M:PSFramework.Serialization.ClixmlSerializer.ToString(System.Object,System.Int32)"> <summary> Converts an object into string </summary> <param name="Item">The arbitrary object to serialize</param> <param name="Depth">Overrrides the default serialization depth</param> <returns>A string containing the serialized inputobject</returns> </member> <member name="M:PSFramework.Serialization.ClixmlSerializer.FromByteCompressed(System.Byte[])"> <summary> Deserializes an object that was serialized to compressed bytes </summary> <param name="Bytes">The compressed bytes to deserialize into an object</param> <returns>The deserialized object</returns> </member> <member name="M:PSFramework.Serialization.ClixmlSerializer.FromStringCompressed(System.String)"> <summary> Deserializes an object that was serialized to compressed string </summary> <param name="String">The compressed string to deserialize into an object</param> <returns>The deserialized object</returns> </member> <member name="M:PSFramework.Serialization.ClixmlSerializer.FromByte(System.Byte[])"> <summary> Deserializes an object that was serialized to bytes </summary> <param name="Bytes">The bytes to deserialize into an object</param> <returns>The deserialized object</returns> </member> <member name="M:PSFramework.Serialization.ClixmlSerializer.FromString(System.String)"> <summary> Deserializes an object that was serialized to string </summary> <param name="String">The string to deserialize into an object</param> <returns>The deserialized object</returns> </member> <member name="T:PSFramework.Serialization.SerializationTypeConverter"> <summary> Typeconverter that does the heavy lifting of maintaining type integrity across process borders. </summary> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.CanConvertFrom(System.Object,System.Type)"> <summary> Whether the source can be converted to its destination </summary> <param name="sourceValue">The value to convert</param> <param name="destinationType">The type to convert to</param> <returns>Whether this action is possible</returns> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.ConvertFrom(System.Object,System.Type,System.IFormatProvider,System.Boolean)"> <summary> Converts an object </summary> <param name="sourceValue">The data to convert</param> <param name="destinationType">The type to convert to</param> <param name="formatProvider">This will be ignored, but must be present</param> <param name="ignoreCase">This will be ignored, but must be present</param> <returns>The converted object</returns> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.CanConvertTo(System.Object,System.Type)"> <summary> Whether the input object can be converted to the Destination type </summary> <param name="sourceValue">Input value</param> <param name="destinationType">The type to convert to</param> <returns></returns> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.ConvertTo(System.Object,System.Type,System.IFormatProvider,System.Boolean)"> <summary> Converts an object </summary> <param name="sourceValue">The data to convert</param> <param name="destinationType">The type to convert to</param> <param name="formatProvider">This will be ignored, but must be present</param> <param name="ignoreCase">This will be ignored, but must be present</param> <returns>The converted object</returns> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.RegisterAssemblyResolver"> <summary> Registers an assembly resolving event </summary> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.CanSerialize(System.Object)"> <summary> Whether an object can be serialized </summary> <param name="obj">The object to test</param> <returns>Whether the object can be serialized</returns> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.CanSerialize(System.Type)"> <summary> Whether a type can be serialized </summary> <param name="type">The type to test</param> <returns>Whether the specified type can be serialized</returns> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.TypeIsSerializable(System.Type)"> <summary> The validation check on whether a type is serializable </summary> <param name="type">The type to test</param> <returns>Returns whether that type can be serialized</returns> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.GetSerializationData(System.Management.Automation.PSObject)"> <summary> Used to obtain the information to write </summary> <param name="psObject">The object to dissect</param> <returns>A memory stream.</returns> </member> <member name="T:PSFramework.TabExpansion.CompletionResultComparer"> <summary> Compares two completion results </summary> </member> <member name="M:PSFramework.TabExpansion.CompletionResultComparer.Compare(System.Management.Automation.CompletionResult,System.Management.Automation.CompletionResult)"> <summary> Compares two completion results </summary> <param name="Completer1">Completer to compare</param> <param name="Completer2">Completer to compare</param> <returns>-1, 0 or 1</returns> </member> <member name="T:PSFramework.TabExpansion.PsfArgumentCompleterAttribute"> <summary> Allows integrating PSFramework tab expansion by attribute, rather than command. </summary> </member> <member name="M:PSFramework.TabExpansion.PsfArgumentCompleterAttribute.#ctor(System.String)"> <summary> Create an argument completer offering but the name of the registered completion </summary> <param name="Completion">The completion scriptblock to use to provide completion information</param> </member> <member name="M:PSFramework.TabExpansion.PsfArgumentCompleterAttribute.#ctor(System.Management.Automation.ScriptBlock)"> <summary> Create an argument completer offering a scriptblock that is supposed to produce completion data. </summary> <param name="ScriptBlock">The scriptblock to use for completion data generation</param> </member> <member name="M:PSFramework.TabExpansion.PsfArgumentCompleterAttribute.#ctor(System.Management.Automation.ScriptBlock,System.Boolean)"> <summary> Create an argument completer offering a scriptblock that is supposed to produce completion data. </summary> <param name="ScriptBlock">The scriptblock to use for completion data generation</param> <param name="Global">Whether to execute the scriptblock in the global context.</param> </member> <member name="M:PSFramework.TabExpansion.PsfArgumentCompleterAttribute.#ctor(System.Management.Automation.ScriptBlock,System.String)"> <summary> Create an argument completer offering a scriptblock that is supposed to produce completion data. </summary> <param name="ScriptBlock">The scriptblock to use for completion data generation</param> <param name="Name">The name to assign to this completion. Must be unique per scriptblock</param> </member> <member name="M:PSFramework.TabExpansion.PsfArgumentCompleterAttribute.#ctor(System.Management.Automation.ScriptBlock,System.String,System.Boolean)"> <summary> Create an argument completer offering a scriptblock that is supposed to produce completion data. </summary> <param name="ScriptBlock">The scriptblock to use for completion data generation</param> <param name="Name">The name to assign to this completion. Must be unique per scriptblock</param> <param name="Global">Whether to execute the scriptblock in the global context.</param> </member> <member name="T:PSFramework.TabExpansion.ScriptContainer"> <summary> Regular container to store scripts in, that are used in TEPP </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.Name"> <summary> The name of the scriptblock </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.ScriptBlock"> <summary> The scriptblock doing the logic </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.LastExecution"> <summary> The last time the scriptblock was called. Must be updated by the scriptblock itself </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.LastDuration"> <summary> The time it took to run the last time </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.InnerScriptBlock"> <summary> Scriptblock for users using simple-TEPP acceleration </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.ErrorRecords"> <summary> THe errors that occured during scriptblock execution. </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.LastResult"> <summary> The values the last search returned </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.LastCompletion"> <summary> The completion data for the values the last search returned </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.LastResultsValidity"> <summary> How long are previous values valid, before a new execution becomes necessary. </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.Global"> <summary> Whether to execute the scriptblock in the global scope </summary> </member> <member name="P:PSFramework.TabExpansion.ScriptContainer.ShouldExecute"> <summary> Returns whether a new refresh of tab completion should be executed. </summary> </member> <member name="M:PSFramework.TabExpansion.ScriptContainer.Invoke"> <summary> Returns the correct results, either by executing the scriptblock or consulting the cache </summary> <returns></returns> </member> <member name="T:PSFramework.TabExpansion.TabExpansionHost"> <summary> Class that handles the static fields supporting the ÜSFramework TabExpansion implementation </summary> </member> <member name="F:PSFramework.TabExpansion.TabExpansionHost.Scripts"> <summary> Field containing the scripts that were registered. </summary> </member> <member name="P:PSFramework.TabExpansion.TabExpansionHost.Cache"> <summary> The cache used by scripts utilizing TabExpansionPlusPlus for PSFramework </summary> </member> <member name="M:PSFramework.TabExpansion.TabExpansionHost.RegisterCompletion(System.String,System.Management.Automation.ScriptBlock,PSFramework.TabExpansion.TeppScriptMode,PSFramework.Parameter.TimeSpanParameter,System.Boolean)"> <summary> Registers a new completion scriptblock </summary> <param name="Name">The name of the completion scriptblock</param> <param name="ScriptBlock">The scriptblock that will provide completion data</param> <param name="Mode">What completion mode to use</param> <param name="CacheDuration">How long the gathered pieces of data remain valid.</param> <param name="Global">Whether to globalize scriptblocks prior to invocation.</param> </member> <member name="M:PSFramework.TabExpansion.TabExpansionHost.RegisterCompletion(System.String,System.Management.Automation.ScriptBlock,PSFramework.TabExpansion.TeppScriptMode,PSFramework.Parameter.TimeSpanParameter,System.Boolean,System.Boolean)"> <summary> Registers a new completion scriptblock </summary> <param name="Name">The name of the completion scriptblock</param> <param name="ScriptBlock">The scriptblock that will provide completion data</param> <param name="Mode">What completion mode to use</param> <param name="CacheDuration">How long the gathered pieces of data remain valid.</param> <param name="Global">Whether to globalize scriptblocks prior to invocation.</param> <param name="PassThru">Parameter is ignored. Needed to have a second signature that returns the script container.</param> </member> <member name="F:PSFramework.TabExpansion.TabExpansionHost.InputCompletionTypeData"> <summary> Dictionary containing a list of hashtables to explicitly add properties when completing for specific output types. Entries must have three properties: - Name (Name of Property) - Type (Type, not Typename, of the property. May be empty) - TypeKnown (Boolean, whether the type is known) Used by the Tab Completion: PSFramework-Input-ObjectProperty </summary> </member> <member name="F:PSFramework.TabExpansion.TabExpansionHost.InputCompletionCommandData"> <summary> Dictionary containing a list of hashtables to explicitly add properties when completing for specific commands Entries must have three properties: - Name (Name of Property) - Type (Type, not Typename, of the property. May be empty) - TypeKnown (Boolean, whether the type is known) Used by the Tab Completion: PSFramework-Input-ObjectProperty </summary> </member> <member name="T:PSFramework.TabExpansion.TeppScriptMode"> <summary> Whether the user wants to use simple tepp, full tepp or auto-detect </summary> </member> <member name="F:PSFramework.TabExpansion.TeppScriptMode.Simple"> <summary> Simple mode. The scriptblock provided by the user is expected to provide a list of strings. All the rest is processed by the system </summary> </member> <member name="F:PSFramework.TabExpansion.TeppScriptMode.Full"> <summary> In full mode, the user is expected to provide the full TEPP scriptblock. </summary> </member> <member name="F:PSFramework.TabExpansion.TeppScriptMode.Auto"> <summary> In Auto-Detect mode, the system detects, whether the user intended to provide a simple mode or full mode script. This is determined by whether the scriptblock contains a parameter block or not. </summary> </member> <member name="T:PSFramework.TaskEngine.CacheItem"> <summary> Runtime item handling the various meta-data for the TaskEngineCache values. </summary> </member> <member name="F:PSFramework.TaskEngine.CacheItem.Module"> <summary> The module the cache item belongs to. </summary> </member> <member name="F:PSFramework.TaskEngine.CacheItem.Name"> <summary> Name of the cache item. </summary> </member> <member name="P:PSFramework.TaskEngine.CacheItem.Value"> <summary> Value stored in the item </summary> </member> <member name="F:PSFramework.TaskEngine.CacheItem.Collector"> <summary> Scriptblock to execute to gather data to cache </summary> </member> <member name="F:PSFramework.TaskEngine.CacheItem.CollectorArgument"> <summary> An argument to pass to the collector scriptblock </summary> </member> <member name="F:PSFramework.TaskEngine.CacheItem.LastSet"> <summary> When was the value last updated </summary> </member> <member name="F:PSFramework.TaskEngine.CacheItem.Expiration"> <summary> How long are the values valid </summary> </member> <member name="P:PSFramework.TaskEngine.CacheItem.Expired"> <summary> Whether the cqached data has expired </summary> </member> <member name="M:PSFramework.TaskEngine.CacheItem.#ctor(System.String,System.String)"> <summary> Create a new CacheItem </summary> <param name="Module">The module the item belongs to</param> <param name="Name">The name of the item.</param> </member> <member name="M:PSFramework.TaskEngine.CacheItem.GetValue"> <summary> Obtain value for cached item. Run collector script if necessary, prevent parallel collector execution. </summary> <returns>The cached values</returns> </member> <member name="T:PSFramework.TaskEngine.Priority"> <summary> How high the priority of the task. Higher priority tasks take precedence over low priority tasks. </summary> </member> <member name="F:PSFramework.TaskEngine.Priority.Trivial"> <summary> This task is completely trivial and can be done whenever there is some spare time for it </summary> </member> <member name="F:PSFramework.TaskEngine.Priority.Low"> <summary> The task is not very significant, but should be dealt with at some point </summary> </member> <member name="F:PSFramework.TaskEngine.Priority.Medium"> <summary> Average priority task </summary> </member> <member name="F:PSFramework.TaskEngine.Priority.High"> <summary> An important task that will take precedence over most other tasks </summary> </member> <member name="F:PSFramework.TaskEngine.Priority.Critical"> <summary> A task so critical, that it should be considered to move it to synchronous execution instead. </summary> </member> <member name="T:PSFramework.TaskEngine.PsfTask"> <summary> An individual task assigned to the maintenance engine </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Name"> <summary> The name of the task to execute. No duplciates are possible. </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Description"> <summary> A description of what the task is/should be doing </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Once"> <summary> Whether the task should be done once only </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Enabled"> <summary> Whether the task is enabled. Only enabled tasks will be executed </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Interval"> <summary> The interval at which the task should be performed </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Delay"> <summary> If the task need not be performed right away, it can be delayed, in order to prioritize more important initialization tasks </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Registered"> <summary> When was the task first registered. Duplicate registration calls will not increment this value. </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.LastExecution"> <summary> When was the task last executed. </summary> </member> <member name="P:PSFramework.TaskEngine.PsfTask.NextExecution"> <summary> When is the task due next. </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.LastDuration"> <summary> The time the last execution took </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Priority"> <summary> How important is this task? </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.ScriptBlock"> <summary> The task code to execute </summary> </member> <member name="P:PSFramework.TaskEngine.PsfTask.IsDue"> <summary> Whether the task is due and should be executed </summary> </member> <member name="P:PSFramework.TaskEngine.PsfTask.Pending"> <summary> Returns, whether there are any actions still pending. The Task Engine runspace will terminate if there are no pending tasks left. </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.LastError"> <summary> The last error the task had. </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.State"> <summary> The current state of the task. </summary> </member> <member name="T:PSFramework.TaskEngine.TaskHost"> <summary> Host class providing access to resources needed to schedule and execute tasks in the background </summary> </member> <member name="F:PSFramework.TaskEngine.TaskHost.Tasks"> <summary> The register of available tasks. </summary> </member> <member name="P:PSFramework.TaskEngine.TaskHost.HasDueTasks"> <summary> Whether there are any due tasks </summary> </member> <member name="P:PSFramework.TaskEngine.TaskHost.HasPendingTasks"> <summary> Whether there are any tasks that still have an action pending </summary> </member> <member name="M:PSFramework.TaskEngine.TaskHost.GetNextTask(System.String[])"> <summary> Returns the next task to perform. Returns null when there are no more tasks to perform </summary> <param name="Exclusions">List of tasks not to return, even if they are ready to execute again. This is used to avoid one misconfigured task starving all lower priority tasks, by including all tasks that have already run in a given cycle.</param> <returns>The next task to perform.</returns> </member> <member name="F:PSFramework.TaskEngine.TaskHost.Cache"> <summary> Cache where modules can store cached data provided by tasks </summary> </member> <member name="M:PSFramework.TaskEngine.TaskHost.GetCacheItem(System.String,System.String)"> <summary> Return a cache item </summary> <param name="Module">The module the cached data belongs to</param> <param name="Name">The cache entry the setting</param> <returns>The cache item storing data and potentially data gathering script.</returns> </member> <member name="M:PSFramework.TaskEngine.TaskHost.NewCacheItem(System.String,System.String)"> <summary> Creates a new cache item </summary> <param name="Module"></param> <param name="Name"></param> <returns></returns> </member> <member name="M:PSFramework.TaskEngine.TaskHost.TestCacheItem(System.String,System.String)"> <summary> Return whether a given cache item has been created already. </summary> <param name="Module"></param> <param name="Name"></param> <returns></returns> </member> <member name="M:PSFramework.TaskEngine.TaskHost.ClearExpiredCacheData"> <summary> Clears expired data in order to vacate memory. </summary> </member> <member name="T:PSFramework.TaskEngine.TaskState"> <summary> The state of the task or its previous execution </summary> </member> <member name="F:PSFramework.TaskEngine.TaskState.New"> <summary> Task is new, hasn't executed yet </summary> </member> <member name="F:PSFramework.TaskEngine.TaskState.Running"> <summary> Task is currently running </summary> </member> <member name="F:PSFramework.TaskEngine.TaskState.Completed"> <summary> Task has completed </summary> </member> <member name="F:PSFramework.TaskEngine.TaskState.Pending"> <summary> Task is pending another execution </summary> </member> <member name="F:PSFramework.TaskEngine.TaskState.Error"> <summary> Task had an error </summary> </member> <member name="T:PSFramework.Temp.TempItem"> <summary> A temporary item </summary> </member> <member name="P:PSFramework.Temp.TempItem.Type"> <summary> What kind of item is this? </summary> </member> <member name="P:PSFramework.Temp.TempItem.Exists"> <summary> Does the item still exist? </summary> </member> <member name="F:PSFramework.Temp.TempItem.Timeout"> <summary> When will this temporary item expire? </summary> </member> <member name="F:PSFramework.Temp.TempItem.Name"> <summary> Name of the item </summary> </member> <member name="F:PSFramework.Temp.TempItem.Module"> <summary> The module that owns the item </summary> </member> <member name="F:PSFramework.Temp.TempItem.ProviderName"> <summary> The name of the provider implementing this </summary> </member> <member name="M:PSFramework.Temp.TempItem.Delete"> <summary> Remove the temporary item. Must remove itself from the Parent's list once completed. </summary> </member> <member name="F:PSFramework.Temp.TempItem.Parent"> <summary> Parent container </summary> </member> <member name="F:PSFramework.Temp.TempItem.LastError"> <summary> The last error that happened to the TempItem. Usually errors when trying to run Delete() </summary> </member> <member name="M:PSFramework.Temp.TempItem.ToString"> <summary> String representation of this object </summary> <returns>some text</returns> </member> <member name="T:PSFramework.Temp.TempItemContainer"> <summary> Container unit for temporary items. Ensures keeping track of and disposing any and all temporary items. </summary> </member> <member name="P:PSFramework.Temp.TempItemContainer.Items"> <summary> List of all temporary items registered </summary> </member> <member name="P:PSFramework.Temp.TempItemContainer.Providers"> <summary> The list of temp item providers </summary> </member> <member name="M:PSFramework.Temp.TempItemContainer.#ctor"> <summary> Create a default container for temporary items </summary> </member> <member name="M:PSFramework.Temp.TempItemContainer.Clear"> <summary> Remove all temp items, cleaning up behind yourself </summary> </member> <member name="M:PSFramework.Temp.TempItemContainer.ClearExpired"> <summary> Remove all temp items that are bveyond their timeout </summary> </member> <member name="M:PSFramework.Temp.TempItemContainer.Get(System.String,System.String)"> <summary> Returns all temp items that meet the module and name condition (using wildcard evaluation) </summary> <param name="Module">Module to search by</param> <param name="Name">Name of the TempItem to search by</param> <returns>A list of TempItems matching the search patterns.</returns> </member> <member name="T:PSFramework.Temp.TempItemDirectory"> <summary> A temporary directory, that shall be deleted in due time </summary> </member> <member name="P:PSFramework.Temp.TempItemDirectory.Type"> <summary> The fact that this is a file </summary> </member> <member name="P:PSFramework.Temp.TempItemDirectory.Exists"> <summary> Whether the directory still exists </summary> </member> <member name="P:PSFramework.Temp.TempItemDirectory.ProviderName"> <summary> The provider implementing this temp item </summary> </member> <member name="F:PSFramework.Temp.TempItemDirectory.Path"> <summary> The full path to the directory </summary> </member> <member name="M:PSFramework.Temp.TempItemDirectory.Delete"> <summary> Delete the directory and remove it from the list of temporary items </summary> </member> <member name="M:PSFramework.Temp.TempItemDirectory.#ctor(System.String,System.String,System.String,PSFramework.Temp.TempItemContainer)"> <summary> Create a new temporary directory object (directory itself is not created) </summary> <param name="Name">Name of the temp directory</param> <param name="Module">Name of the module owning the temp directory</param> <param name="Path">Path to the temporary directory</param> <param name="Parent">The parent container.</param> </member> <member name="T:PSFramework.Temp.TempItemFile"> <summary> A temporary file, that shall be deleted in due time </summary> </member> <member name="P:PSFramework.Temp.TempItemFile.Type"> <summary> The fact that this is a file </summary> </member> <member name="P:PSFramework.Temp.TempItemFile.Exists"> <summary> Whether the file still exists </summary> </member> <member name="P:PSFramework.Temp.TempItemFile.ProviderName"> <summary> The provider implementing this temp item </summary> </member> <member name="F:PSFramework.Temp.TempItemFile.Path"> <summary> The full path to the file </summary> </member> <member name="M:PSFramework.Temp.TempItemFile.Delete"> <summary> Delete the file and remove it from the list of temporary items </summary> </member> <member name="M:PSFramework.Temp.TempItemFile.#ctor(System.String,System.String,System.String,PSFramework.Temp.TempItemContainer)"> <summary> Create a new temporary file object (file itself is not created) </summary> <param name="Name">Name of the temp file</param> <param name="Module">Name of the module owning the temp file</param> <param name="Path">Path to the temporary file</param> <param name="Parent">The parent container.</param> </member> <member name="T:PSFramework.Temp.TempItemGeneric"> <summary> A generic temporary item. Implementation logic provided by temporary item providers. </summary> </member> <member name="P:PSFramework.Temp.TempItemGeneric.Type"> <summary> This is a generic one. Yay. </summary> </member> <member name="P:PSFramework.Temp.TempItemGeneric.Exists"> <summary> Whether the temp item even exists. </summary> </member> <member name="F:PSFramework.Temp.TempItemGeneric.ExistsScript"> <summary> Scriptblock verifying the existence of the item </summary> </member> <member name="F:PSFramework.Temp.TempItemGeneric.DeleteScript"> <summary> Scriptblock deleting the temporary item. </summary> </member> <member name="F:PSFramework.Temp.TempItemGeneric.Data"> <summary> Data that differentiates this item from others using the same provider </summary> </member> <member name="F:PSFramework.Temp.TempItemGeneric.CreationData"> <summary> Data that was returned when running the creation scriptblock </summary> </member> <member name="M:PSFramework.Temp.TempItemGeneric.Delete"> <summary> Kill it with fire. </summary> </member> <member name="M:PSFramework.Temp.TempItemGeneric.ToString"> <summary> String representation of this object </summary> <returns>some text</returns> </member> <member name="M:PSFramework.Temp.TempItemGeneric.#ctor(System.String,System.String,System.String,System.Collections.Hashtable,PSFramework.Temp.TempItemContainer,System.Object)"> <summary> Creates a generic temporary item </summary> <param name="Name">Name of the temp item</param> <param name="Module">Name of the module owning the temp item</param> <param name="ProviderName">Name of the provider offering the implementation logic of this item</param> <param name="Data">Data defining this temp item</param> <param name="Parent">The parent container of this item</param> <param name="CreationData">Data that was returned when running the creation scriptblock</param> </member> <member name="T:PSFramework.Temp.TempItemProvider"> <summary> Extensibility tool, providing logic to custom-deploy temporary items </summary> </member> <member name="F:PSFramework.Temp.TempItemProvider.Name"> <summary> Name of the provider </summary> </member> <member name="F:PSFramework.Temp.TempItemProvider.CreationScript"> <summary> Scriptblock to execute as you create the temporary item </summary> </member> <member name="F:PSFramework.Temp.TempItemProvider.ExistsScript"> <summary> Scriptblock verifying the existence of the item </summary> </member> <member name="F:PSFramework.Temp.TempItemProvider.DeleteScript"> <summary> Scriptblock deleting the temporary item. </summary> </member> <member name="M:PSFramework.Temp.TempItemProvider.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock)"> <summary> Create a new TempItemProvider </summary> <param name="Name">Name of the provider</param> <param name="CreationScript">Scriptblock to execute as you create the temporary item</param> <param name="ExistsScript">Scriptblock verifying the existence of the item</param> <param name="DeleteScript">Scriptblock deleting the temporary item.</param> </member> <member name="T:PSFramework.Temp.TempItemType"> <summary> What kind of temp item is the object? </summary> </member> <member name="F:PSFramework.Temp.TempItemType.File"> <summary> A regular file </summary> </member> <member name="F:PSFramework.Temp.TempItemType.Directory"> <summary> A regular folder / directory </summary> </member> <member name="F:PSFramework.Temp.TempItemType.Generic"> <summary> A generic item type </summary> </member> <member name="T:PSFramework.Utility.DynamicContentDictionary"> <summary> A dynamic content object that implements a dictionary </summary> </member> <member name="P:PSFramework.Utility.DynamicContentDictionary.Value"> <summary> The value of the dynamic content object </summary> </member> <member name="M:PSFramework.Utility.DynamicContentDictionary.#ctor(System.String,System.Object)"> <summary> Creates a dynamic content object concurrent dictionary </summary> <param name="Name">The name of the setting</param> <param name="Value">The initial value of the object</param> </member> <member name="M:PSFramework.Utility.DynamicContentDictionary.Reset"> <summary> Resets the stack by reestablishing an empty dictionary. </summary> </member> <member name="T:PSFramework.Utility.DynamicContentList"> <summary> A dynamic content object that implements a list </summary> </member> <member name="P:PSFramework.Utility.DynamicContentList.Value"> <summary> The value of the dynamic content object </summary> </member> <member name="M:PSFramework.Utility.DynamicContentList.#ctor(System.String,System.Object)"> <summary> Creates a dynamic content object concurrent list </summary> <param name="Name">The name of the setting</param> <param name="Value">The initial value of the object</param> </member> <member name="P:PSFramework.Utility.DynamicContentList.Count"> <summary> How many items are currently listed </summary> </member> <member name="M:PSFramework.Utility.DynamicContentList.ToArray"> <summary> Returns the current list content as array </summary> <returns>The current queue content</returns> </member> <member name="M:PSFramework.Utility.DynamicContentList.Add(System.Object)"> <summary> Adds an item to the list </summary> <param name="Item">The item to add</param> </member> <member name="M:PSFramework.Utility.DynamicContentList.Take"> <summary> Returns an object if there is anything to take from the list </summary> <returns>The next queued item</returns> </member> <member name="M:PSFramework.Utility.DynamicContentList.Reset"> <summary> Resets the stack by reestablishing an empty list. </summary> </member> <member name="T:PSFramework.Utility.DynamicContentObject"> <summary> Class that contains a value that can be updated from another runspace </summary> </member> <member name="F:PSFramework.Utility.DynamicContentObject.Values"> <summary> The full dictionary of dynamic objects </summary> </member> <member name="P:PSFramework.Utility.DynamicContentObject.List"> <summary> List of all dynamic content objects registered </summary> </member> <member name="M:PSFramework.Utility.DynamicContentObject.Set(System.String,System.Object,PSFramework.Utility.DynamicContentObjectType)"> <summary> Sets the value of a dynamic content object, creating a new one if needed </summary> <param name="Name">The name of the object</param> <param name="Value">The value to set</param> <param name="Type">The type of dynamic content object to create (if creatable)</param> </member> <member name="M:PSFramework.Utility.DynamicContentObject.Get(System.String)"> <summary> Returns the Dynamic Content Object under the specified name </summary> <param name="Name">The name of the object to return</param> <returns>The Dynamic Content Object selected</returns> </member> <member name="F:PSFramework.Utility.DynamicContentObject.Value"> <summary> The value stored in this object </summary> </member> <member name="F:PSFramework.Utility.DynamicContentObject.Name"> <summary> The name of the object </summary> </member> <member name="M:PSFramework.Utility.DynamicContentObject.ConcurrentQueue(System.Boolean)"> <summary> Turns the value into a concurrent queue. </summary> </member> <member name="M:PSFramework.Utility.DynamicContentObject.ConcurrentStack(System.Boolean)"> <summary> Turns the value into a concurrent stack </summary> </member> <member name="M:PSFramework.Utility.DynamicContentObject.ConcurrentList(System.Boolean)"> <summary> Turns the value into a concurrent list </summary> </member> <member name="M:PSFramework.Utility.DynamicContentObject.ConcurrentDictionary(System.Boolean)"> <summary> TUrns the value into a concurrent dictionary with case-insensitive string keys </summary> </member> <member name="M:PSFramework.Utility.DynamicContentObject.ToString"> <summary> General string representation of the value </summary> <returns>The string representation of the value</returns> </member> <member name="M:PSFramework.Utility.DynamicContentObject.#ctor(System.String,System.Object)"> <summary> Creates a named value object that can be updated in the background </summary> <param name="Name">The name of the item</param> <param name="Value">The value of the item</param> </member> <member name="T:PSFramework.Utility.DynamicContentObjectType"> <summary> The kind of dynamic content object was specified </summary> </member> <member name="F:PSFramework.Utility.DynamicContentObjectType.Common"> <summary> A regular object was requested </summary> </member> <member name="F:PSFramework.Utility.DynamicContentObjectType.Queue"> <summary> A queue was requested </summary> </member> <member name="F:PSFramework.Utility.DynamicContentObjectType.List"> <summary> A list was requested </summary> </member> <member name="F:PSFramework.Utility.DynamicContentObjectType.Stack"> <summary> A stack was requested </summary> </member> <member name="F:PSFramework.Utility.DynamicContentObjectType.Dictionary"> <summary> A dictionary was requested </summary> </member> <member name="T:PSFramework.Utility.DynamicContentQueue"> <summary> A dynamic content object that implements a queue </summary> </member> <member name="P:PSFramework.Utility.DynamicContentQueue.Value"> <summary> The value of the dynamic content object </summary> </member> <member name="M:PSFramework.Utility.DynamicContentQueue.#ctor(System.String,System.Object)"> <summary> Creates a dynamic content object concurrent queue </summary> <param name="Name">The name of the setting</param> <param name="Value">The initial value of the object</param> </member> <member name="P:PSFramework.Utility.DynamicContentQueue.Count"> <summary> How many items are currently queued </summary> </member> <member name="M:PSFramework.Utility.DynamicContentQueue.ToArray"> <summary> Returns the current queue content as array </summary> <returns>The current queue content</returns> </member> <member name="M:PSFramework.Utility.DynamicContentQueue.Enqueue(System.Object)"> <summary> Adds an item to the queue </summary> <param name="Item">The item to add</param> </member> <member name="M:PSFramework.Utility.DynamicContentQueue.Dequeue"> <summary> Returns an object if there is anything to take from the queue </summary> <returns>The next queued item</returns> </member> <member name="M:PSFramework.Utility.DynamicContentQueue.Reset"> <summary> Resets the queue by reestablishing an empty queue. </summary> </member> <member name="T:PSFramework.Utility.DynamicContentStack"> <summary> A dynamic content object that implements a stack </summary> </member> <member name="P:PSFramework.Utility.DynamicContentStack.Value"> <summary> The value of the dynamic content object </summary> </member> <member name="M:PSFramework.Utility.DynamicContentStack.#ctor(System.String,System.Object)"> <summary> Creates a dynamic content object concurrent stack </summary> <param name="Name">The name of the setting</param> <param name="Value">The initial value of the object</param> </member> <member name="P:PSFramework.Utility.DynamicContentStack.Count"> <summary> How many items are currently stacked </summary> </member> <member name="M:PSFramework.Utility.DynamicContentStack.ToArray"> <summary> Returns the current stack content as array </summary> <returns>The current queue content</returns> </member> <member name="M:PSFramework.Utility.DynamicContentStack.Push(System.Object)"> <summary> Adds an item to the stack </summary> <param name="Item">The item to add</param> </member> <member name="M:PSFramework.Utility.DynamicContentStack.Pop"> <summary> Returns an object if there is anything to take from the stack </summary> <returns>The next queued item</returns> </member> <member name="M:PSFramework.Utility.DynamicContentStack.Reset"> <summary> Resets the stack by reestablishing an empty stack. </summary> </member> <member name="T:PSFramework.Utility.DynamicTransformationAttribute"> <summary> Transformation attribute that can convert PSObjects or hashtables to the target type, so long as it has an empty constructor </summary> </member> <member name="F:PSFramework.Utility.DynamicTransformationAttribute.TargetType"> <summary> The type to convert to </summary> </member> <member name="F:PSFramework.Utility.DynamicTransformationAttribute.AllowNull"> <summary> Whether a null object is acceptable as input </summary> </member> <member name="F:PSFramework.Utility.DynamicTransformationAttribute.RequiredProperties"> <summary> List of properties that must be specified on the input object </summary> </member> <member name="M:PSFramework.Utility.DynamicTransformationAttribute.Transform(System.Management.Automation.EngineIntrinsics,System.Object)"> <summary> Converts input to output </summary> <param name="engineIntrinsics"></param> <param name="inputData"></param> <returns></returns> </member> <member name="M:PSFramework.Utility.DynamicTransformationAttribute.#ctor(System.Type,System.String[])"> <summary> Creates the basic attribute specifying the target type </summary> <param name="TargetType">The type to convert to</param> <param name="RequiredProperties">Properties to require</param> </member> <member name="T:PSFramework.Utility.LimitedConcurrentQueue`1"> <summary> A wrapper around a queue with a limited size. Excess items will be discarded </summary> </member> <member name="P:PSFramework.Utility.LimitedConcurrentQueue`1.Size"> <summary> The maximum length of the limited queue </summary> </member> <member name="M:PSFramework.Utility.LimitedConcurrentQueue`1.Enqueue(`0)"> <summary> Enqueues an object to the collection </summary> <param name="Item">The object to enqueue</param> </member> <member name="M:PSFramework.Utility.LimitedConcurrentQueue`1.TryAdd(`0)"> <summary> Adds an item to the collection </summary> <param name="Item">The item to add</param> <returns>Whether adding the item succeeded</returns> </member> <member name="M:PSFramework.Utility.LimitedConcurrentQueue`1.#ctor"> <summary> Creates a new, empty collection limited to a default max size of 10 </summary> </member> <member name="M:PSFramework.Utility.LimitedConcurrentQueue`1.#ctor(System.Int32)"> <summary> Creates a new, empty collection limited to the specified size </summary> <param name="Size">The maximum size</param> </member> <member name="T:PSFramework.Utility.Number"> <summary> Wrapper class around double to facilitate human-friendly formatting in object properties </summary> </member> <member name="F:PSFramework.Utility.Number.Value"> <summary> The actual value being wrapped </summary> </member> <member name="M:PSFramework.Utility.Number.ToString"> <summary> Provides a user friendly representation of a number </summary> <returns>A user friendly number format</returns> </member> <member name="P:PSFramework.Utility.Number.SegmentSize"> <summary> Size of each segment before the decimal seaparator when displaying numbers </summary> </member> <member name="P:PSFramework.Utility.Number.SegmentSeparator"> <summary> The seperator used inbetween each segment when displaying numbers </summary> </member> <member name="P:PSFramework.Utility.Number.DecimalSeparator"> <summary> The decimal seperator when displaying numbers </summary> </member> <member name="P:PSFramework.Utility.Number.DecimalDigits"> <summary> When displaying numbers, how many digits after the decimal seperator will be shown? </summary> </member> <member name="M:PSFramework.Utility.Number.#ctor"> <summary> Create an empty number </summary> </member> <member name="M:PSFramework.Utility.Number.#ctor(System.Double)"> <summary> Create a number with an initial value </summary> <param name="Value">The initial value of the number</param> </member> <member name="M:PSFramework.Utility.Number.CompareTo(PSFramework.Utility.Number)"> <inheritdoc cref="M:System.IComparable`1.CompareTo(`0)"/> <remarks>For sorting</remarks> </member> <member name="M:PSFramework.Utility.Number.CompareTo(System.Object)"> <inheritdoc cref="M:System.IComparable.CompareTo(System.Object)"/> <remarks>For sorting</remarks> <exception cref="T:System.ArgumentException">If you compare with something invalid.</exception> </member> <member name="M:PSFramework.Utility.Number.op_Addition(PSFramework.Utility.Number,PSFramework.Utility.Number)"> <summary> Adds two sizes </summary> <param name="a">The first size to add</param> <param name="b">The second size to add</param> <returns>The sum of both sizes</returns> </member> <member name="M:PSFramework.Utility.Number.op_Subtraction(PSFramework.Utility.Number,PSFramework.Utility.Number)"> <summary> Substracts two sizes </summary> <param name="a">The first size to substract</param> <param name="b">The second size to substract</param> <returns>The difference between both sizes</returns> </member> <member name="M:PSFramework.Utility.Number.op_Multiply(PSFramework.Utility.Number,System.Double)"> <summary> Multiplies two sizes with each other </summary> <param name="a">The size to multiply</param> <param name="b">The size to multiply with</param> <returns>A multiplied size.</returns> </member> <member name="M:PSFramework.Utility.Number.op_Division(PSFramework.Utility.Number,System.Double)"> <summary> Divides one size by another. </summary> <param name="a">The size to divide</param> <param name="b">The size to divide with</param> <returns>Divided size (note: Cut off)</returns> </member> <member name="M:PSFramework.Utility.Number.op_Multiply(PSFramework.Utility.Number,PSFramework.Utility.Number)"> <summary> Multiplies two sizes with each other </summary> <param name="a">The size to multiply</param> <param name="b">The size to multiply with</param> <returns>A multiplied size.</returns> </member> <member name="M:PSFramework.Utility.Number.op_Division(PSFramework.Utility.Number,PSFramework.Utility.Number)"> <summary> Divides one size by another. </summary> <param name="a">The size to divide</param> <param name="b">The size to divide with</param> <returns>Divided size (note: Cut off)</returns> </member> <member name="M:PSFramework.Utility.Number.op_Implicit(System.Int32)~PSFramework.Utility.Number"> <summary> Implicitly converts int to size </summary> <param name="a">The number to convert</param> </member> <member name="M:PSFramework.Utility.Number.op_Implicit(System.Decimal)~PSFramework.Utility.Number"> <summary> Implicitly converts int to size </summary> <param name="a">The number to convert</param> </member> <member name="M:PSFramework.Utility.Number.op_Implicit(PSFramework.Utility.Number)~System.Int32"> <summary> Implicitly converts size to int </summary> <param name="a">The size to convert</param> </member> <member name="M:PSFramework.Utility.Number.op_Implicit(System.Int64)~PSFramework.Utility.Number"> <summary> Implicitly converts long to size </summary> <param name="a">The number to convert</param> </member> <member name="M:PSFramework.Utility.Number.op_Implicit(PSFramework.Utility.Number)~System.Int64"> <summary> Implicitly converts size to long </summary> <param name="a">The size to convert</param> </member> <member name="M:PSFramework.Utility.Number.op_Implicit(System.String)~PSFramework.Utility.Number"> <summary> Implicitly converts string to size </summary> <param name="a">The string to convert</param> </member> <member name="M:PSFramework.Utility.Number.op_Implicit(System.Double)~PSFramework.Utility.Number"> <summary> Implicitly converts double to size </summary> <param name="a">The number to convert</param> </member> <member name="M:PSFramework.Utility.Number.op_Implicit(PSFramework.Utility.Number)~System.Double"> <summary> Implicitly converts size to double </summary> <param name="a">The size to convert</param> </member> <member name="T:PSFramework.Utility.PsfException"> <summary> Simple wrapper around Exception to integrate the PSFramework localization feature. </summary> </member> <member name="F:PSFramework.Utility.PsfException.String"> <summary> The full string representing the message </summary> </member> <member name="F:PSFramework.Utility.PsfException.StringValues"> <summary> Any values to format into the message string </summary> </member> <member name="F:PSFramework.Utility.PsfException.CallStack"> <summary> The script callstack at the time this exception was generated. </summary> </member> <member name="P:PSFramework.Utility.PsfException.Message"> <summary> The localized message to show </summary> </member> <member name="M:PSFramework.Utility.PsfException.#ctor"> <summary> Create an empty eception </summary> </member> <member name="M:PSFramework.Utility.PsfException.#ctor(System.String)"> <summary> Create a simple exception including a message string </summary> <param name="String">The string representing the message</param> </member> <member name="M:PSFramework.Utility.PsfException.#ctor(System.String,System.Exception,System.Object[])"> <summary> Create a full exception object with all metadata </summary> <param name="String">The string representing the message</param> <param name="InnerException">An inner exception to pass through</param> <param name="StringValues">Any values to format into the message</param> </member> <member name="T:PSFramework.Utility.PsfScriptBlock"> <summary> Wrapper class around the traditional scriptblock class, extending its capabilities </summary> </member> <member name="F:PSFramework.Utility.PsfScriptBlock.ScriptBlock"> <summary> The original Scriptblock </summary> </member> <member name="P:PSFramework.Utility.PsfScriptBlock.LanguageMode"> <summary> The language mode the scriptblock is running under </summary> </member> <member name="P:PSFramework.Utility.PsfScriptBlock.Ast"> <summary> The Ast of he scriptblock </summary> </member> <member name="P:PSFramework.Utility.PsfScriptBlock.Attributes"> <summary> The Attributes that have been assigned to the scriptblock </summary> </member> <member name="P:PSFramework.Utility.PsfScriptBlock.DebuggerHidden"> <summary> Whether the scriptblock is visible to the debugger </summary> </member> <member name="P:PSFramework.Utility.PsfScriptBlock.File"> <summary> What file the scriptblock comes from </summary> </member> <member name="P:PSFramework.Utility.PsfScriptBlock.Id"> <summary> Unique ID of the scriptblock </summary> </member> <member name="P:PSFramework.Utility.PsfScriptBlock.IsConfiguration"> <summary> Whether the scriptblock is a DSC configuration </summary> </member> <member name="P:PSFramework.Utility.PsfScriptBlock.IsFilter"> <summary> Whether the scriptblock is a filter </summary> </member> <member name="P:PSFramework.Utility.PsfScriptBlock.Module"> <summary> The module the scriptblock belongs to. Don't rely on this, as it may be subject to change. </summary> </member> <member name="P:PSFramework.Utility.PsfScriptBlock.StartPosition"> <summary> Some text metadata of the scriptblock </summary> </member> <member name="M:PSFramework.Utility.PsfScriptBlock.ToString"> <summary> Returns the string representation of the scriptblock </summary> <returns>the string representation of the scriptblock</returns> </member> <member name="M:PSFramework.Utility.PsfScriptBlock.GetNewClosure"> <summary> Wraps the original Scriptblock method GetNewClosure() </summary> <returns>A copy of the ScriptBlock with a new closure.</returns> </member> <member name="M:PSFramework.Utility.PsfScriptBlock.InvokeEx(System.Boolean,System.Object,System.Object,System.Object,System.Boolean,System.Boolean,System.Object[])"> <summary> Do a rich invocation of the scriptblock </summary> <param name="UseLocalScope">Whether a new scope should be created for this</param> <param name="DollerUnder">The value to make available as $_</param> <param name="Input">The value to make available to $input</param> <param name="ScriptThis">The value to make available as $this</param> <param name="ImportContext">Whether to first import the scriptblock into the current Context.</param> <param name="ImportGlobal">When importing the ScriptBlock, import it into the global Context instead.</param> <param name="Args">The value to make available as $args</param> <returns>Whatever output this scriptblock generates</returns> </member> <member name="M:PSFramework.Utility.PsfScriptBlock.InvokeEx(System.Boolean,System.Boolean,System.Boolean)"> <summary> Do a rich invocation of the scriptblock </summary> <param name="UseLocalScope">Whether a new scope should be created for this</param> <param name="ImportContext">Whether to first import the scriptblock into the current Context.</param> <param name="ImportGlobal">When importing the ScriptBlock, import it into the global Context instead.</param> <returns>Whatever output this scriptblock generates</returns> </member> <member name="M:PSFramework.Utility.PsfScriptBlock.InvokeEx(System.Object,System.Boolean,System.Boolean,System.Boolean)"> <summary> Do a rich invocation of the scriptblock </summary> <param name="Value">The value to offer as argument / input for the scriptblock</param> <param name="UseLocalScope">Whether a new scope should be created for this</param> <param name="ImportContext">Whether to first import the scriptblock into the current Context.</param> <param name="ImportGlobal">When importing the ScriptBlock, import it into the global Context instead.</param> <returns>Whatever output this scriptblock generates</returns> </member> <member name="M:PSFramework.Utility.PsfScriptBlock.InvokeGlobal(System.Object)"> <summary> Invoke the Scriptblock rehomed to the global scope </summary> <param name="Value">The value - if any - to offer as argument / input for the scriptblock</param> <returns>Whatever output this scriptblock generates</returns> </member> <member name="M:PSFramework.Utility.PsfScriptBlock.InvokeLocal(System.Object)"> <summary> Invoke the Scriptblock rehomed to the current sessionstate </summary> <param name="Value">The value - if any - to offer as argument / input for the scriptblock</param> <returns>Whatever output this scriptblock generates</returns> </member> <member name="M:PSFramework.Utility.PsfScriptBlock.Invoke(System.Object[])"> <summary> Invoke the scriptblock in legacy mode. </summary> <param name="args">Arguments to pass into the scriptblock</param> <returns>The results of the invocation</returns> </member> <member name="M:PSFramework.Utility.PsfScriptBlock.ToGlobal"> <summary> Return a global clone of the scriptblock </summary> <returns>A global clone of the scriptblock</returns> </member> <member name="M:PSFramework.Utility.PsfScriptBlock.#ctor(System.Management.Automation.ScriptBlock)"> <summary> Create a new PsfScriptBlock by wrapping a regular scriptblock. </summary> <param name="Script">The Scriptblock to wrap</param> </member> <member name="M:PSFramework.Utility.PsfScriptBlock.op_Implicit(PSFramework.Utility.PsfScriptBlock)~System.Management.Automation.ScriptBlock"> <summary> Implicitly convert PsfScriptblock to ScriptBlock </summary> <param name="Script">The PsfScriptBlock to convert</param> </member> <member name="M:PSFramework.Utility.PsfScriptBlock.op_Implicit(System.Management.Automation.ScriptBlock)~PSFramework.Utility.PsfScriptBlock"> <summary> Implicitly convert ScriptBlock to PsfScriptblock </summary> <param name="Script">The ScriptBlock to convert</param> </member> <member name="T:PSFramework.Utility.RegexHelper"> <summary> Static class that holds useful regex patterns, ready for use </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.HostName"> <summary> Pattern that checks for a valid hostname </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.HostNameEx"> <summary> Pattern that checks for valid hostnames within a larger text </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.IPv4"> <summary> Pattern that checks for a valid IPv4 address </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.IPv4Ex"> <summary> Pattern that checks for valid IPv4 addresses within a larger text </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.IPv6"> <summary> Will match a valid IPv6 address </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.IPv6Ex"> <summary> Will match any IPv6 address within a larger text </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.ComputerTarget"> <summary> Will match any string that in its entirety represents a valid target for dns- or ip-based targeting. Combination of HostName, IPv4 and IPv6 </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.Guid"> <summary> Will match a valid Guid </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.GuidEx"> <summary> Will match any number of valid Guids in a larger text </summary> </member> <member name="T:PSFramework.Utility.ScriptBlockItem"> <summary> A scriptblock container item </summary> </member> <member name="F:PSFramework.Utility.ScriptBlockItem.Name"> <summary> Name of the scriptblock </summary> </member> <member name="P:PSFramework.Utility.ScriptBlockItem.ScriptBlock"> <summary> The scriptblock stored </summary> </member> <member name="M:PSFramework.Utility.ScriptBlockItem.IsAvailable"> <summary> Checks, whether the scriptblock is available in a given runspace. </summary> <returns>whether the scriptblock is available in the current runspace</returns> </member> <member name="F:PSFramework.Utility.ScriptBlockItem.Global"> <summary> Whether the scriptblock should be invoked as global scriptblock </summary> </member> <member name="F:PSFramework.Utility.ScriptBlockItem.Local"> <summary> Whether the scriptblock is local to its respective runspace. If set to true, each scriptblock will be unavailable to any runspace other than the one that defined it. However, each runspace can define its own instance of a given scriptblock. </summary> </member> <member name="P:PSFramework.Utility.ScriptBlockItem.CountRetrieved"> <summary> The number of times this scriptblock has been used </summary> </member> <member name="P:PSFramework.Utility.ScriptBlockItem.LastRetrieved"> <summary> When the scriptblock has last been used </summary> </member> <member name="P:PSFramework.Utility.ScriptBlockItem.Tag"> <summary> A list of tags so the scriptblock can be found </summary> </member> <member name="P:PSFramework.Utility.ScriptBlockItem.Description"> <summary> Full-text description of the scriptblock </summary> </member> <member name="M:PSFramework.Utility.ScriptBlockItem.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Boolean,System.Boolean,System.Collections.Generic.List{System.String},System.String)"> <summary> Create a new scriptblock item by offering both name and code </summary> <param name="Name">The name of the scriptblock</param> <param name="ScriptBlock">The scriptblock</param> <param name="Global">Whether the scriptblock should be invoked as global scriptblock</param> <param name="Local">Whether the scriptblock is local to the current runspace only</param> <param name="Tag">An optional list of tags</param> <param name="Description">An optional description</param> </member> <member name="M:PSFramework.Utility.ScriptBlockItem.InvokeGlobal(System.Object)"> <summary> Invoke the Scriptblock rehomed to the global scope </summary> <param name="Value">The value - if any - to offer as argument / input for the scriptblock</param> <returns>Whatever output this scriptblock generates</returns> </member> <member name="M:PSFramework.Utility.ScriptBlockItem.Invoke(System.Object[])"> <summary> Invoke the Scriptblock as configured </summary> <param name="args">The value - if any - to offer as argument for the scriptblock</param> <returns>Whatever output this scriptblock generates</returns> </member> <member name="M:PSFramework.Utility.ScriptBlockItem.InvokeEx(System.Boolean,System.Object,System.Object,System.Object,System.Boolean,System.Boolean,System.Object[])"> <summary> Do a rich invocation of the scriptblock </summary> <param name="UseLocalScope">Whether a new scope should be created for this</param> <param name="DollerUnder">The value to make available as $_</param> <param name="Input">The value to make available to $input</param> <param name="ScriptThis">The value to make available as $this</param> <param name="ImportContext">Whether to first import the scriptblock into the current Context.</param> <param name="ImportGlobal">When importing the ScriptBlock, import it into the global Context instead.</param> <param name="Args">The value to make available as $args</param> <returns>Whatever output this scriptblock generates</returns> </member> <member name="M:PSFramework.Utility.ScriptBlockItem.InvokeEx(System.Boolean,System.Boolean,System.Boolean)"> <summary> Do a rich invocation of the scriptblock </summary> <param name="UseLocalScope">Whether a new scope should be created for this</param> <param name="ImportContext">Whether to first import the scriptblock into the current Context.</param> <param name="ImportGlobal">When importing the ScriptBlock, import it into the global Context instead.</param> <returns>Whatever output this scriptblock generates</returns> </member> <member name="M:PSFramework.Utility.ScriptBlockItem.InvokeEx(System.Object,System.Boolean,System.Boolean,System.Boolean)"> <summary> Do a rich invocation of the scriptblock </summary> <param name="Value">The value to offer as argument / input for the scriptblock</param> <param name="UseLocalScope">Whether a new scope should be created for this</param> <param name="ImportContext">Whether to first import the scriptblock into the current Context.</param> <param name="ImportGlobal">When importing the ScriptBlock, import it into the global Context instead.</param> <returns>Whatever output this scriptblock generates</returns> </member> <member name="T:PSFramework.Utility.Size"> <summary> Class that reports File size. </summary> </member> <member name="P:PSFramework.Utility.Size.Byte"> <summary> Number of bytes contained in whatever object uses this object as a property </summary> </member> <member name="P:PSFramework.Utility.Size.Kilobyte"> <summary> Kilobyte representation of the bytes </summary> </member> <member name="P:PSFramework.Utility.Size.Megabyte"> <summary> Megabyte representation of the bytes </summary> </member> <member name="P:PSFramework.Utility.Size.Gigabyte"> <summary> Gigabyte representation of the bytes </summary> </member> <member name="P:PSFramework.Utility.Size.Terabyte"> <summary> Terabyte representation of the bytes </summary> </member> <member name="P:PSFramework.Utility.Size.Digits"> <summary> Number if digits behind the dot. </summary> </member> <member name="P:PSFramework.Utility.Size.Style"> <summary> How the size object should be displayed. </summary> </member> <member name="M:PSFramework.Utility.Size.ToString"> <summary> Shows the default string representation of size </summary> <returns></returns> </member> <member name="M:PSFramework.Utility.Size.Equals(System.Object)"> <summary> Simple equality test </summary> <param name="obj">The object to test it against</param> <returns>True if equal, false elsewise</returns> </member> <member name="M:PSFramework.Utility.Size.GetHashCode"> <inheritdoc cref="M:System.Int64.GetHashCode"/> <remarks>The hashcode of the underlying size</remarks> </member> <member name="M:PSFramework.Utility.Size.#ctor"> <summary> Creates an empty size. </summary> </member> <member name="M:PSFramework.Utility.Size.#ctor(System.Int64)"> <summary> Creates a size with some content </summary> <param name="Byte">The length in bytes to set the size to</param> </member> <member name="M:PSFramework.Utility.Size.CompareTo(PSFramework.Utility.Size)"> <inheritdoc cref="M:System.IComparable`1.CompareTo(`0)"/> <remarks>For sorting</remarks> </member> <member name="M:PSFramework.Utility.Size.CompareTo(System.Object)"> <inheritdoc cref="M:System.IComparable.CompareTo(System.Object)"/> <remarks>For sorting</remarks> <exception cref="T:System.ArgumentException">If you compare with something invalid.</exception> </member> <member name="M:PSFramework.Utility.Size.op_Addition(PSFramework.Utility.Size,PSFramework.Utility.Size)"> <summary> Adds two sizes </summary> <param name="a">The first size to add</param> <param name="b">The second size to add</param> <returns>The sum of both sizes</returns> </member> <member name="M:PSFramework.Utility.Size.op_Subtraction(PSFramework.Utility.Size,PSFramework.Utility.Size)"> <summary> Substracts two sizes </summary> <param name="a">The first size to substract</param> <param name="b">The second size to substract</param> <returns>The difference between both sizes</returns> </member> <member name="M:PSFramework.Utility.Size.op_Multiply(PSFramework.Utility.Size,System.Double)"> <summary> Multiplies two sizes with each other </summary> <param name="a">The size to multiply</param> <param name="b">The size to multiply with</param> <returns>A multiplied size.</returns> </member> <member name="M:PSFramework.Utility.Size.op_Division(PSFramework.Utility.Size,System.Double)"> <summary> Divides one size by another. </summary> <param name="a">The size to divide</param> <param name="b">The size to divide with</param> <returns>Divided size (note: Cut off)</returns> </member> <member name="M:PSFramework.Utility.Size.op_Multiply(PSFramework.Utility.Size,PSFramework.Utility.Size)"> <summary> Multiplies two sizes with each other </summary> <param name="a">The size to multiply</param> <param name="b">The size to multiply with</param> <returns>A multiplied size.</returns> </member> <member name="M:PSFramework.Utility.Size.op_Division(PSFramework.Utility.Size,PSFramework.Utility.Size)"> <summary> Divides one size by another. </summary> <param name="a">The size to divide</param> <param name="b">The size to divide with</param> <returns>Divided size (note: Cut off)</returns> </member> <member name="M:PSFramework.Utility.Size.op_Implicit(System.Int32)~PSFramework.Utility.Size"> <summary> Implicitly converts int to size </summary> <param name="a">The number to convert</param> </member> <member name="M:PSFramework.Utility.Size.op_Implicit(System.Decimal)~PSFramework.Utility.Size"> <summary> Implicitly converts int to size </summary> <param name="a">The number to convert</param> </member> <member name="M:PSFramework.Utility.Size.op_Implicit(PSFramework.Utility.Size)~System.Int32"> <summary> Implicitly converts size to int </summary> <param name="a">The size to convert</param> </member> <member name="M:PSFramework.Utility.Size.op_Implicit(System.Int64)~PSFramework.Utility.Size"> <summary> Implicitly converts long to size </summary> <param name="a">The number to convert</param> </member> <member name="M:PSFramework.Utility.Size.op_Implicit(PSFramework.Utility.Size)~System.Int64"> <summary> Implicitly converts size to long </summary> <param name="a">The size to convert</param> </member> <member name="M:PSFramework.Utility.Size.op_Implicit(System.String)~PSFramework.Utility.Size"> <summary> Implicitly converts string to size </summary> <param name="a">The string to convert</param> </member> <member name="M:PSFramework.Utility.Size.op_Implicit(System.Double)~PSFramework.Utility.Size"> <summary> Implicitly converts double to size </summary> <param name="a">The number to convert</param> </member> <member name="M:PSFramework.Utility.Size.op_Implicit(PSFramework.Utility.Size)~System.Double"> <summary> Implicitly converts size to double </summary> <param name="a">The size to convert</param> </member> <member name="T:PSFramework.Utility.SizeStyle"> <summary> How size objects should be displayed </summary> </member> <member name="F:PSFramework.Utility.SizeStyle.Dynamic"> <summary> The size object is styled dependend on the number stored within. </summary> </member> <member name="F:PSFramework.Utility.SizeStyle.Plain"> <summary> The size object is shown as a plain number </summary> </member> <member name="F:PSFramework.Utility.SizeStyle.Byte"> <summary> The size object is styled as a byte number </summary> </member> <member name="F:PSFramework.Utility.SizeStyle.B"> <summary> The size object is styled as a byte number </summary> </member> <member name="F:PSFramework.Utility.SizeStyle.Kilobyte"> <summary> The size object is styled as a kilobyte number </summary> </member> <member name="F:PSFramework.Utility.SizeStyle.KB"> <summary> The size object is styled as a kilobyte number </summary> </member> <member name="F:PSFramework.Utility.SizeStyle.Megabyte"> <summary> The size object is styled as a megabyte number </summary> </member> <member name="F:PSFramework.Utility.SizeStyle.MB"> <summary> The size object is styled as a megabyte number </summary> </member> <member name="F:PSFramework.Utility.SizeStyle.Gigabyte"> <summary> The size object is styled as a Gigabyte number </summary> </member> <member name="F:PSFramework.Utility.SizeStyle.GB"> <summary> The size object is styled as a Gigabyte number </summary> </member> <member name="F:PSFramework.Utility.SizeStyle.Terabyte"> <summary> The size object is styled as a Terabyte number </summary> </member> <member name="F:PSFramework.Utility.SizeStyle.TB"> <summary> The size object is styled as a Terabyte number </summary> </member> <member name="T:PSFramework.Utility.SupportData"> <summary> List of data items New-PSFSupportPackage will export </summary> </member> <member name="F:PSFramework.Utility.SupportData.None"> <summary> Nothing. Be stingy, will ya?! </summary> </member> <member name="F:PSFramework.Utility.SupportData.Message"> <summary> All messages logged to the PSFramework that are still in memory </summary> </member> <member name="F:PSFramework.Utility.SupportData.ErrorMessage"> <summary> All error records logged to the PSFramework that are still in memory </summary> </member> <member name="F:PSFramework.Utility.SupportData.Screenshot"> <summary> A "screenshot" record of the console buffer </summary> </member> <member name="F:PSFramework.Utility.SupportData.OperatingSystem"> <summary> Data about the OS, gathered from WMI </summary> </member> <member name="F:PSFramework.Utility.SupportData.CPU"> <summary> Data about the processors, gathered from WMI </summary> </member> <member name="F:PSFramework.Utility.SupportData.Ram"> <summary> Data about the ram, gathered from WMI </summary> </member> <member name="F:PSFramework.Utility.SupportData.PSVersion"> <summary> Data about the PowerShell version </summary> </member> <member name="F:PSFramework.Utility.SupportData.History"> <summary> Input history </summary> </member> <member name="F:PSFramework.Utility.SupportData.Module"> <summary> List of modules that are imported </summary> </member> <member name="F:PSFramework.Utility.SupportData.SnapIns"> <summary> List of snapins that are loaded </summary> </member> <member name="F:PSFramework.Utility.SupportData.Assemblies"> <summary> List of assmeblies that have been imported </summary> </member> <member name="F:PSFramework.Utility.SupportData.Exceptions"> <summary> All exception records written to the global $error variable </summary> </member> <member name="F:PSFramework.Utility.SupportData.ExtensionData"> <summary> Data provided by foreign modules </summary> </member> <member name="F:PSFramework.Utility.SupportData.All"> <summary> All data ill be exported </summary> </member> <member name="F:PSFramework.Utility.SupportData.Messages"> <summary> PSFramework messages </summary> </member> <member name="F:PSFramework.Utility.SupportData.Critical"> <summary> The most critical error data, including: Messages, error messages, error records and PSVersion </summary> </member> <member name="F:PSFramework.Utility.SupportData.PSResource"> <summary> PSVersion, Modules, Snapins and Assemblies </summary> </member> <member name="F:PSFramework.Utility.SupportData.Environment"> <summary> Operating System, CPU & RAM </summary> </member> <member name="T:PSFramework.Utility.Throttle"> <summary> Class implementing a throttling mechanism / watcher </summary> </member> <member name="F:PSFramework.Utility.Throttle.Limit"> <summary> The maximum number of slots per interval </summary> </member> <member name="F:PSFramework.Utility.Throttle.Interval"> <summary> The interval over which slots are limited </summary> </member> <member name="P:PSFramework.Utility.Throttle.Count"> <summary> The number of slots currently taken </summary> </member> <member name="M:PSFramework.Utility.Throttle.#ctor(System.Int32,PSFramework.Parameter.TimeSpanParameter)"> <summary> Create a new throttle object </summary> <param name="Limit">How many slots are available per interval?</param> <param name="Interval">hat is the interval over which slots are measured?</param> </member> <member name="M:PSFramework.Utility.Throttle.GetSlot(PSFramework.Parameter.TimeSpanParameter)"> <summary> Obtain an execution slots from the throttle </summary> <param name="Timeout">How long are you willing to wait for a slot before giving up?</param> </member> <member name="M:PSFramework.Utility.Throttle.Purge"> <summary> Clean up any expired slots </summary> </member> <member name="T:PSFramework.Utility.TimeRange"> <summary> Container carrying a time range. </summary> </member> <member name="F:PSFramework.Utility.TimeRange.Start"> <summary> The start time of the time range </summary> </member> <member name="F:PSFramework.Utility.TimeRange.End"> <summary> The end time of the time range </summary> </member> <member name="P:PSFramework.Utility.TimeRange.Duration"> <summary> The total duration of the time range </summary> </member> <member name="M:PSFramework.Utility.TimeRange.#ctor"> <summary> Create an empty time range </summary> </member> <member name="M:PSFramework.Utility.TimeRange.#ctor(System.DateTime)"> <summary> Create a time range with the start filled in </summary> <param name="Start">The start time of the time range</param> </member> <member name="M:PSFramework.Utility.TimeRange.#ctor(System.DateTime,System.DateTime)"> <summary> Create a fully filled out time range </summary> <param name="Start">The start time of the time range</param> <param name="End">The end time of the time range</param> </member> <member name="M:PSFramework.Utility.TimeRange.IsInRange(System.DateTime)"> <summary> Checks whether a DateTime is within the defined start and end times. </summary> <param name="Timestamp">The timestamp to validate</param> <returns>Whether the timestamp is within the defined start and end times</returns> </member> <member name="T:PSFramework.Utility.TimeRangeContainer"> <summary> A management wrapper handlign a series of TimeRanges. </summary> </member> <member name="F:PSFramework.Utility.TimeRangeContainer.TimeRanges"> <summary> The stored time ranges </summary> </member> <member name="M:PSFramework.Utility.TimeRangeContainer.Start(System.DateTime)"> <summary> Start a new time range </summary> <param name="Start">The starting point of the time range.</param> </member> <member name="M:PSFramework.Utility.TimeRangeContainer.End(System.DateTime)"> <summary> End the last open time range </summary> <param name="End">The end time of the time range</param> </member> <member name="M:PSFramework.Utility.TimeRangeContainer.IsInRange(System.DateTime)"> <summary> Tests, whether the input is within any of the stored ranges. </summary> <param name="Timestamp">The timestamp to test for being in range.</param> <returns>Whether the timestamp actually is in any of the possible ranges.</returns> </member> <member name="M:PSFramework.Utility.TimeRangeContainer.RemoveBefore(System.DateTime)"> <summary> Removes all time ranges that have ended before the specified timestamp </summary> <param name="Timestamp">The delimiting timestamp</param> </member> <member name="T:PSFramework.Utility.TypeTransformationAttribute"> <summary> Tries to convert input type into the target type, using PowerShell type coercion. Implemented to have a bool parameter accept a switch value. </summary> </member> <member name="F:PSFramework.Utility.TypeTransformationAttribute.TargetType"> <summary> The type to convert to </summary> </member> <member name="M:PSFramework.Utility.TypeTransformationAttribute.Transform(System.Management.Automation.EngineIntrinsics,System.Object)"> <summary> Converts input to output </summary> <param name="engineIntrinsics"></param> <param name="inputData"></param> <returns></returns> </member> <member name="M:PSFramework.Utility.TypeTransformationAttribute.#ctor(System.Type)"> <summary> Creates the basic attribute specifying the target type </summary> <param name="TargetType">The type to convert to</param> </member> <member name="T:PSFramework.Utility.UtilityHost"> <summary> Contains static resources of various kinds. Primarily for internal consumption. </summary> </member> <member name="F:PSFramework.Utility.UtilityHost.PrimaryRunspace"> <summary> The ID for the primary (or front end) Runspace. Used for stuff that should only happen on the user-runspace. </summary> </member> <member name="F:PSFramework.Utility.UtilityHost.SizeDigits"> <summary> The number of digits a size object shows by default </summary> </member> <member name="F:PSFramework.Utility.UtilityHost.SizeStyle"> <summary> The way size objects are usually displayed </summary> </member> <member name="F:PSFramework.Utility.UtilityHost.NumberSegmentSize"> <summary> Size of each segment before the decimal seaparator when displaying numbers </summary> </member> <member name="F:PSFramework.Utility.UtilityHost.NumberSegmentSeparator"> <summary> The seperator used inbetween each segment when displaying numbers </summary> </member> <member name="F:PSFramework.Utility.UtilityHost.NumberDecimalSeparator"> <summary> The decimal seperator when displaying numbers </summary> </member> <member name="F:PSFramework.Utility.UtilityHost.NumberDecimalDigits"> <summary> When displaying numbers, how many digits after the decimal seperator will be shown? </summary> </member> <member name="M:PSFramework.Utility.UtilityHost.IsLocalhost(System.String)"> <summary> Tests whether a given string is the local host. Does NOT use DNS resolution, DNS aliases will NOT be recognized! </summary> <param name="Name">The name to test for being local host</param> <returns>Whether the name is localhost</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.IsValidComputerTarget(System.String)"> <summary> Tests whether a given string is a valid target for targeting as a computer. Will first convert from idn name. </summary> </member> <member name="M:PSFramework.Utility.UtilityHost.IsLike(System.String,System.String,System.Boolean)"> <summary> Implement's VB's Like operator logic. </summary> </member> <member name="M:PSFramework.Utility.UtilityHost.CharListToSet(System.String)"> <summary> Converts a string of characters to a HashSet of characters. If the string contains character ranges, such as A-Z, all characters in the range are also added to the returned set of characters. </summary> <param name="charList">Character list string</param> </member> <member name="M:PSFramework.Utility.UtilityHost.CompressString(System.String)"> <summary> Compress string using default zip algorithms </summary> <param name="String">The string to compress</param> <returns>Returns a compressed string.</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.ExpandString(System.String)"> <summary> Expand a string using default zig algorithms </summary> <param name="CompressedString">The compressed string to expand</param> <returns>Returns an expanded string.</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.GetExecutionContextFromTLS"> <summary> Returns the execution context for the current runspace based on the current thread. </summary> <returns>The current execution context</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.GetRunspaces"> <summary> Returns the list of runspaces available in the process </summary> <returns>The lists of currently known runspaces</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.RemovePowerShellAlias(System.String,System.Boolean)"> <summary> Removes an alias from the global list of aliases </summary> <param name="Name">The name of the laias to kill</param> <param name="Force">Whether to remove ReadOnly items</param> </member> <member name="M:PSFramework.Utility.UtilityHost.GetPrivateProperty(System.String,System.Object)"> <summary> Returns the value of a private property on an object </summary> <param name="Name">The name of the property</param> <param name="Instance">The object from which to read the property from</param> <returns>The value of the property content (may be null)</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.SetPrivateProperty(System.String,System.Object,System.Object)"> <summary> Updates the value of a private property </summary> <param name="Name">The name of the property to update</param> <param name="Instance">The object that contains the property to update</param> <param name="Value">The value to apply</param> </member> <member name="M:PSFramework.Utility.UtilityHost.GetPublicProperty(System.String,System.Object)"> <summary> Returns the value of a public property on an object </summary> <param name="Name">The name of the property</param> <param name="Instance">The object from which to read the property from</param> <returns>The value of the property content (may be null)</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.GetPrivateStaticProperty(System.Type,System.String)"> <summary> Returns the value of a private static property on a type </summary> <param name="StaticType">The type to pick from</param> <param name="Name">The name of the property to retrieve</param> <returns>The value of the property content (may be null)</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.GetPrivateStaticField(System.Type,System.String)"> <summary> Returns the value of a private static field on a type </summary> <param name="StaticType">The type to pick from</param> <param name="Name">The name of the field to retrieve</param> <returns>The value of the field content (may be null)</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.GetPrivateField(System.String,System.Object)"> <summary> Returns the value of a private field on an object </summary> <param name="Name">The name of the field</param> <param name="Instance">The object from which to read the field from</param> <returns>The value of the field content (may be null)</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.GetPrivateStaticMethod(System.Type,System.String)"> <summary> Returns a static private method of a type </summary> <param name="StaticType">The type to search in</param> <param name="Name">The name of the method to retrieve</param> <returns>The method object requested</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.GetPrivateMethod(System.String,System.Object)"> <summary> Returns the private method on an object </summary> <param name="Name">The name of the method</param> <param name="Instance">The object from which to read the method from</param> <returns>The method sought</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.InvokePrivateMethod(System.String,System.Object,System.Object[])"> <summary> Executes a private method of an object </summary> <param name="Name">Name of the method to invoke</param> <param name="Instance">The object whose method to run</param> <param name="Arguments">Arguments to pass to the method</param> <returns>Whatever the private method may return</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.InvokePrivateStaticMethod(System.Type,System.String,System.Object[])"> <summary> Executes a static private method of a type </summary> <param name="StaticType">The type containing the method</param> <param name="Name">The name of the method to invoke</param> <param name="Arguments">The arguments to pass to the method</param> <returns>The result of the method invoked</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.InvokeConstructor(System.Type,System.Object[],System.Reflection.BindingFlags)"> <summary> Execute a constructor for the specified type, creating a new instance of it. It will try each constructor with the correct number of arguments until it finds a working one, so ... not REALLY efficient. May have side-effects when used on types that do significant logic in their constructors even when they fail. </summary> <param name="Type">The type to create an instance of.</param> <param name="Arguments">Arguments to pass to the constructor.</param> <param name="Flags">Search flags selecting the constructor. Defaults to both public and private.</param> <returns>The created instance of the type</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.InvokeConstructor``1(System.Object[],System.Reflection.BindingFlags)"> <summary> Execute a constructor for the specified type, creating a new instance of it. It will try each constructor with the correct number of arguments until it finds a working one, so ... not REALLY efficient. May have side-effects when used on types that do significant logic in their constructors even when they fail. </summary> <param name="Arguments">Arguments to pass to the constructor.</param> <param name="Flags">Search flags selecting the constructor. Defaults to both public and private.</param> <returns>The created instance of the type</returns> </member> <member name="P:PSFramework.Utility.UtilityHost.Callstack"> <summary> Returns the current callstack </summary> </member> <member name="P:PSFramework.Utility.UtilityHost.FriendlyCallstack"> <summary> Returns a user-friendly callstack representation that is a snapshot in time. </summary> </member> <member name="P:PSFramework.Utility.UtilityHost._CallstackNew"> <summary> Returns the current callstack on PS4+ </summary> </member> <member name="P:PSFramework.Utility.UtilityHost._CallstackOld"> <summary> Returns the current callstack on PS3 </summary> </member> <member name="M:PSFramework.Utility.UtilityHost.GetCallerInfo(System.Int32)"> <summary> Get information on whoever called your PowerShell code </summary> <param name="Level">How many levels to go down the script callstack</param> <returns>Metadata describing who called</returns> </member> <member name="F:PSFramework.Utility.UtilityHost.ScriptBlocks"> <summary> Stored scriptblocks that can be retrieved on demand anywhere within the process </summary> </member> <member name="M:PSFramework.Utility.UtilityHost.ImportScriptBlock(System.Management.Automation.ScriptBlock,System.Boolean)"> <summary> Imports a scriptblock into the current sessionstate, without affecting its language mode. Note: Be wary where you import to, as the thus imported code can affect local variables that might be trusted. </summary> <param name="ScriptBlock">The code to localize.</param> <param name="Global">Add the code to the global sessionstate, not the current sessionstate.</param> </member> <member name="T:PSFramework.Validation.NoResultsActionPreference"> <summary> The preference on how to deal with no legal values being returned. Used by PsfValidateSet </summary> </member> <member name="F:PSFramework.Validation.NoResultsActionPreference.Continue"> <summary> Allow to continue </summary> </member> <member name="F:PSFramework.Validation.NoResultsActionPreference.Error"> <summary> Fail in fire and blood </summary> </member> <member name="T:PSFramework.Validation.PsfValidateLanguageMode"> <summary> Validation attribute that tests a scriptblock's language mode. </summary> </member> <member name="F:PSFramework.Validation.PsfValidateLanguageMode.Modes"> <summary> The legal language modes, defaults to FullLanguage </summary> </member> <member name="M:PSFramework.Validation.PsfValidateLanguageMode.ValidateElement(System.Object)"> <summary> Validation routine used by the engine </summary> <param name="element">The object to validate must be a scriptblock.</param> </member> <member name="M:PSFramework.Validation.PsfValidateLanguageMode.#ctor"> <summary> Creates a default instance, validating for full language. </summary> </member> <member name="M:PSFramework.Validation.PsfValidateLanguageMode.#ctor(System.Management.Automation.PSLanguageMode[])"> <summary> Creates a custom instance, validating for the specified modes. </summary> <param name="Modes">The modes to test against.</param> </member> <member name="T:PSFramework.Validation.PsfValidatePatternAttribute"> <summary> Validates that each parameter argument matches the RegexPattern </summary> </member> <member name="P:PSFramework.Validation.PsfValidatePatternAttribute.RegexPattern"> <summary> Gets the Regex pattern to be used in the validation </summary> </member> <member name="P:PSFramework.Validation.PsfValidatePatternAttribute.Options"> <summary> Gets or sets the Regex options to be used in the validation </summary> </member> <member name="P:PSFramework.Validation.PsfValidatePatternAttribute.ErrorMessage"> <summary> Gets or sets the custom error message pattern that is displayed to the user. The text representation of the object being validated and the validating regex is passed as the first and second formatting parameters to the ErrorMessage formatting pattern. <example> [PsfValidatePattern("\s+", ErrorMessage="The text '{0}' did not pass validation of regex '{1}'")] </example> </summary> </member> <member name="F:PSFramework.Validation.PsfValidatePatternAttribute.ErrorString"> <summary> The stored localized string to use for error messages </summary> </member> <member name="M:PSFramework.Validation.PsfValidatePatternAttribute.ValidateElement(System.Object)"> <summary> Validates that each parameter argument matches the RegexPattern </summary> <param name="element">object to validate</param> <exception cref="T:System.Management.Automation.ValidationMetadataException">if <paramref name="element"/> is not a string that matches the pattern and for invalid arguments</exception> </member> <member name="M:PSFramework.Validation.PsfValidatePatternAttribute.#ctor(System.String)"> <summary> Initializes a new instance of the PsfValidatePatternAttribute class </summary> <param name="regexPattern">Pattern string to match</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="T:PSFramework.Validation.PsfValidatePSVersion"> <summary> Validation attribute that ensures a parameter is only used in a given PS Version </summary> </member> <member name="F:PSFramework.Validation.PsfValidatePSVersion.Version"> <summary> The minimum version required </summary> </member> <member name="F:PSFramework.Validation.PsfValidatePSVersion.FeatureName"> <summary> The name of the feature that can override this test </summary> </member> <member name="M:PSFramework.Validation.PsfValidatePSVersion.ValidateElement(System.Object)"> <summary> Validation routine used by the engine </summary> <param name="element">The object to validate does not matter and is ignored.</param> </member> <member name="M:PSFramework.Validation.PsfValidatePSVersion.#ctor(System.String)"> <summary> Create a new validation attribute with a preconfigured minimum version </summary> <param name="MinimumVersion">The minimum version required</param> </member> <member name="M:PSFramework.Validation.PsfValidatePSVersion.#ctor(System.String,System.String)"> <summary> Create a new validation attribute with a preconfigured minimum version </summary> <param name="MinimumVersion">The minimum version required</param> <param name="FeatureName">An optional featureflag that can override this validation</param> </member> <member name="T:PSFramework.Validation.PsfValidateScriptAttribute"> <summary> Class for validating against a script block. </summary> </member> <member name="P:PSFramework.Validation.PsfValidateScriptAttribute.ErrorMessage"> <summary> Gets or sets the custom error message that is displayed to the user. </summary> </member> <member name="F:PSFramework.Validation.PsfValidateScriptAttribute.ErrorString"> <summary> The stored localized string to use for error messages </summary> </member> <member name="P:PSFramework.Validation.PsfValidateScriptAttribute.ScriptBlock"> <summary> Gets the scriptblock to be used in the validation </summary> </member> <member name="P:PSFramework.Validation.PsfValidateScriptAttribute.Global"> <summary> Whether the scriptblock should be invoked as global scriptblock </summary> </member> <member name="P:PSFramework.Validation.PsfValidateScriptAttribute.ScriptBlockName"> <summary> Name of a stored scriptblock to use </summary> </member> <member name="M:PSFramework.Validation.PsfValidateScriptAttribute.ValidateElement(System.Object)"> <summary> Validates that each parameter argument matches the scriptblock </summary> <param name="element">object to validate</param> <exception cref="T:System.Management.Automation.ValidationMetadataException">if <paramref name="element"/> is invalid</exception> </member> <member name="M:PSFramework.Validation.PsfValidateScriptAttribute.#ctor(System.Management.Automation.ScriptBlock)"> <summary> Initializes a new instance of the ValidateScriptBlockAttribute class </summary> <param name="ScriptBlock">Scriptblock to match</param> <exception cref="T:System.ArgumentException">for invalid arguments</exception> </member> <member name="M:PSFramework.Validation.PsfValidateScriptAttribute.#ctor(System.String)"> <summary> Initializes a new instance of the ValidateScriptBlockAttribute class </summary> </member> <member name="T:PSFramework.Validation.PsfValidateSetAttribute"> <summary> Class for validating against a set of legal values. Set can be dynamically calculated. </summary> </member> <member name="F:PSFramework.Validation.PsfValidateSetAttribute.ScriptBlock"> <summary> &n |