Get-WebFileName

Gets the original file name from a url. Used by Get-WebFile to determine the original file name for a file.

Syntax

Get-WebFileName `
  [-Url <String>] `
  -DefaultName <String> `
  [-UserAgent <String>] `
  [-IgnoredArguments <Object[]>] [<CommonParameters>]

Description

Uses several techniques to determine the original file name of the file based on the url for the file.

Notes

Falls back to DefaultName when the name cannot be determined.

Chocolatey works best when the packages contain the software it is managing and doesn't require downloads. However most software in the Windows world requires redistribution rights and when sharing packages publicly (like on the community feed), maintainers may not have those aforementioned rights. Chocolatey understands how to work with that, hence this function. You are not subject to this limitation with internal packages.

Aliases

None

Examples

EXAMPLE 1

Get-WebFileName -Url $url -DefaultName $originalFileName

Inputs

None

Outputs

None

Parameters

-Url [<String>]

This is the url to a file that will be possibly downloaded.

-DefaultName <String>

The name of the file to use when not able to determine the file name from the url response.

-UserAgent [<String>]

The user agent to use as part of the request. Defaults to 'chocolatey command line'.

-IgnoredArguments [<Object[]>]

Allows splatting with arguments that do not apply. Do not use directly.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters http://go.microsoft.com/fwlink/p/?LinkID=113216 .

Links

• Get-WebHeaders
• Get-ChocolateyWebFile

Function Reference

:choco-info: NOTE

This documentation has been automatically generated from Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-WebFileName -Full.

View the source for Get-WebFileName