I have a powershell script that inserts webparts onto a page. The problem is that if I don't have the page checked out it will throw the following error:

Exception calling "AddWebPart" with "3" argument(s): "The file is not checked out. You must first check out this document before making changes." At C:\temp\AddWebParts.ps1:49 char:27

Is it possible to checkout a page using PowerShell?


Found this after doing a little more research:

$Site = Get-SPWeb $siteurl

Hope this helps someone!


yes, if you have SPListItem, you may call

$file = $listItem.File;
  • Thanx! This works great. How do you check in the same file again? – Benny Skogberg Apr 23 '12 at 13:20

I think the POSH script excerpts above (by Abe & Ashish) would work but also verify the CheckOut & Lock status property of the file prior to checking it out: $fooFile.CheckOutType - this returns enum type showing online, offline & none. To check the file property LockType - $fooFile.LockType which returns enum SPLockType (exclusive, shared & none).

  • The code will be similar to the following: 1. $fooWeb = Get-SPWeb("FooWebURL"); 2. $fooFile = $fooWeb.GetFile("FooFile"); 3. if($fooFile.CheckOutType -eq "None" -And $fooFile.LockType -eq "None") 4. { $fooFile.CheckOut() 5. Write-Host $fooFile.Name Checked out 6. } else 7. { Write-Host $fooFile.Name already Checked out or locked } 8. $fooWeb.Dispose() – Supriyo SB Chatterjee Dec 16 '11 at 21:21

Below script will help you to checkout file

$urlWeb = "http://mysite"
$urlWebWP =  "http://mysite/pages/default.aspx"

$web = Get-SPWeb 
$urlWeb $page =  $web.GetFile($urlWebWP)

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.