Skip to content

Commit b14817a

Browse files
committed
Added comment-based help entries for Get/Set/Test
1 parent 4ea3cb5 commit b14817a

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

DSCResources/MSFT_xVirtualMemory/MSFT_xVirtualMemory.psm1

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
<#
2+
.SYNOPSIS
3+
Returns the current state of the virtual memory configuration
4+
.PARAMETER Drive
5+
The drive for which the virtual memory configuration needs to be returned
6+
.PARAMETER Type
7+
The type of the virtual memory configuration
8+
#>
19
function Get-TargetResource
210
{
311
[CmdletBinding()]
@@ -60,6 +68,18 @@ function Get-TargetResource
6068
$returnValue
6169
}
6270

71+
<#
72+
.SYNOPSIS
73+
Sets the virtual memory settings based on the parameters supplied
74+
.PARAMETER Drive
75+
The drive for which the virtual memory configuration should be set.
76+
.PARAMETER Type
77+
The paging type. When set to AutoManagePagingFile, drive letters are ignored
78+
.PARAMETER InitialSize
79+
The initial page file size in megabyte
80+
.PARAMETER MaximumSize
81+
The maximum page file size in megabyte. May not be smaller than InitialSize
82+
#>
6383
function Set-TargetResource
6484
{
6585
[CmdletBinding()]
@@ -239,6 +259,18 @@ function Set-TargetResource
239259
}
240260
}
241261

262+
<#
263+
.SYNOPSIS
264+
Tests if virtual memory settings need to be applied based on the parameters supplied
265+
.PARAMETER Drive
266+
The drive letter that should be tested
267+
.PARAMETER Type
268+
The type of the virtual memory configuration
269+
.PARAMETER InitialSize
270+
The initial page file size in megabyte
271+
.PARAMETER MaximumSize
272+
The maximum page file size in megabyte
273+
#>
242274
function Test-TargetResource
243275
{
244276
[CmdletBinding()]

0 commit comments

Comments
 (0)