Flash info

Les vrais admins utilisent la ligne de commande... (dixit le mag Windows IT Pro du 6/02/07) Avis aux amateurs pour affirmer leur virilité Surprised.
La suite est ici.

 
Aide mémoire - Write
Écrit par Arnaud Petitjean [MVP]   
11-12-2006
Write-Debug
Write-Error Write-Host Write-Output Write-Progress Write-Verbose Write-Warning



NOM
    Write-Debug
   
RÉSUMÉ
    Écrit un message de débogage pour l'affichage hôte.
   
   
SYNTAXE
    Write-Debug [-message] <string> [<CommonParameters>]
   
   
DESCRIPTION DÉTAILLÉE
    Écrit des messages de débogage pour la console à partir d'un script ou d'une commande. Le message est éventuellement affiché sur la console selon la valeur de la variable $DebugPreference. Tapez $DebugPreference pour consulter sa valeur actuelle. Pour définir la variable pour la session, tapez $DebugPreference  = "<value>". Les valeurs valides sont : SilentlyContinue, Stop, Continue et Inquire. Si la valeur est SilentlyContinue, Write-Debug n'affiche pas de message à la console.
   

PARAMÈTRES
    -message <string>
        Spécifie le message de débogage à envoyer à la console.
       
    <CommonParameters>
        Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug,
        -ErrorAction, -ErrorVariable et -OutVariable. Pour plus d'informations,
        tapez « get-help about_commonparameters ».
   
    -------------------------- EXEMPLE 1 --------------------------
   
    C:\PS>$DebugPreference = "Continue"
    Write-Debug "This script has attempted to open file xyx and cannot."
    $DebugPreference = "SilentlyContinue"
    Write-Debug "This is another debug statement."
   
    Cette commande écrit un message de débogage qui sera affiché ou non selon la valeur de $DebugPreference. La valeur " SilentlyContinue " n'affiche pas l'instruction. La valeur "Contiue"  affiche la valeur.
   
   
    DEBUG: Ce script a essayé d'ouvrir le fichier xyx, sans y parvenir.
   
REMARQUES
    Pour plus d'informations, tapez : "get-help Write-Debug -detailed".
    Pour obtenir des informations techniques, tapez : "get-help Write-Debug -full".


NOM
    Write-Error
   
RÉSUMÉ
    Écrit un objet au pipeline d'erreur.
   
   
SYNTAXE
    Write-Error [-message] <string> [-category {<NotSpecified> | <OpenError> | <CloseError> | <DeviceError> | <DeadlockDetected> | <InvalidArgument> | <InvalidData> | <InvalidOperation> | <InvalidResult> | <InvalidType> | <MetadataError> | <NotImplemented> | <NotInstalled> | <ObjectNotFound> | <OperationStopped> | <OperationTimeout> | <SyntaxError> | <ParserError> | <PermissionDenied> | <ResourceBusy> | <ResourceExists> | <ResourceUnavailable> | <ReadError> | <WriteError> | <FromStdErr> | <SecurityError>}] [-errorId <string>] [-targetObject <Object>] [-recommendedAction <string>] [-categoryActivity <string>] [-categoryReason <string>] [-categoryTargetName <string>] [-categoryTargetType <string>] [<CommonParameters>]
   
    Write-Error [-message] <string> -exception <Exception> [-category {<NotSpecified> | <OpenError> | <CloseError> | <DeviceError> | <DeadlockDetected> | <InvalidArgument> | <InvalidData> | <InvalidOperation> | <InvalidResult> | <InvalidType> | <MetadataError> | <NotImplemented> | <NotInstalled> | <ObjectNotFound> | <OperationStopped> | <OperationTimeout> | <SyntaxError> | <ParserError> | <PermissionDenied> | <ResourceBusy> | <ResourceExists> | <ResourceUnavailable> | <ReadError> | <WriteError> | <FromStdErr> | <SecurityError>}] [-errorId <string>] [-targetObject <Object>] [-recommendedAction <string>] [-categoryActivity <string>] [-categoryReason <string>] [-categoryTargetName <string>] [-categoryTargetType <string>] [<CommonParameters>]
   
    Write-Error -errorRecord <ErrorRecord> [-recommendedAction <string>] [-categoryActivity <string>] [-categoryReason <string>] [-categoryTargetName <string>] [-categoryTargetType <string>] [<CommonParameters>]
   
   
DESCRIPTION DÉTAILLÉE
    Écrit un objet au pipeline d'erreur. Vous permet d'écrire des messages d'erreur avec autres informations telles qu'un identificateur, des données d'objet et des actions suggérées.
   

PARAMÈTRES
    -message <string>
        Spécifie le texte du message de l'erreur.
       
    -category <ErrorCategory>
        Spécifie la catégorie de l'erreur.
        Les valeurs acceptées pour ce paramètre sont répertoriées ci-après :
       
    -errorId <string>
        Spécifie un ID à associer à l'erreur. Ce doit être une chaîne unique à l'erreur.
       
    -targetObject <Object>
        Spécifie l'objet auquel l'erreur est associée.
       
    -recommendedAction <string>
        Décrit la réponse recommandée à l'erreur.
       
    -categoryActivity <string>
        Décrit l'action qui remplace la valeur par défaut ErrorCategoryInfo.
       
    -categoryReason <string>
        Décrit la raison pour laquelle la valeur par défaut ErrorCategoryInfo est remplacée.
       
    -categoryTargetName <string>
        Spécifie le nom cible de la substitution ErrorCategoryInfo.
       
    -categoryTargetType <string>
        Spécifie le type cible devant remplacer la valeur par défaut ErrorCategoryInfo.
       
    -exception <Exception>
        Spécifie le type d'exception de l'erreur. Ce paramètre peut être utilisé à la place de Message et ErrorRecord, auquel cas il doit paraître comme premier paramètre du jeu de paramètres.
       
    -errorRecord <ErrorRecord>
        Spécifie un enregistrement d'erreur qui décrit les détails de l'erreur. Ce paramètre peut être utilisé à la place des paramètres Exception et Message, auquel cas il est le premier paramètre du jeu de paramètres.
       
    <CommonParameters>
        Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug,
        -ErrorAction, -ErrorVariable et -OutVariable. Pour plus d'informations,
        tapez « get-help about_commonparameters ».
   
    -------------------------- EXEMPLE 1 --------------------------
   
    C:\PS>get-childitem | foreach-object { if ($_.gettype().tostring() -eq "Microsoft.Win32.RegistryKey") {write-error
    "Out-of-band object" -errorID B1 -targetobject $_ } else {$_ } }
   
    Cette commande écrit un objet pour le pipeline d'erreur si l'applet de commande Get-Childitem retourne un objet de type Microsoft.Win32.Registry, ce qu'elle fait si la commande est exécutée dans l'espace de noms du fournisseur de Registre (Registry).
   
   
   
   
REMARQUES
    Pour plus d'informations, tapez : "get-help Write-Error -detailed".
    Pour obtenir des informations techniques, tapez : "get-help Write-Error -full".


NOM
    Write-Host
   
RÉSUMÉ
    Affiche des objets à l'aide de l'interface utilisateur hôte
   
   
SYNTAXE
    Write-Host [[-object] <Object>] [-noNewLine] [-separator <Object>] [-foregroundcolor {<Black> | <DarkBlue> | <DarkGreen> | <DarkCyan> | <DarkRed> | <DarkMagenta> | <DarkYellow> | <Gray> | <DarkGray> | <Blue> | <Green> | <Cyan> | <Red> | <Magenta> | <Yellow> | <White>}] [-backgroundColor {<Black> | <DarkBlue> | <DarkGreen> | <DarkCyan> | <DarkRed> | <DarkMagenta> | <DarkYellow> | <Gray> | <DarkGray> | <Blue> | <Green> | <Cyan> | <Red> | <Magenta> | <Yellow> | <White>}] [<CommonParameters>]
   
   
DESCRIPTION DÉTAILLÉE
    Affiche des objets à l'aide de l'interface utilisateur hôte. Write-Host crée une fenêtre hôte personnalisée. Vous pouvez spécifier la couleur du texte dans ces fenêtres en utilisant le paramètre ForegroundColor, ainsi que la couleur d'arrière-plan de la fenêtre à l'aide du paramètre BackgroundColor. Le paramètre Separator vous permet de spécifier une chaîne à utiliser pour séparer les objets affichés.
   

PARAMÈTRES
    -object <Object>
        Objets à afficher sur la console.
       
    -noNewLine <SwitchParameter>
        Spécifie que le contenu affiché sur la console ne se termine pas avec un caractère de nouvelle ligne.
       
    -separator <Object>
        Chaîne de sortie entre les objets affichés sur la console.
       
    -foregroundcolor <ConsoleColor>
        Spécifie la couleur du texte.
        Les valeurs acceptées pour ce paramètre sont répertoriées ci-après :
       
    -backgroundColor <ConsoleColor>
        Spécifie la couleur d'arrière-plan.
        Les valeurs acceptées pour ce paramètre sont répertoriées ci-après :
       
    <CommonParameters>
        Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug,
        -ErrorAction, -ErrorVariable et -OutVariable. Pour plus d'informations,
        tapez « get-help about_commonparameters ».
   
    -------------------------- EXEMPLE 1 --------------------------
   
    C:\PS>write-host "no newline test" -nonewline
   
    Cette commande affiche l'entrée à la console, mais à cause du paramètre nonewline, la sortie est suivie directement de l'invite.
   
   
   
   
    -------------------------- EXEMPLE 2 --------------------------
   
    C:\PS>write-host (2,4,6,8,10,12) -Separator ", +2= "
   
    Cette commande affiche les nombres pairs, de 2 à 12. Le paramètre Separator est utilisé pour ajouter la chaîne, +2 = (virgule, espace, +, 2, =, espace).
   
   
    2, +2= 4, +2= 6, +2= 8, +2= 10, +2= 12
   
    -------------------------- EXEMPLE 3 --------------------------
   
    C:\PS>write-host (2,4,6,8,10,12) -Separator ", -> " -foregroundcolor DarkGreen -backgroundcolor white
   
    Cette commande affiche les nombres pairs, de 2 à 12. Elle utilise le paramètre Foregroundcolor pour produire un texte vert foncé de sortie et le paramètre Backgroundcolor pour afficher un arrière-plan blanc.
   
   
   
   
REMARQUES
    Pour plus d'informations, tapez : "get-help Write-Host -detailed".
    Pour obtenir des informations techniques, tapez : "get-help Write-Host -full".


NOM
    Write-Output
   
RÉSUMÉ
    Écrit des objets au pipeline de succès.
   
   
SYNTAXE
    Write-Output [-inputObject] <PSObject[]> [<CommonParameters>]
   
   
DESCRIPTION DÉTAILLÉE
    Écrit des objets au pipeline de succès.
   

PARAMÈTRES
    -inputObject <PSObject[]>
        Spécifie les objets à envoyer le pipeline. Entrez une variable contenant les objets ou tapez une commande ou une expression qui obtient les objets.
       
    <CommonParameters>
        Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug,
        -ErrorAction, -ErrorVariable et -OutVariable. Pour plus d'informations,
        tapez « get-help about_commonparameters ».
   
    -------------------------- EXEMPLE 1 --------------------------
   
    C:\PS>write-output "test output" | get-member
   
    Cette commande dirige la chaîne " test output " ( "sortie de test ") vers l'applet de commande Get-Member qui affiche les membres de la classe String, en montrant que la chaîne est passée le long du pipeline.
   
   
   
   
REMARQUES
    Pour plus d'informations, tapez : "get-help Write-Output -detailed".
    Pour obtenir des informations techniques, tapez : "get-help Write-Output -full".


NOM
    Write-Progress
   
RÉSUMÉ
    Affiche une barre de progression dans une fenêtre de commande Windows PowerShell.
   
   
SYNTAXE
    Write-Progress [-activity] <string> [-status] <string> [[-id] <int>] [-percentComplete <int>] [-secondsRemaining <int>] [-currentOperation <string>] [-parentId <int>] [-completed] [-sourceId <int>] [<CommonParameters>]
   
   
DESCRIPTION DÉTAILLÉE
    Affiche une barre de progression dans une fenêtre de commande Windows PowerShell. C'est la variable $ProgressPreference qui détermine si la barre de progression est affichée. Pour consulter la valeur de cette variable, tapez $ProgressPreference. Les valeurs valides pour la variable sont : SilentlyContinue, Continue, Stop et Inquire. Si la valeur est définie sur SilentlyContinue, aucune information de progression n'est affichée sur la console. Pour définir la valeur de la variable pour la session, tapez $ProgressPreference = " <valeur> ". Write-Progress peut utiliser des données sur l'état d'une commande ou d'un script en cours d'exécution pour fournir une indication de progression visuelle dans la fenêtre de console.
   

PARAMÈTRES
    -activity <string>
        Spécifie une chaîne qui décrit l'activité à laquelle se rapporte la progression. Elle apparaît comme premier en-tête au-dessus de la barre de progression.
       
    -status <string>
        Spécifie une chaîne qui décrit l'état actuel de l'activité à laquelle se rapporte la progression. Elle apparaît comme second en-tête au-dessus de la barre de progression.
       
    -id <int>
        Spécifie l'identificateur d'activité pour cet enregistrement de progression.
       
    -percentComplete <int>
        Spécifie le pourcentage de l'activité qui est exécutée. Utilisez la valeur -1 si le pourcentage d'exécution est inconnu ou non applicable.
       
    -secondsRemaining <int>
        Spécifie le nombre estimatif de secondes restant jusqu'à ce que l'activité soit terminée. Utilisez la valeur -1 si le nombre de secondes restant est inconnu ou non applicable.
       
    -currentOperation <string>
        Décrit l'opération qui se déroule actuellement.
       
    -parentId <int>
        Identifie l'activité parente de l'activité actuelle. Utilisez la valeur -1 si l'activité actuelle n'a aucune activité parente.
       
    -completed <SwitchParameter>
        Indique si la barre de progression est visible. Si la valeur définie est fausse (False), affiche les informations de progression.
       
    -sourceId <int>
        Identifie la source de l'enregistrement
       
    <CommonParameters>
        Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug,
        -ErrorAction, -ErrorVariable et -OutVariable. Pour plus d'informations,
        tapez « get-help about_commonparameters ».
   
    -------------------------- EXEMPLE 1 --------------------------
   
    C:\PS>for($i = 1; $i -lt 101; $i++ )
    {for($j=0;$j -lt 10000;$j++) {} write-progress "Search in Progress" "% Complete:" -perc $i;}
   
    Cette commande affiche la progression d'une boucle for.
   
   
   
   
    -------------------------- EXEMPLE 2 --------------------------
   
    C:\PS>for($i = 1; $i -lt 101; $i++ ) {write-progress Updating progress-> -perc $i} for($i = 1; $i -lt 101; $i++ ) { write-progress Updating progress -percentcomplete $i -id  1}
   
    Cet exemple affiche la progression de deux boucles imbriquées for.
   
   
    Progression de la
      mise à jour
      [oooooooooooooooooo                                                       ]
   
    Mise à jour secondaire
      Progression secondaire
      [oooooooooooooooooo                                                       ]
   
    -------------------------- EXEMPLE 3 --------------------------
   
    C:\PS>$events = get-eventlog -logname system
    $events | foreach-object -begin {clear-host;$i=0;$out=""} `
    -process {if($_.message -like "*bios*") {$out=$out + $_.Message};
    $i = $i+1;`
    write-progress -activity "Searching Events" `
    -status "Progress:" -percentcomplete ($i/$events.count*100)} `
    -end {$out}
   
    Cette commande affiche la progression en recherchant la chaîne " bios " dans les messages du journal d'événements système. Dans la première ligne de la commande, l'applet de commande Get-EventLog est utilisée pour récupérer et stocker les événements du journal système dans la variable $events. Dans la deuxième ligne, les événements sont dirigés vers l'applet de commande ForEach-Object. Avant que le traitement ne commence, l'applet de commande Clear-Host est utilisée pour effacer l'écran, une variable de compteur, $i, est définie à zéro et une variable de sortie, $out, est définie sur la chaîne vide (empty). Dans le bloc de script Process de l'applet de commande ForEach-Object, sur la troisième ligne, la propriété de message de chaque objet entrant, représentée par la variable $ _, est examinée pour déterminer si elle inclut la chaîne " bios ". Si elle inclut la chaîne, le message est ajouté à la variable de sortie, $out. Dans la ligne quatrième de la commande, la variable de compteur $i est incrémentée pour enregistrer qu'un autre événement a été examiné. Ensuite, l'applet de commande Write-Progress est appelée avec trois paramètres spécifiés. Les deux premiers paramètres, Activity et Status, représentent des informations d'en-tête qui apparaissent au-dessus de la barre de progression. La valeur de paramètre PercentComplete est calculée en divisant le nombre d'événements qui ont été traités ($i) par le nombre total d'événements récupérés ($events.count), puis en multipliant par 100. Dans la dernière ligne, le paramètre End de l'applet de commande ForEach-Object est utilisée pour afficher les messages qui contenaient la chaîne " bios ", et qui sont stockés dans la variable $out.
   
   
   
   
REMARQUES
    Pour plus d'informations, tapez : "get-help Write-Progress -detailed".
    Pour obtenir des informations techniques, tapez : "get-help Write-Progress -full".


NOM
    Write-Verbose
   
RÉSUMÉ
    Écrit une chaîne pour l'affichage commenté de l'hôte.
   
   
SYNTAXE
    Write-Verbose [-message] <string> [<CommonParameters>]
   
   
DESCRIPTION DÉTAILLÉE
    Écrit une chaîne pour l'affichage commenté de l'hôte. La valeur de la variable $VerbosePreference détermine si la chaîne est affichée ou non dans la fenêtre de console. Pour consulter la valeur de la variable, tapez $VerbosePreference. Les valeurs valides sont les suivantes : SilentlyContinue, Stop, Continue et Inquire. Pour définir la valeur de la variable dans la session active, tapez $VerbosePreference = " <valeur> ". Si $VerbosePreference a la valeur SilentlyContinue, l'exécution de Write-Verbose n'affiche rien sur la console. Pour toutes les autres valeurs de $verbosepreference, l'applet de commande affiche son message sur la console, puis continue, s'arrête ou demande à l'utilisateur si elle doit continuer.
   
    L'utilisation de l'applet de commande Write-Verbose pour afficher des informations détaillées dans un script permet à l'utilisateur du script de déterminer s'il veut afficher ces informations détaillées en définissant la valeur de la variable $VerbosePreference.
   

PARAMÈTRES
    -message <string>
        Spécifie le message à afficher.
       
    <CommonParameters>
        Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug,
        -ErrorAction, -ErrorVariable et -OutVariable. Pour plus d'informations,
        tapez « get-help about_commonparameters ».
   
    -------------------------- EXEMPLE 1 --------------------------
   
    C:\PS>$verbosepreference = "silentlycontinue"
    write-verbose "test"
    $verboseprefernce = "continue"
    write-verbose "test"
   
    Cette commande définit la variable $verbosepreference sur SilentlyContinue. Elle utilise ensuite l'applet de commande Write-Verbose pour afficher le message 'test.' Rien n'est affiché à cause de la valeur de la variable $verbosepreference. La valeur de la variable $verbosepreference est remplacée par Continue et l'appel suivant à Write-Verbose affiche le message 'test' en conséquence.
   
   
   
   
REMARQUES
    Pour plus d'informations, tapez : "get-help Write-Verbose -detailed".
    Pour obtenir des informations techniques, tapez : "get-help Write-Verbose -full".


NOM
    Write-Warning
   
RÉSUMÉ
    Écrit un message d'avertissement.
   
   
SYNTAXE
    Write-Warning [-message] <string> [<CommonParameters>]
   
   
DESCRIPTION DÉTAILLÉE
    Écrit un message d'avertissement. Le message est envoyé directement à l'hôte. C'est la valeur de la variable $WarningPreference qui détermine si le message est éventuellement affiché sur la console. Tapez $WarningPreference pour consulter sa valeur actuelle. Pour définir la variable pour la session, tapez $WarningPreference = " <valeur> ". Les valeurs valides sont : SilentlyContinue, Stop, Continue et Inquire. Si la valeur est SilentlyContinue, Write-Warning n'affiche pas de message sur la console. Lorsque le message est affiché, la vidéo inverse est utilisée pour le mettre en surbrillance.
   

PARAMÈTRES
    -message <string>
        Spécifie le message d'avertissement.
       
    <CommonParameters>
        Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug,
        -ErrorAction, -ErrorVariable et -OutVariable. Pour plus d'informations,
        tapez « get-help about_commonparameters ».
   
    -------------------------- EXEMPLE 1 --------------------------
   
    C:\PS>write-warning "This is only a test warning."
   
    Cette commande affiche le message " WARNING : This is only a test warning. " (AVERTISSEMENT : ceci n'est qu'un avertissement test) sauf si la valeur de $WarningPreference est SilentlyContinue.
   
   
   
   
REMARQUES
    Pour plus d'informations, tapez : "get-help Write-Warning -detailed".
    Pour obtenir des informations techniques, tapez : "get-help Write-Warning -full".



 
© 2017 PowerShell-Scripting.com