Documents.CheckOut method (Word)
Copies a specified document from a server to a local computer for editing.
Syntax
expression.CheckOut (FileName)
expression Required. A variable that represents a Documents object.
Parameters
Name | Required/Optional | Data type | Description |
---|---|---|---|
FileName | Required | String | The name of the file to check out. |
Remarks
To take advantage of the collaboration features built into Word, documents must be stored on a Microsoft SharePoint Portal Server.
Example
This example verifies that a document is not checked out by another user and that it can be checked out. If the document can be checked out, it copies the document to the local computer for editing.
Sub CheckInOut(docCheckOut As String)
If Documents.CanCheckOut(docCheckOut) = True Then
Documents.CheckOut docCheckOut
Else
MsgBox "You are unable to check out this document at this time."
End If
End Sub
To call the CheckInOut subroutine, use the following subroutine and replace the "https://servername/workspace/report.doc" file name with an actual file located on a server mentioned in the Remarks section.
Sub CheckDocInOut()
Call CheckInOut (docCheckIn:="https://servername/workspace/report.doc")
End Sub
Support and feedback
Have questions or feedback about Office VBA or this documentation? Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for