Skip to content

Test-ArchiveSettings

SYNOPSIS

Tests the archive settings.

SYNTAX

1
Test-ArchiveSettings [-Settings] <PSObject> [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

The Test-ArchiveSettings function checks that if the 'directory' key is null, we use a default value.

EXAMPLES

EXAMPLE 1

1
Test-ArchiveSettings -Settings $ArchiveSettings

PARAMETERS

-ProgressAction

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.

The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.

1
2
3
4
5
6
7
8
9
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Settings

Object with settings for the archive.

1
2
3
4
5
6
7
8
9
Type: PSObject
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

PSCustomObject

OUTPUTS

None. This function returns no output.

NOTES