PowerShell/Docs/what-is.md

84 lines
1.9 KiB
Markdown
Raw Normal View History

2022-12-04 10:40:18 +01:00
## The *what-is.ps1* Script
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script prints a description of the given abbreviation.
2021-11-08 21:36:42 +01:00
## Parameters
```powershell
2021-12-09 16:19:09 +01:00
what-is.ps1 [[-abbreviation] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
-abbreviation <String>
Specifies the appreviation to look for
Required? false
Position? 1
Default value
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
2021-12-09 16:19:09 +01:00
PS> ./what-is IAS
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
Prints a description of an abbreviation
.DESCRIPTION
This PowerShell script prints a description of the given abbreviation.
.PARAMETER abbreviation
Specifies the appreviation to look for
.EXAMPLE
PS> ./what-is IAS
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$abbreviation = "")
function Reply { param([string]$Text)
2022-11-18 17:02:20 +01:00
& "$PSScriptRoot/speak-english.ps1" "$Text"
2022-11-17 20:02:26 +01:00
}
try {
if ($abbreviation -eq "" ) { $abbreviation = read-host "Enter the abbreviation" }
$FoundOne = $false
$Files = (get-childItem "$PSScriptRoot/../Data/Abbr/*.csv")
foreach ($File in $Files) {
$Table = import-csv "$File"
foreach($Row in $Table) {
if ($Row.Abbr -eq $abbreviation) {
$Basename = (get-item "$File").Basename
Reply "In $Basename $($Row.Abbr) may refer to $($Row.Term)"
$FoundOne = $true
}
}
}
if ($FoundOne -eq $false) { Reply "Sorry, no database entry found." }
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 what-is.ps1*