| external help file | SPClientCore.dll-Help.xml |
|---|---|
| Module Name | SPClientCore |
| online version | |
| schema | 2.0.0 |
Retrieves one or more files.
Get-KshFile [-Identity] <File> [<CommonParameters>]
Get-KshFile [-AttachmentFile] <AttachmentFile> [<CommonParameters>]
Get-KshFile [-FileVersion] <FileVersion> [<CommonParameters>]
Get-KshFile [-App] <App> [<CommonParameters>]
Get-KshFile [-FileId] <Guid> [<CommonParameters>]
Get-KshFile [-FileUrl] <Uri> [<CommonParameters>]
Get-KshFile [-Folder] <Folder> [-FileName] <String> [<CommonParameters>]
Get-KshFile [-Folder] <Folder> [-NoEnumerate] [<CommonParameters>]
The Get-KshFile cmdlet retrieves files of the specified folder.
PS C:\> Get-KshFile -FileId '2c7ceb97-193f-4d05-91a5-a03c6d58ae60'Retrieves a file by file ID.
PS C:\> Get-KshFile -FileUrl '/sites/japan/hr/Shared%20Documents/README.txt'Retrieves a file by file URL.
PS C:\> Get-KshFile -Folder '/sites/japan/hr/Shared%20Documents' -FileName 'README.txt'Retrieves a file by folder and file name.
PS C:\> Get-KshFile -Folder '/sites/japan/hr/Shared%20Documents'Retrieves all files.
Specifies the app.
Type: App
Parameter Sets: ParamSet4
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the attachment file.
Type: AttachmentFile
Parameter Sets: ParamSet2
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the file ID.
Type: Guid
Parameter Sets: ParamSet5
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the file name.
Type: String
Parameter Sets: ParamSet7
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the file URL.
Type: Uri
Parameter Sets: ParamSet6
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the file version.
Type: FileVersion
Parameter Sets: ParamSet3
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the folder.
Type: Folder
Parameter Sets: ParamSet7, ParamSet8
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the file.
Type: File
Parameter Sets: ParamSet1
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseIf specified, suppresses to enumerate objects.
Type: SwitchParameter
Parameter Sets: ParamSet8
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.