Write-Output w PowerShell wyświetla dane w potoku, przekazując je do kolejnego polecenia lub bezpośrednio do konsoli.
Write-Output jako jawne przekazanie obiektu do potoku
Write-Output jest wbudowanym poleceniem PowerShell służącym do zapisania wartości w standardowym strumieniu wyjściowym polecenia. W praktyce oznacza to, że dane przekazane do tego cmdletu mogą zostać odebrane przez następne polecenie w potoku albo wyświetlone w konsoli, jeżeli potok nie ma kolejnego odbiorcy. Cmdlet nie ogranicza się do tekstu. Może przekazywać napisy, liczby, wartości logiczne, obiekty utworzone przez polecenia PowerShell oraz kolekcje.
Podstawowa składnia ma postać Write-Output -InputObject $wartosc, przy czym parametr -InputObject jest parametrem domyślnym i często można go pominąć. Polecenie Write-Output "Test" zapisuje napis do potoku, a Write-Output 42 przekazuje liczbę całkowitą. Wartość końcowa pojawi się w konsoli dzięki domyślnemu formatowaniu PowerShell, ale samo Write-Output nie jest przede wszystkim poleceniem formatowania ani funkcją drukującą tekst w rozumieniu tradycyjnych języków programowania.
Obiekty, potok i różnica między wyjściem a komunikatem
Najważniejszą właściwością Write-Output jest zachowanie danych jako obiektów. Jeżeli polecenie przekazuje dalej obiekt, następny cmdlet może odczytać jego właściwości i metody, filtrować go albo przekształcać. Przykładowo Write-Output "laptop","komputer" | Where-Object { $_ -like "*top*" } przekazuje elementy do Where-Object, który wybiera napis zawierający określony fragment. Końcowy wynik jest wyświetlany dopiero wtedy, gdy potok dociera do domyślnego odbiornika konsoli.
W PowerShell zapis wartości w potoku różni się od zapisu komunikatu informacyjnego, ostrzeżenia lub błędu. Write-Output służy do tworzenia normalnego wyniku polecenia, który może zostać przypisany do zmiennej, przekierowany do pliku albo użyty przez inny cmdlet. Write-Host jest przeznaczony do bezpośredniego prezentowania tekstu użytkownikowi i nie pełni tej samej funkcji w przepływie danych. Z kolei Write-Error zapisuje rekord błędu, a Write-Verbose i Write-Debug obsługują komunikaty diagnostyczne zależne od ustawień wspierających je przełączników.
W funkcji PowerShell zwykłe umieszczenie wartości w osobnej linii również może spowodować jej zapisanie do strumienia wyjściowego. Dlatego Write-Output bywa używany wtedy, gdy intencja autora ma być jednoznaczna albo gdy wynik jest generowany warunkowo. Należy jednak pamiętać, że każde niezamierzone wyrażenie zwracające wartość może stać się częścią wyniku funkcji, co utrudnia późniejsze przetwarzanie. Świadome rozdzielenie wyniku, komunikatów i efektów ubocznych pomaga zachować przewidywalny kontrakt polecenia.
Enumeracja kolekcji i parametr NoEnumerate
Domyślnie Write-Output rozpoznaje kolekcje i zapisuje ich elementy osobno do potoku. Przykład Write-Output -InputObject @("A","B","C") może więc dostarczyć trzy elementy, które kolejne polecenie otrzyma pojedynczo. Takie zachowanie jest zgodne z typowym modelem potoku PowerShell, gdzie cmdlet wykonuje operację dla każdego obiektu wejściowego. Ma to znaczenie przy filtrowaniu, sortowaniu, grupowaniu i eksporcie danych.
Jeżeli cała kolekcja ma zostać przekazana jako jeden obiekt, można użyć przełącznika -NoEnumerate. Polecenie Write-Output -NoEnumerate -InputObject @("A","B","C") przekazuje tablicę jako pojedynczą wartość. Różnica jest widoczna w następnym poleceniu, szczególnie gdy odbiorca rozróżnia pojedynczy obiekt od wielu elementów. Wybór między domyślną enumeracją a -NoEnumerate powinien wynikać z oczekiwanego typu danych, a nie wyłącznie z tego, jak wynik wygląda po wyświetleniu w konsoli.
Do Write-Output można przekazać także potokiem dane z innego polecenia, choć w wielu przypadkach bezpośrednie połączenie cmdletów jest czytelniejsze. Alias Write jest dostępny dla tego cmdletu, ale w skryptach przeznaczonych do utrzymania często korzysta się z pełnej nazwy, ponieważ łatwiej rozpoznać jej znaczenie. Przy diagnostyce problemu trzeba sprawdzić, czy obserwowany tekst jest rzeczywistym wynikiem obiektu, czy tylko jego reprezentacją przygotowaną przez system formatowania PowerShell.
Praktyczne użycie w skryptach PowerShell na komputerze
W skrypcie działającym na laptopie lub komputerze stacjonarnym Write-Output może służyć do zwracania statusu operacji, ścieżki pliku, nazwy wykrytego urządzenia albo obiektu zawierającego kilka właściwości. Wynik można następnie przypisać do zmiennej, na przykład $wynik = Write-Output "Gotowe", przekazać do Set-Content lub połączyć z ForEach-Object. Przy zapisie do pliku trzeba odróżnić dane przeznaczone do dalszego przetwarzania od komunikatów przeznaczonych wyłącznie dla osoby uruchamiającej skrypt.
Typowym błędem jest oczekiwanie, że Write-Output zmieni dane w tekst sformatowany dokładnie według potrzeb. Cmdlet przekazuje obiekt, a sposób prezentacji może zależeć od jego typu i od miejsca, w którym wynik zostanie odebrany. Do świadomego tworzenia tekstu służy interpolacja łańcuchów, operator formatowania -f albo odpowiednie właściwości obiektu, natomiast do zapisu danych strukturalnych można użyć wyspecjalizowanych poleceń, takich jak ConvertTo-Json lub Export-Csv. Sama obecność wyniku na ekranie nie potwierdza więc, że dane mają właściwy typ i zawartość.
Warszawskie Pogotowie Komputerowe wykonuje profesjonalną naprawę laptopów, komputerów PC i ich podzespołów, a analiza skryptu PowerShell może być częścią rozpoznania problemu z działaniem oprogramowania na takim urządzeniu.
