Skip to content

Commit

Permalink
Add link to RestorePointType docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sdwheeler committed Jul 12, 2024
1 parent 47e199b commit 5a2bb10
Showing 1 changed file with 29 additions and 21 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Management
ms.date: 06/09/2017
ms.date: 07/12/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.management/checkpoint-computer?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Checkpoint-Computer
Expand All @@ -22,9 +22,9 @@ Checkpoint-Computer [-Description] <String> [[-RestorePointType] <String>] [<Com

The `Checkpoint-Computer` cmdlet creates a system restore point on the local computer.

System restore points and the `Checkpoint-Computer` cmdlet are supported only on client operating systems, such as Windows 8, Windows 7, Windows Vista, and Windows XP.

Beginning in Windows 8, `Checkpoint-Computer` cannot create more than one checkpoint each day.
System restore points and the `Checkpoint-Computer` cmdlet are supported only on client operating
systems, such as Windows 10 or Windows 11. `Checkpoint-Computer` cannot create more than one
checkpoint each day.

## EXAMPLES

Expand All @@ -34,23 +34,22 @@ Beginning in Windows 8, `Checkpoint-Computer` cannot create more than one checkp
Checkpoint-Computer -Description "Install MyApp"
```

This command creates a system restore point called Install MyApp.
It uses the default APPLICATION_INSTALL restore point type.
This command creates a system restore point called Install MyApp. It uses the default
`APPLICATION_INSTALL` restore point type.

### Example 2: Create a system MODIFY_SETTINGS restore point

```powershell
Checkpoint-Computer -Description "ChangeNetSettings" -RestorePointType MODIFY_SETTINGS
```

This command creates a MODIFY_SETTINGS system restore point called "ChangeNetSettings".
This command creates a `MODIFY_SETTINGS` system restore point called "ChangeNetSettings".

## PARAMETERS

### -Description

Specifies a descriptive name for the restore point.
This parameter is required.
Specifies a descriptive name for the restore point. This parameter is required.

```yaml
Type: System.String
Expand All @@ -66,16 +65,19 @@ Accept wildcard characters: False
### -RestorePointType
Specifies the type of restore point.
The default is APPLICATION_INSTALL.
Specifies the type of restore point. The default is `APPLICATION_INSTALL`.

The acceptable values for this parameter are:

- APPLICATION_INSTALL
- APPLICATION_UNINSTALL
- DEVICE_DRIVER_INSTALL
- MODIFY_SETTINGS
- CANCELLED_OPERATION
- `APPLICATION_INSTALL`
- `APPLICATION_UNINSTALL`
- `DEVICE_DRIVER_INSTALL`
- `MODIFY_SETTINGS`
- `CANCELLED_OPERATION`

The cmdlet accepts `CANCELLED_OPERATION` but this type of restore point operation is no longer
supported. For more information about these types, see the
[Restore Point Description Text](windows/win32/sr/restore-point-description-text) documentation.

```yaml
Type: System.String
Expand All @@ -92,7 +94,10 @@ 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](../Microsoft.PowerShell.Core/About/about_CommonParameters.md).
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
-WarningAction, and -WarningVariable. For more information, see
[about_CommonParameters](../Microsoft.PowerShell.Core/About/about_CommonParameters.md).

## INPUTS

Expand All @@ -108,11 +113,14 @@ This cmdlet does not generate any output.

## NOTES

- This cmdlet uses the **CreateRestorePoint** method of the **SystemRestore** class with a **BEGIN_SYSTEM_CHANGE** event.
- Beginning in Windows 8, `Checkpoint-Computer` cannot create more than one system restore point each day. If you try to create a new restore point before the 24-hour period has elapsed, Windows PowerShell generates the following error:
- This cmdlet uses the **CreateRestorePoint** method of the **SystemRestore** class with a
**BEGIN_SYSTEM_CHANGE** event.
- Beginning in Windows 8, `Checkpoint-Computer` cannot create more than one system restore point
each day. If you try to create a new restore point before the 24-hour period has elapsed, Windows
PowerShell generates the following error:

`"A new system restore point cannot be created because one has already been created within the past 24 hours.
Please try again later."`
`"A new system restore point cannot be created because one has already been created within the
past 24 hours. Please try again later."`

## RELATED LINKS

Expand Down

0 comments on commit 5a2bb10

Please sign in to comment.