New-PefKeyDownTrigger

아티클
11/16/2015

New-PefKeyDownTrigger

Creates a trigger that signals when a user presses a key.

구문

Parameter Set: Default
New-PefKeyDownTrigger [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [-Key <Char[]> ] [-Repeat] [ <CommonParameters>]

자세한 설명

The New-PefKeyDownTrigger cmdlet creates a trigger that signals when a user presses a specified key. Use the Key parameter to specify the key to initiate a trigger. You can use this keystroke trigger to start or stop a Protocol Engineering Framework (PEF) Trace Session. The trigger becomes active when you associate it with a PEF action.

매개 변수

-InformationAction<System.Management.Automation.ActionPreference>

Specifies how this cmdlet responds to an information event. 이 매개 변수에 허용되는 값은 다음과 같습니다.

-- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend

별칭	infa
필수 여부	false
위치	named
기본값	none
파이프라인 입력 적용 여부	false
와일드카드 문자 허용 여부	false

-InformationVariable<System.String>

Specifies a variable in which to store an information event message.

별칭	iv
필수 여부	false
위치	named
기본값	none
파이프라인 입력 적용 여부	false
와일드카드 문자 허용 여부	false

-Key<Char[]>

Specifies a key to initiate a trigger. Note that Ctrl+C is no longer supported.

별칭	none
필수 여부	false
위치	named
기본값	none
파이프라인 입력 적용 여부	false
와일드카드 문자 허용 여부	false

-Repeat

Indicates that the trigger runs on each occurrence of the keyboard input that you specify. If you do not specify this parameter, the trigger runs only once.

별칭	none
필수 여부	false
위치	named
기본값	none
파이프라인 입력 적용 여부	false
와일드카드 문자 허용 여부	false

<CommonParameters>

이 cmdlet은 일반 매개 변수 -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer 및 -OutVariable을 지원합니다. 자세한 내용은 다음을 참조하세요. about_CommonParameters(https://go.microsoft.com/fwlink/p/?LinkID=113216).

입력

입력 유형은 cmdlet에 파이프할 수 있는 개체의 유형입니다.

출력

출력 유형은 cmdlet이 내보내는 개체의 유형입니다.

예제

Example 1: Save the contents of a Trace Session with a key down trigger

This example creates a PEF Trace Session that you can save at any time by using the keyboard S key as a shortcut.

The first command uses the New-PefTraceSession cmdlet to create a Trace Session that runs in the Circular mode, and stores a Trace Session object in the $TraceSession01 variable.

The second command uses the Add-PefMessageSource cmdlet to add the specified message trace source.

The third command uses the current cmdlet to create a trigger based on the keyboard shortcut S and stores it in the $Trigger01 variable.

The fourth command creates a save action for the Trace Session stored in the $TraceSession01 variable, which uses the trigger specified in the $Trigger01 variable. The command also specifies a name for the trace file to save. In addition, the command uses the Force parameter and therefore does not prompt you before replacing an existing file.

The final command uses the Start-PefTraceSession cmdlet to start the session.

PS C:\> $TraceSession01 = New-PefTraceSession -Mode Circular -SaveOnStop
PS C:\> Add-PefMessageSource -PEFSession $TraceSession01 –Source "Microsoft-Pef-WFP-MessageProvider"
PS C:\> $Trigger01 = New-PefKeyDownTrigger -Key S
PS C:\> Save-PefDataCollection -PEFSession $TraceSession01 -Path "C:\Traces\Trace01.matu" -Force -Trigger $Trigger01
PS C:\> Start-PefTraceSession -PEFSession $TraceSession01

New-PefKeyDownTrigger