MeasureSize.dll-Help.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
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Measure-DriveSize</command:name>
      <command:verb>Measure</command:verb>
      <command:noun>DriveSize</command:noun>
      <maml:description>
        <maml:para>Gets the used, free and total space for each drive.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Gets the used, free and total space for each drive.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Measure-DriveSize</maml:name>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters />
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>MeasureSizeModule.DriveSize</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>Properties: * `Drive` - System.IO.DriveInfo (https://docs.microsoft.com/en-us/dotnet/api/system.io.driveinfo)for given drive * `UsedSpace` - total used space in bytes</maml:para>
          <maml:para>* `FreeSpace` - total free space in bytes</maml:para>
          <maml:para>* `TotalSize` - total drive space in bytes (free + used)</maml:para>
          <maml:para>* `UsedPercentage` - percentage of used disk space (`0.0` - `1.0`)</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para></maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Measure-DriveSize</dev:code>
        <dev:remarks>
          <maml:para>Get space statistics for all drives</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Measure-DriveSize | where UsedPercentage -lt 0.7</dev:code>
        <dev:remarks>
          <maml:para>Filter drives by used percentage</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks />
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Measure-ItemSize</command:name>
      <command:verb>Measure</command:verb>
      <command:noun>ItemSize</command:noun>
      <maml:description>
        <maml:para>Computes the size of the file system items.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Computes the size of the file system items.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Measure-ItemSize</maml:name>
        <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none">
          <maml:name>Path</maml:name>
          <maml:Description>
            <maml:para>Path to the file or directory. Can be a wildcard. If not specified then the default value of "*" is used - it is it will compute the size of each item in current directory. If the path points to something that is not file system item, like variable or registry key then error will be written to the error stream.</maml:para>
          </maml:Description>
          <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
          <dev:type>
            <maml:name>String[]</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>*</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none">
        <maml:name>Path</maml:name>
        <maml:Description>
          <maml:para>Path to the file or directory. Can be a wildcard. If not specified then the default value of "*" is used - it is it will compute the size of each item in current directory. If the path points to something that is not file system item, like variable or registry key then error will be written to the error stream.</maml:para>
        </maml:Description>
        <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
        <dev:type>
          <maml:name>String[]</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>*</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>System.String[]</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>MeasureSizeModule.ItemSize</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>Properties: * `Item` - FileInfo (https://docs.microsoft.com/en-us/dotnet/api/system.io.fileinfo) or [DirectoryInfo](https://docs.microsoft.com/en-us/dotnet/api/system.io.directoryinfo)for given item * `Size` - size of the item in bytes</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para></maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Measure-ItemSize</dev:code>
        <dev:remarks>
          <maml:para>Compute size of all folders and files in current directory</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Get-ChildItem -Recurse -Include Debug,*.pdb | Measure-ItemSize</dev:code>
        <dev:remarks>
          <maml:para>Compute sizes for items returned by other cmdlet</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 3 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Measure-ItemSize | where Size -gt 1KB</dev:code>
        <dev:remarks>
          <maml:para>Filter items by size</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks />
  </command:command>
</helpItems>