Get-KshListItem.md

external help file	Module Name	online version	schema
SPClientCore.dll-Help.xml	SPClientCore		2.0.0

Get-KshListItem

SYNOPSIS

Retrieves one or more list items.

SYNTAX

ParamSet1

Get-KshListItem [-Identity] <ListItem> [<CommonParameters>]

ParamSet2

Get-KshListItem [-Folder] <Folder> [<CommonParameters>]

ParamSet3

Get-KshListItem [-File] <File> [<CommonParameters>]

ParamSet4

Get-KshListItem [-DriveItem] <DriveItem> [<CommonParameters>]

ParamSet5

Get-KshListItem [-ItemUrl] <String> [<CommonParameters>]

ParamSet6

Get-KshListItem [-List] <List> [-ItemId] <Int32> [<CommonParameters>]

ParamSet7

Get-KshListItem [-List] <List> [-All] [-NoEnumerate] [<CommonParameters>]

ParamSet8

Get-KshListItem [-List] <List> [-FolderServerRelativeUrl <String>]
 [-ListItemCollectionPosition <ListItemCollectionPosition>] [-ViewXml <String>] [-NoEnumerate]
 [<CommonParameters>]

DESCRIPTION

The Get-KshListItem cmdlet retrieves list items of the specified list.

EXAMPLES

Example 1

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

Retrieves a list item from the folder.

Example 2

PS C:\> Get-KshListItem -File (Get-KshFile -FileUrl '/sites/japan/hr/Shared%20Documents/README.txt')

Retrieves a list item from the file.

Example 3

PS C:\> Get-KshListItem -List (Get-KshList -ListTitle 'Announcements') -ItemId 1

Retrieves a list item by list item ID.

Example 4

PS C:\> Get-KshListItem -List (Get-KshList -ListTitle 'Announcements') -All

Retrieves all list items.

Example 5

PS C:\> Get-KshListItem -List (Get-KshList -ListTitle 'Announcements') -ViewXml '<View><RowLimit>10</RowLimit><View>'

Retrieves list items by CAML query.

PARAMETERS

-All

if specified, returns all items. This parameter is effective if there are more than 5000 items.

Type: SwitchParameter
Parameter Sets: ParamSet7
Aliases:

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

-DriveItem

Specifies the drive item.

Type: DriveItem
Parameter Sets: ParamSet4
Aliases:

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

-File

Specifies the file.

Type: File
Parameter Sets: ParamSet3
Aliases:

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

-Folder

Specifies the folder.

Type: Folder
Parameter Sets: ParamSet2
Aliases:

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

-FolderServerRelativeUrl

Specifies the site relative URL of folder.

Type: String
Parameter Sets: ParamSet8
Aliases:

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

-Identity

Specifies the list item.

Type: ListItem
Parameter Sets: ParamSet1
Aliases:

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

-ItemId

Specifies the list item ID.

Type: Int32
Parameter Sets: ParamSet6
Aliases:

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

-ItemUrl

Specifies the list item URL.

Type: String
Parameter Sets: ParamSet5
Aliases:

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

-List

Specifies the list.

Type: List
Parameter Sets: ParamSet6, ParamSet7, ParamSet8
Aliases:

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

-ListItemCollectionPosition

Specifies the starting position.

Type: ListItemCollectionPosition
Parameter Sets: ParamSet8
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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

-ViewXml

Specifies the CAML query XML representation. For more information, see reference.

Type: String
Parameter Sets: 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.ListItem

Karamem0.SharePoint.PowerShell.Models.V1.Folder

Karamem0.SharePoint.PowerShell.Models.V1.File

Karamem0.SharePoint.PowerShell.Models.V2.DriveItem

OUTPUTS

Karamem0.SharePoint.PowerShell.Models.V1.ListItem

NOTES

RELATED LINKS