diff --git a/reference/5.1/Microsoft.PowerShell.Utility/Register-EngineEvent.md b/reference/5.1/Microsoft.PowerShell.Utility/Register-EngineEvent.md index 7204b26c087..97ba0484036 100644 --- a/reference/5.1/Microsoft.PowerShell.Utility/Register-EngineEvent.md +++ b/reference/5.1/Microsoft.PowerShell.Utility/Register-EngineEvent.md @@ -2,7 +2,7 @@ external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Utility -ms.date: 12/12/2022 +ms.date: 01/13/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/register-engineevent?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 title: Register-EngineEvent @@ -16,8 +16,9 @@ Subscribes to events that are generated by the PowerShell engine and by the `New ## SYNTAX ``` -Register-EngineEvent [-SourceIdentifier] [[-Action] ] [-MessageData ] - [-SupportEvent] [-Forward] [-MaxTriggerCount ] [] +Register-EngineEvent [-SourceIdentifier] [[-Action] ] + [-MessageData ] [-SupportEvent] [-Forward] [-MaxTriggerCount ] + [] ``` ## DESCRIPTION @@ -80,7 +81,7 @@ data to a text file. ```powershell Register-EngineEvent -SourceIdentifier MyEventSource -Action { - "Event: {0}" -f $event.messagedata | Out-File c:\temp\MyEvents.txt -Append + "Event: {0}" -f $event.MessageData | Out-File c:\temp\MyEvents.txt -Append } Start-Job -Name TestJob -ScriptBlock { @@ -88,7 +89,11 @@ Start-Job -Name TestJob -ScriptBlock { Register-EngineEvent -SourceIdentifier MyEventSource -Forward Start-Sleep -seconds 2 "Doing some work..." - New-Event -SourceIdentifier MyEventSource -Message ("{0} - Work done..." -f (Get-Date)) + $newEventSplat = @{ + SourceIdentifier = 'MyEventSource' + MessageData = ("{0} - Work done..." -f (Get-Date)) + } + New-Event @newEventSplat } } Start-Sleep -seconds 4 @@ -209,8 +214,8 @@ Accept wildcard characters: False ### -MessageData -Specifies additional data associated with the event. The value of this parameter appears in the -**MessageData** property of the event object. +This parameter is part of the base class for all Event cmdlets. The `Register-EngineEvent` doesn't +use this parameter. Any data passed to this parameter is ignored. ```yaml Type: System.Management.Automation.PSObject diff --git a/reference/7.4/Microsoft.PowerShell.Utility/Register-EngineEvent.md b/reference/7.4/Microsoft.PowerShell.Utility/Register-EngineEvent.md index 749e08c402d..35b2702c918 100644 --- a/reference/7.4/Microsoft.PowerShell.Utility/Register-EngineEvent.md +++ b/reference/7.4/Microsoft.PowerShell.Utility/Register-EngineEvent.md @@ -2,7 +2,7 @@ external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Utility -ms.date: 12/12/2022 +ms.date: 01/13/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/register-engineevent?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 title: Register-EngineEvent @@ -16,8 +16,9 @@ Subscribes to events that are generated by the PowerShell engine and by the `New ## SYNTAX ``` -Register-EngineEvent [-SourceIdentifier] [[-Action] ] [-MessageData ] - [-SupportEvent] [-Forward] [-MaxTriggerCount ] [] +Register-EngineEvent [-SourceIdentifier] [[-Action] ] + [-MessageData ] [-SupportEvent] [-Forward] [-MaxTriggerCount ] + [] ``` ## DESCRIPTION @@ -80,7 +81,7 @@ data to a text file. ```powershell Register-EngineEvent -SourceIdentifier MyEventSource -Action { - "Event: {0}" -f $event.messagedata | Out-File c:\temp\MyEvents.txt -Append + "Event: {0}" -f $event.MessageData | Out-File c:\temp\MyEvents.txt -Append } Start-Job -Name TestJob -ScriptBlock { @@ -88,7 +89,11 @@ Start-Job -Name TestJob -ScriptBlock { Register-EngineEvent -SourceIdentifier MyEventSource -Forward Start-Sleep -seconds 2 "Doing some work..." - New-Event -SourceIdentifier MyEventSource -Message ("{0} - Work done..." -f (Get-Date)) + $newEventSplat = @{ + SourceIdentifier = 'MyEventSource' + MessageData = ("{0} - Work done..." -f (Get-Date)) + } + New-Event @newEventSplat } } Start-Sleep -seconds 4 @@ -209,8 +214,8 @@ Accept wildcard characters: False ### -MessageData -Specifies additional data associated with the event. The value of this parameter appears in the -**MessageData** property of the event object. +This parameter is part of the base class for all Event cmdlets. The `Register-EngineEvent` doesn't +use this parameter. Any data passed to this parameter is ignored. ```yaml Type: System.Management.Automation.PSObject diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Register-EngineEvent.md b/reference/7.5/Microsoft.PowerShell.Utility/Register-EngineEvent.md index 03a3db54e50..a49ffd86caa 100644 --- a/reference/7.5/Microsoft.PowerShell.Utility/Register-EngineEvent.md +++ b/reference/7.5/Microsoft.PowerShell.Utility/Register-EngineEvent.md @@ -2,7 +2,7 @@ external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Utility -ms.date: 12/12/2022 +ms.date: 01/13/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/register-engineevent?view=powershell-7.5&WT.mc_id=ps-gethelp schema: 2.0.0 title: Register-EngineEvent @@ -16,8 +16,9 @@ Subscribes to events that are generated by the PowerShell engine and by the `New ## SYNTAX ``` -Register-EngineEvent [-SourceIdentifier] [[-Action] ] [-MessageData ] - [-SupportEvent] [-Forward] [-MaxTriggerCount ] [] +Register-EngineEvent [-SourceIdentifier] [[-Action] ] + [-MessageData ] [-SupportEvent] [-Forward] [-MaxTriggerCount ] + [] ``` ## DESCRIPTION @@ -80,7 +81,7 @@ data to a text file. ```powershell Register-EngineEvent -SourceIdentifier MyEventSource -Action { - "Event: {0}" -f $event.messagedata | Out-File c:\temp\MyEvents.txt -Append + "Event: {0}" -f $event.MessageData | Out-File c:\temp\MyEvents.txt -Append } Start-Job -Name TestJob -ScriptBlock { @@ -88,7 +89,11 @@ Start-Job -Name TestJob -ScriptBlock { Register-EngineEvent -SourceIdentifier MyEventSource -Forward Start-Sleep -seconds 2 "Doing some work..." - New-Event -SourceIdentifier MyEventSource -Message ("{0} - Work done..." -f (Get-Date)) + $newEventSplat = @{ + SourceIdentifier = 'MyEventSource' + MessageData = ("{0} - Work done..." -f (Get-Date)) + } + New-Event @newEventSplat } } Start-Sleep -seconds 4 @@ -209,8 +214,8 @@ Accept wildcard characters: False ### -MessageData -Specifies additional data associated with the event. The value of this parameter appears in the -**MessageData** property of the event object. +This parameter is part of the base class for all Event cmdlets. The `Register-EngineEvent` doesn't +use this parameter. Any data passed to this parameter is ignored. ```yaml Type: System.Management.Automation.PSObject