Start-Transcript
Cria um registro de toda ou parte de uma sessão do Windows PowerShell em um arquivo de texto.
Sintaxe
Start-Transcript [[-Caminho] <string>] [-Append] [-Force] [-NoClobber] [-Confirm] [-WhatIf] [<CommonParameters>]
Descrição
O cmdlet Start-Transcript cria um Registro de toda ou parte de uma sessão do Windows PowerShell em um arquivo de texto. A transcrição inclui todos os comandos que o usuário digita e todas as saídas que aparecem no console.
Parâmetros
-Append
Adiciona a nova transcrição ao fim de um arquivo existente. Use o parâmetro Path para especificar o arquivo.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Force
Permite que o cmdlet acrescente a transcrição a um arquivo somente leitura existente. Quando usado em um arquivo somente leitura, o cmdlet altera a permissão de arquivo para leitura-gravação. Mesmo usando o parâmetro Force, o cmdlet não pode substituir as restrições de segurança.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-NoClobber
Não substituirá o conteúdo de um arquivo existente. Por padrão, se existir um arquivo de transcrição no caminho especificado, Start-Transcript substituirá o arquivo sem avisar.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Caminho <string>
Especifica um local para o arquivo de transcrição. Insira um caminho para um arquivo .txt. Os caracteres curinga não são permitidos.
Se você não especificar um caminho, Start-Transcript utilizará o caminho no valor da variável global $Transcript. Se você não criou essa variável, Start-Transcript armazena as transcrições no diretório $Home\My Documents como arquivos \PowerShell_transcript.<time-stamp>.txt.
Se algum dos diretórios no caminho não existir, o comando falhará.
Necessário? |
false |
Posição? |
1 |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Confirm
Solicita confirmação antes da execução do comando.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-WhatIf
Descreve o que aconteceria se você executasse o comando sem, na verdade, fazê-lo.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
<CommonParameters>
Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.
Entradas e saídas
O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.
Entradas |
Nenhum Você não pode enviar objetos para este cmdlet. |
Saídas |
System.String Start-Transcript retorna uma cadeia de caracteres que contém uma mensagem de confirmação e o caminho para o arquivo de saída. |
Observações
Para interromper uma transcrição, use o cmdlet Stop-Transcript.
Para gravar uma sessão inteira, adicione o comando Start-Transcript ao seu perfil. Para obter mais informações, consulte about_Profiles.
Exemplo 1
C:\PS>start-transcript
Descrição
-----------
Esse comando inicia uma transcrição no local padrão do arquivo.
Exemplo 2
C:\PS>start-transcript -path c:\transcripts\transcript0.txt -noclobber
Descrição
-----------
Esse comando inicia uma transcrição no arquivo Transcript0.txt em C:\transcripts. O parâmetro NoClobber impede quaisquer arquivos existentes de serem substituídos. Se o arquivo Transcript0.txt já existir, o comando falhará.