Skip to content

Latest commit

 

History

History
68 lines (50 loc) · 1.6 KB

Set-PnPFileCheckedOut.md

File metadata and controls

68 lines (50 loc) · 1.6 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Set-PnPFileCheckedOut

SYNOPSIS

Checks out a file

SYNTAX

Set-PnPFileCheckedOut -Url <String>
                      [-Web <WebPipeBind>]
                      [-Connection <SPOnlineConnection>]

EXAMPLES

------------------EXAMPLE 1------------------

PS:>Set-PnPFileCheckedOut -Url "/sites/testsite/subsite/Documents/Contract.docx"

Checks out the file "Contract.docx" in the "Documents" library.

PARAMETERS

-Url

The server relative url of the file to check out

Type: String
Parameter Sets: (All)

Required: True
Position: 0
Accept pipeline input: True

-Connection

Optional connection to be used by cmdlet. Retrieve the value for this parameter by eiter specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type: SPOnlineConnection
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type: WebPipeBind
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

RELATED LINKS

SharePoint Developer Patterns and Practices