PowerShell/Docs/what-is.md
2022-12-04 10:40:18 +01:00

84 lines
1.9 KiB
Markdown

## The *what-is.ps1* Script
This PowerShell script prints a description of the given abbreviation.
## Parameters
```powershell
what-is.ps1 [[-abbreviation] <String>] [<CommonParameters>]
-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
PS> ./what-is IAS
```
## Notes
Author: Markus Fleschutz | License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
## Source Code
```powershell
<#
.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)
& "$PSScriptRoot/speak-english.ps1" "$Text"
}
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
}
```
*Generated by convert-ps2md.ps1 using the comment-based help of what-is.ps1*