Skip to content

Latest commit

 

History

History
225 lines (172 loc) · 4.08 KB

Get-KshFolder.md

File metadata and controls

225 lines (172 loc) · 4.08 KB
external help file Module Name online version schema
SPClientCore.dll-Help.xml
SPClientCore
2.0.0

Get-KshFolder

SYNOPSIS

Retrieves one or more folders.

SYNTAX

ParamSet1

Get-KshFolder [-Identity] <Folder> [<CommonParameters>]

ParamSet2

Get-KshFolder [-List] <List> [<CommonParameters>]

ParamSet3

Get-KshFolder [-ListItem] <ListItem> [<CommonParameters>]

ParamSet4

Get-KshFolder [-FolderId] <Guid> [<CommonParameters>]

ParamSet5

Get-KshFolder [-FolderUrl] <Uri> [<CommonParameters>]

ParamSet6

Get-KshFolder [-Folder] <Folder> [-FolderName] <String> [<CommonParameters>]

ParamSet7

Get-KshFolder [-Folder] <Folder> [-NoEnumerate] [<CommonParameters>]

ParamSet8

Get-KshFolder [-NoEnumerate] [<CommonParameters>]

DESCRIPTION

The Get-KshFolder cmdlet retrieves folders of the specified folder.

EXAMPLES

Example 1

PS C:\> Get-KshFolder -FolderId 'ca511d76-828d-4c86-a16c-c3a544eef5da'

Retrieves a folder by folder ID.

Example 2

PS C:\> Get-KshFolder -FolderUrl '/sites/japan/hr/Shared%20Documents/Templates'

Retrieves a folder by folder URL.

Example 3

PS C:\> Get-KshFolder -Folder (Get-KshFolder -FolderUrl '/sites/japan/hr/Shared%20Documents') -FolderName 'Templates'

Retrieves a folder by folder and folder name.

Example 4

PS C:\> Get-KshFolder -Folder (Get-KshFolder -FolderUrl '/sites/japan/hr/Shared%20Documents')

Retrieves all folders.

PARAMETERS

-Folder

Specifies the parent folder.

Type: Folder
Parameter Sets: ParamSet6, ParamSet7
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FolderId

Specifies the folder ID.

Type: Guid
Parameter Sets: ParamSet4
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FolderName

Specifies the folder name.

Type: String
Parameter Sets: ParamSet6
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FolderUrl

Specifies the folder URL.

Type: Uri
Parameter Sets: ParamSet5
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identity

Specifies the folder.

Type: Folder
Parameter Sets: ParamSet1
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-List

Specifies the list.

Type: List
Parameter Sets: ParamSet2
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ListItem

Specifies the list item.

Type: ListItem
Parameter Sets: ParamSet3
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-NoEnumerate

If specified, suppresses to enumerate objects.

Type: SwitchParameter
Parameter Sets: ParamSet7, ParamSet8
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Karamem0.SharePoint.PowerShell.Models.V1.Folder

Karamem0.SharePoint.PowerShell.Models.V1.List

Karamem0.SharePoint.PowerShell.Models.V1.ListItem

OUTPUTS

Karamem0.SharePoint.PowerShell.Models.V1.Folder

NOTES

RELATED LINKS