PowerShell/Docs/save-screenshot.md

96 lines
3.2 KiB
Markdown
Raw Normal View History

2022-12-04 10:40:18 +01:00
## The *save-screenshot.ps1* Script
2021-11-08 21:36:42 +01:00
2023-05-26 12:20:18 +02:00
This PowerShell script takes a single screenshot and saves it into a target folder (default is the user's screenshots folder).
2021-11-08 21:36:42 +01:00
## Parameters
```powershell
2023-05-26 12:20:18 +02:00
/home/mf/Repos/PowerShell/Scripts/save-screenshot.ps1 [[-TargetFolder] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
-TargetFolder <String>
2023-05-26 12:20:18 +02:00
Specifies the target folder (the user's screenshots folder by default)
2021-11-08 21:36:42 +01:00
Required? false
Position? 1
2023-05-26 12:20:18 +02:00
Default value
2021-11-08 21:36:42 +01:00
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS> ./save-screenshot
2023-05-26 12:20:18 +02:00
✔️ screenshot saved to C:\Users\Markus\Pictures\Screenshots\2021-10-10T14-33-22.png
2021-11-08 21:36:42 +01:00
```
## Notes
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
## Related Links
https://github.com/fleschutz/PowerShell
2022-11-17 20:02:26 +01:00
## Source Code
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Saves a single screenshot
.DESCRIPTION
2023-05-26 12:20:18 +02:00
This PowerShell script takes a single screenshot and saves it into a target folder (default is the user's screenshots folder).
2022-11-17 20:02:26 +01:00
.PARAMETER TargetFolder
2023-05-26 12:20:18 +02:00
Specifies the target folder (the user's screenshots folder by default)
2022-11-17 20:02:26 +01:00
.EXAMPLE
PS> ./save-screenshot
2023-05-26 12:20:18 +02:00
✔️ screenshot saved to C:\Users\Markus\Pictures\Screenshots\2021-10-10T14-33-22.png
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
2023-05-26 12:20:18 +02:00
param([string]$TargetFolder = "")
function GetScreenshotsFolder {
if ($IsLinux) {
$Path = "$HOME/Pictures"
if (-not(Test-Path "$Path" -pathType container)) { throw "Pictures folder at $Path doesn't exist (yet)"}
if (Test-Path "$Path/Screenshots" -pathType container) { $Path = "$Path/Screenshots" }
} else {
$Path = [Environment]::GetFolderPath('MyPictures')
if (-not(Test-Path "$Path" -pathType container)) { throw "Pictures folder at $Path doesn't exist (yet)" }
if (Test-Path "$Path\Screenshots" -pathType container) { $Path = "$Path\Screenshots" }
}
return $Path
}
2022-11-17 20:02:26 +01:00
function TakeScreenshot { param([string]$FilePath)
Add-Type -Assembly System.Windows.Forms
$ScreenBounds = [Windows.Forms.SystemInformation]::VirtualScreen
$ScreenshotObject = New-Object Drawing.Bitmap $ScreenBounds.Width, $ScreenBounds.Height
$DrawingGraphics = [Drawing.Graphics]::FromImage($ScreenshotObject)
$DrawingGraphics.CopyFromScreen( $ScreenBounds.Location, [Drawing.Point]::Empty, $ScreenBounds.Size)
$DrawingGraphics.Dispose()
$ScreenshotObject.Save($FilePath)
$ScreenshotObject.Dispose()
}
try {
2023-05-26 12:20:18 +02:00
if ("$TargetFolder" -eq "") { $TargetFolder = GetScreenshotsFolder }
2022-11-17 20:02:26 +01:00
$Time = (Get-Date)
$Filename = "$($Time.Year)-$($Time.Month)-$($Time.Day)T$($Time.Hour)-$($Time.Minute)-$($Time.Second).png"
$FilePath = (Join-Path $TargetFolder $Filename)
TakeScreenshot $FilePath
"✔️ screenshot saved to $FilePath"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2021-11-08 21:36:42 +01:00
*Generated by convert-ps2md.ps1 using the comment-based help of save-screenshot.ps1*