PowerShell/Docs/what-is.md

84 lines
1.9 KiB
Markdown
Raw Normal View History

2023-07-29 10:34:04 +02:00
*what-is.ps1*
================
2021-11-08 21:36:42 +01:00
2023-05-26 12:20:18 +02:00
This PowerShell script queries the description of the given abbreviation and prints it.
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2021-11-08 21:36:42 +01:00
```powershell
2023-07-29 10:15:44 +02:00
PS> ./what-is.ps1 [[-abbr] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
2023-05-26 12:20:18 +02:00
-abbr <String>
Specifies the abbreviation to look for
2021-11-08 21:36:42 +01:00
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.
```
2023-07-29 10:04:38 +02:00
Example
-------
2021-11-08 21:36:42 +01:00
```powershell
2021-12-09 16:19:09 +01:00
PS> ./what-is IAS
2021-11-08 21:36:42 +01:00
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Related Links
-------------
2021-11-08 21:36:42 +01:00
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
2023-05-26 12:20:18 +02:00
Explains an abbreviation
2022-11-17 20:02:26 +01:00
.DESCRIPTION
2023-05-26 12:20:18 +02:00
This PowerShell script queries the description of the given abbreviation and prints it.
.PARAMETER abbr
Specifies the abbreviation to look for
2022-11-17 20:02:26 +01:00
.EXAMPLE
PS> ./what-is IAS
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
2023-05-26 12:20:18 +02:00
param([string]$abbr = "")
2022-11-17 20:02:26 +01:00
try {
2023-05-26 12:20:18 +02:00
if ($abbr -eq "" ) { $abbr = Read-Host "Enter the abbreviation" }
2022-11-17 20:02:26 +01:00
2023-05-26 12:20:18 +02:00
$Files = (Get-ChildItem "$PSScriptRoot/../Data/Abbr/*.csv")
[int]$Matches = 0
foreach($File in $Files) {
$Table = Import-CSV "$File"
2022-11-17 20:02:26 +01:00
foreach($Row in $Table) {
2023-05-26 12:20:18 +02:00
if ($Row.ABBR -eq $abbr) {
$Basename = (Get-Item "$File").Basename -Replace "_"," "
2023-07-29 09:45:37 +02:00
"💡 $($Row.ABBR) in $Basename refers to: $($Row.MEANING)"
2023-05-26 12:20:18 +02:00
$Matches++
2022-11-17 20:02:26 +01:00
}
}
}
2023-05-26 12:20:18 +02:00
if ($Matches -eq 0) { "Sorry, '$abbr' is missing in the database." }
2022-11-17 20:02:26 +01:00
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
2023-08-06 21:36:33 +02:00
*(generated by convert-ps2md.ps1 using the comment-based help of what-is.ps1 as of 08/06/2023 21:36:18)*