Returns a valid and safe filename from a given string.
ConvertTo-FileName.ps1 [[-OutputBlock] <String>] [[-Replacement] <Rune>] [[-IncludeChars] <Char[]>]
[[-ExcludeChars] <Char[]>] [[-IncludeRunes] <Rune[]>] [[-ExcludeRunes] <Rune[]>] [-CurrentPlatformOnly]
[-InputObject] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
'app*.log' |ConvertTo-FileName.ps1
app_.log
' |ConvertTo-FileName.ps1 -CurrentPlatformOnly
one_two-_three_
'app-${value}.config' |ConvertTo-FileName.ps1 Ascii -ExcludeChars '%','$','{','}','`'
app-_value_.config
Allows limiting the filename to either ASCII or Basic Multilingual Plane characters, if specified.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The character to use to replace a range of invalid characters.
Type: Rune
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: '_'[0]
Accept pipeline input: False
Accept wildcard characters: False
Characters to include (overrides exclusions).
Type: Char[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: @()
Accept pipeline input: False
Accept wildcard characters: False
Characters to exclude.
Type: Char[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: @()
Accept pipeline input: False
Accept wildcard characters: False
Runes to include (overrides excludes).
Type: Rune[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: @()
Accept pipeline input: False
Accept wildcard characters: False
Runes to exclude.
Type: Rune[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: @()
Accept pipeline input: False
Accept wildcard characters: False
Indicates that only characters invalid for the current platform should be excluded by default, otherwise invalid characters from any platform will be excluded by default (unless overridden).
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
The string value to sanitize for use as a filename.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.