functions/Get-SPRList.ps1
|
Function Get-SPRList { <# .SYNOPSIS Returns a SharePoint list object. .DESCRIPTION Returns a SharePoint list object. .PARAMETER List The human readable list name. So 'My List' as opposed to 'MyList', unless you named it MyList. .PARAMETER Web The human readable web name. So 'My Web' as opposed to 'MyWeb', unless you named it MyWeb. .PARAMETER Site The address to the site collection. You can also pass a hostname and it'll figure it out. Don't want to specify the Site or Credential every time? Use Connect-SPRSite to create a reusable connection. See Get-Help Connect-SPRsite for more information. .PARAMETER Credential Provide alternative credentials to the site collection. Otherwise, it will use default credentials. .PARAMETER InputObject Allows piping from Connect-SPRSite .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch. .EXAMPLE Get-SPRList -Site intranet.ad.local -List 'My List' Creates a web service object for My List on intranet.ad.local. Figures out the wsdl address automatically. .EXAMPLE Connect-SPRSite -Site intranet.ad.local | Get-SPRList -List 'My List' Creates a web service object for My List on intranet.ad.local. Figures out the wsdl address automatically. .EXAMPLE Get-SPRList -Site intranet.ad.local -List 'My List' -Credential ad\user Creates a web service object for My List and logs into the webapp as ad\user. #> [CmdletBinding()] param ( [Parameter(Position = 0, HelpMessage = "Human-readble SharePoint list name")] [string[]]$List, [Parameter(Position = 1, HelpMessage = "Human-readble SharePoint web name")] [string[]]$Web, [Parameter(Position = 2, HelpMessage = "SharePoint Site Collection")] [string]$Site, [PSCredential]$Credential, [parameter(ValueFromPipeline)] [object]$InputObject, [switch]$EnableException ) process { if (-not $InputObject) { if ($Site) { $null = Connect-SPRSite -Site $Site -Credential $Credential $InputObject = $script:spweb } if ($Web) { $InputObject = Get-SPRWeb -Web $Web -Credential $Credential } elseif ($script:spweb) { $InputObject = $script:spweb } if (-not $InputObject) { Stop-PSFFunction -EnableException:$EnableException -Message "You must specify Site, Web or run Connect-SPRSite" return } } foreach ($server in $InputObject.Context) { if (-not $List) { try { $server.Load($script:spweb) $server.ExecuteQuery() $lists = $script:spweb.Lists $server.Load($lists) $server.ExecuteQuery() $lists | Select-DefaultView -Property Id, Title, Description, ItemCount, BaseType, Created } catch { Stop-PSFFunction -EnableException:$EnableException -Message "Failure" -ErrorRecord $_ } } else { foreach ($currentlist in $List) { try { $server.Load($script:spweb) $server.ExecuteQuery() $lists = $script:spweb.Lists $server.Load($lists) $server.ExecuteQuery() $thislist = $lists | Where-Object Title -eq $currentlist if ($thislist) { Write-PSFMessage -Level Verbose -Message "Getting $currentlist from $($server.Url)" $server.Load($thislist) $server.ExecuteQuery() Add-Member -InputObject $thislist -MemberType ScriptMethod -Name ToString -Value { $this.Title } -Force $thislist | Select-DefaultView -Property Id, Title, Description, ItemCount, BaseType, Created } } catch { Stop-PSFFunction -EnableException:$EnableException -Message "Failure" -ErrorRecord $_ } } } } } } |