Register-ArgumentCompleter

구문

Register-ArgumentCompleter
        -CommandName <String[]>
        -ScriptBlock <ScriptBlock>
        [-Native]
        [<CommonParameters>]

Register-ArgumentCompleter
        [-CommandName <String[]>]
        -ParameterName <String>
        -ScriptBlock <ScriptBlock>
        [<CommonParameters>]

Description

cmdlet은 Register-ArgumentCompleter 사용자 지정 인수 완료자를 등록합니다. 인수 완성기를 사용하면 지정한 명령에 대해 런타임에 동적 탭 완성을 제공할 수 있습니다.

CommandName 매개 변수와 ParameterName 또는 네이티브 매개 변수 없이 이 명령을 호출하면 네이티브 매개 변수를 지정한 것처럼 명령이 실행됩니다. 이렇게 하면 인수 완료자에서 PowerShell 명령 매개 변수가 작동하지 않습니다. PowerShell 명령에 대한 인수 완료자를 등록하려면 항상 ParameterName 매개 변수를 지정합니다.

예제

예제 1: 사용자 지정 인수 완료자 등록

다음 예제에서는 cmdlet의 Id 매개 변수에 대한 인수 완료자를 Set-TimeZone 등록합니다.

$s = {
    param(
        $commandName,
        $parameterName,
        $wordToComplete,
        $commandAst,
        $fakeBoundParameters
    )

    (Get-TimeZone -ListAvailable).Id | Where-Object {
        $_ -like "$wordToComplete*"
    } | ForEach-Object {
        "'$_'"
    }
}

Register-ArgumentCompleter -CommandName Set-TimeZone -ParameterName Id -ScriptBlock $s

첫 번째 명령은 사용자가 Tab 키를 누를 때 전달되는 필수 매개 변수를 사용하는 스크립트 블록을 만듭니다. 자세한 내용은 ScriptBlock 매개 변수 설명을 참조하세요.

스크립트 블록 내에서 id에 사용할 수 있는 값은 cmdlet을 Get-TimeZone 사용하여 검색됩니다. 각 표준 시간대의 ID 속성은 cmdlet에 Where-Object 파이프됩니다. cmdlet은 Where-Object 사용자가 Tab 키를 누르기 전에 입력한 텍스트를 나타내는 제공된 $wordToComplete값으로 시작되지 않는 모든 ID를 필터링합니다. 필터링된 ID는 cmdlet에 ForEach-Object 파이프되어 각 값을 따옴표로 묶어 공백이 포함된 값을 처리합니다.

두 번째 명령은 scriptblock, ParameterName ID 및 CommandName 을 전달하여 인수 완료자를 등록합니다Set-TimeZone.

예제 2: 탭 완성 값에 세부 정보 추가

다음 예제에서는 cmdlet의 Name 매개 변수에 대한 탭 완성을 Stop-Service 덮어쓰고 실행 중인 서비스만 반환합니다.

$s = {
    param(
        $commandName,
        $parameterName,
        $wordToComplete,
        $commandAst,
        $fakeBoundParameters
    )

    $services = Get-Service | Where-Object {
        $_.Status -eq 'Running' -and $_.Name -like "$wordToComplete*"
    }

    $services | ForEach-Object {
        New-Object -Type System.Management.Automation.CompletionResult -ArgumentList @(
            $_.Name          # completionText
            $_.Name          # listItemText
            'ParameterValue' # resultType
            $_.Name          # toolTip
        )
    }
}

Register-ArgumentCompleter -CommandName Stop-Service -ParameterName Name -ScriptBlock $s

첫 번째 명령은 사용자가 Tab 키를 누를 때 전달되는 필수 매개 변수를 사용하는 스크립트 블록을 만듭니다. 자세한 내용은 ScriptBlock 매개 변수 설명을 참조하세요.

스크립트 블록 내에서 첫 번째 명령은 cmdlet을 사용하여 Where-Object 실행 중인 모든 서비스를 검색합니다. 서비스는 cmdlet에 ForEach-Object 파이프됩니다. cmdlet은 ForEach-Object 새 System.Management.Automation.CompletionResult 개체를 만들고 현재 서비스의 이름(파이프라인 변수 $_.Name로 표시됨)으로 채웁니다.

CompletionResult 개체를 사용하면 반환된 각 값에 대한 추가 세부 정보를 제공할 수 있습니다.

• completionText (String) - 자동 완성 결과로 사용할 텍스트입니다. 명령으로 전송되는 값입니다.
• listItemText(String) - 사용자가 Ctrl+스페이스를 누를 때와 같이 목록에 표시할 텍스트입니다. PowerShell은 표시에만 사용합니다. 이 명령은 선택할 때 명령에 전달되지 않습니다.
• resultType (CompletionResultType) - 완료 결과의 형식입니다.
• toolTip (String) - 개체에 대해 표시할 세부 정보가 포함된 도구 설명의 텍스트입니다. Ctrl+스페이스바를 누른 후 사용자가 항목을 선택할 때 표시됩니다.

예제 3: 사용자 지정 네이티브 인수 완료자 등록

네이티브 매개 변수를 사용하여 네이 티브 명령에 대한 탭 완성을 제공할 수 있습니다. 다음 예제에서는 CLI(명령줄 인터페이스)에 대한 탭 완성을 dotnet 추가합니다.

$scriptblock = {
    param(
        $wordToComplete,
        $commandAst,
        $cursorPosition
    )

    dotnet complete --position $cursorPosition $commandAst.ToString() | ForEach-Object {
        [System.Management.Automation.CompletionResult]::new(
            $_,               # completionText
            $_,               # listItemText
            'ParameterValue', # resultType
            $_                # toolTip
        )
    }
}

Register-ArgumentCompleter -Native -CommandName dotnet -ScriptBlock $scriptblock

첫 번째 명령은 사용자가 Tab 키를 누를 때 전달되는 필수 매개 변수를 사용하는 스크립트 블록을 만듭니다. 자세한 내용은 ScriptBlock 매개 변수 설명을 참조하세요.

스크립트 블록 dotnet complete 내에서 명령은 탭 완성을 수행합니다. 결과는 System.Management.Automation.CompletionResult 클래스의 새 정적 메서드를 사용하여 각 값에 대한 CompletionResult 개체를 만드는 cmdlet에 파이프 ForEach-Object 됩니다.

매개 변수

-CommandName

-Native

-ParameterName

-ScriptBlock

입력

None

개체를 이 cmdlet으로 파이프할 수 없습니다.

출력

None

이 cmdlet은 출력을 반환하지 않습니다.

관련 링크

• about_Functions_Argument_Completion