< Back

Remove-PSFNull

Sun Jan 19, 2020 6:43 pm

NAME Remove-PSFNull



SYNOPSIS

Filters out null objects.





SYNTAX

Remove-PSFNull [-InputObject <PSObject>] [-AllowEmptyCollections] [-AllowEmptyStrings] [-Enumerate]

[<CommonParameters>]





DESCRIPTION

This cmdlet can be used to filter out $null objects, empty collections and empty strings from the pipeline.





PARAMETERS

-InputObject <PSObject>

The items to filter



Required? false

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-AllowEmptyCollections [<SwitchParameter>]

By default, empty collections are dropped from the output. Using this switch, they are passe along.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-AllowEmptyStrings [<SwitchParameter>]

By default, empty strings are discarded. Setting this switch causes them to be passed through instead.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Enumerate [<SwitchParameter>]

By default, output is not enumerated (Lists are sent along the pipeline as Lists, not individual items). If

Remove-PSFNull should enumerate output after all, set this switch.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES









--------------- Example 1: Sweeping the Pipeline ---------------



C:\\PS> Get-Something | Remove-PSFNull | Do-Something



In this example, Remove-PSFNull cleans up the pipeline from null-equivalent objects before passing output along to

Do-Something



RELATED LINKS

Online Documentation: https://psframework.org/documentation/c ... FNull.html