Compartilhar via

about_Function_Provider

  • Artigo

Nome do provedor

Função

Unidades

Function:

Funcionalidades

ShouldProcess

Descrição breve

Fornece acesso às funções definidas no PowerShell.

Descrição detalhada

O provedor de funções do PowerShell permite que você obtenha, adicione, altere, limpe e exclua as funções e filtros no PowerShell.

Uma função é um bloco nomeado de código que executa uma ação. Quando você digita o nome da função, o código na função é executado. Um filtro é um bloco de código nomeado que estabelece as condições para uma ação. Você pode digitar o nome do filtro no lugar da condição, como em um Where-Object comando.

A unidade de função é um namespace simples que contém apenas a função e os objetos de filtro. Nem funções nem filtros possuem itens filhos.

O provedor de funções dá suporte aos cmdlets a seguir, que são abordados neste artigo.

Tipos expostos por esse provedor

Cada função é uma instância da classe System.Management.Automation.FunctionInfo . Cada filtro é uma instância da classe System.Management.Automation.FilterInfo .

O provedor de funções expõe seu armazenamento de dados na Function: unidade. Para trabalhar com funções, você pode alterar sua localização para a Function: unidade (Set-Location Function:). Ou você pode trabalhar em outra unidade do PowerShell. Para fazer referência a uma função de outro local, use o nome da unidade (Function:) no caminho.

Set-Location Function:

Para retornar a uma unidade de sistema de arquivos, digite o nome da unidade. Por exemplo, digite:

Set-Location C:

Você também pode trabalhar com o provedor de funções de qualquer outra unidade do PowerShell. Para fazer referência a uma função de outro local, use o nome Function: da unidade no caminho.

Observação

O PowerShell usa aliases para permitir uma maneira familiar de trabalhar com caminhos de provedor. Comandos como dir e ls agora são aliases para Get-ChildItem, cd é um alias para Set-Location. e pwd é um alias para Get-Location.

Obtendo funções

Esse comando obtém a lista de todas as funções na sessão atual. Você pode usar esse comando de qualquer unidade do PowerShell.

Get-ChildItem -Path Function:

O provedor de funções não tem contêineres, portanto, o comando acima tem o mesmo efeito quando usado com Get-ChildItem.

Get-ChildItem -Path Function:

Você pode recuperar a definição de uma função acessando a propriedade Definition , conforme mostrado abaixo.

(Get-Item -Path function:more).Definition

Você também pode recuperar a definição de uma função usando seu caminho de provedor prefixado pelo sinal de dólar ($).

$function:more

Para recuperar a definição de uma função que tem um traço (-) no nome, encapsule o valor depois que o dólar entrar em chaves.

${function:Clear-Host}

Obtendo funções selecionadas

Esse comando obtém a man função da Function: unidade. Ele usa o Get-Item cmdlet para obter a função . O operador de pipeline (|) envia o resultado para Format-Table. O -Wrap parâmetro direciona o texto que não cabe na linha para a próxima linha. O -Autosize parâmetro redimensiona as colunas da tabela para acomodar o texto.

Get-Item -Path man | Format-Table -Wrap -Autosize

Trabalhando com caminhos do provedor de funções

Esses comandos obtêm a função chamada c:. O primeiro comando pode ser usado em qualquer unidade. O segundo comando é usado na Function: unidade. Como o nome termina com dois-pontos, que é a sintaxe para uma unidade, você deve qualificar o caminho com o nome da unidade. Dentro da Function: unidade, você pode usar qualquer formato. No segundo comando, o ponto (.) representa o local atual.

PS C:\> Get-Item -Path Function:c:
PS Function:\> Get-Item -Path .\c:

Criar uma função

Esse comando usa o New-Item cmdlet para criar uma função chamada Win32:. A expressão entre chaves é o bloco de script que é representado pelo nome da função.

New-Item -Path Function:Win32: -Value {Set-Location C:\Windows\System32}

Você também pode criar uma função digitando-a na linha de comando do PowerShell. Por exemplo, tpe Function:Win32: {Set-Location C:\Windows\System32}. Se você estiver na Function: unidade, poderá omitir o nome da unidade.

Excluindo uma função

Esse comando exclui a more: função da sessão atual.

Remove-Item Function:more:

Alterando uma função

Esse comando usa o Set-Item cmdlet para alterar a prompt função para que ela exiba o tempo antes do caminho.

Set-Item -Path Function:prompt -Value {
  'PS '+ (Get-Date -Format t) + " " + (Get-Location) + '> '
  }

Renomear uma função

Esse comando usa o Rename-Item cmdlet para alterar o nome da help função para gh.

Rename-Item -Path Function:help -NewName gh

Copiar uma função

Esse comando copia a prompt função para oldPrompt, criando efetivamente um novo nome para o bloco de script associado à função prompt. Você pode usar isso para salvar a função de prompt original se quiser alterá-la. A propriedade Options da nova função tem um valor de None. Para alterar o valor da propriedade Options , use Set-Item.

Copy-Item -Path Function:prompt -Destination Function:oldPrompt

Parâmetros dinâmicos

Parâmetros dinâmicos são parâmetros de cmdlet adicionados por um provedor do PowerShell e estão disponíveis somente quando o cmdlet está sendo usado na unidade habilitada para provedor.

Opções <[System.Management.Automation.ScopedItemOptions]>

Determina o valor da propriedade Options de uma função.

  • None: sem opções. None é o padrão.
  • Constant: a função não pode ser excluída e suas propriedades não podem ser alteradas. Constant está disponível somente quando você está criando uma função. Não é possível alterar a opção de uma função existente para Constant.
  • Private: a função é visível apenas no escopo atual
  • (não em escopos filho).
  • ReadOnly: as propriedades da função não podem ser alteradas, exceto usando o -Force parâmetro . Você pode usar Remove-Item para excluir a função.
  • AllScope: a função é copiada para todos os novos escopos criados.

Cmdlets com suporte

Usando o pipeline

Os cmdlets do provedor aceitam entrada de pipeline. Você pode usar o pipeline para simplificar a tarefa enviando dados do provedor de um cmdlet para outro cmdlet do provedor. Para ler mais sobre como usar o pipeline com cmdlets do provedor, consulte as referências de cmdlet fornecidas ao longo deste artigo.

Obtendo ajuda

A partir do Windows PowerShell 3.0, você pode obter tópicos da Ajuda personalizados para cmdlets do provedor que explicam como esses cmdlets se comportam em uma unidade de sistema de arquivos.

Para obter os tópicos de ajuda personalizados para a unidade do sistema de arquivos, execute um comando Get-Help em uma unidade do sistema de arquivos ou use o -Path parâmetro Get-Help para especificar uma unidade do sistema de arquivos.

Get-Help Get-ChildItem

Get-Help Get-ChildItem -Path function:

Confira também