Table of contents
Collapse the table of content
Expand the table of content

Documents.CheckOut Method (Visio)

office 365 dev account|Last Updated: 6/12/2017
1 Contributor

Marks a specified document as checked out and assigns edit privileges to the current user.


expression . CheckOut( FileName )

expression A variable that represents a Documents object.


NameRequired/OptionalData TypeDescription
FileNameRequiredStringThe server path and name of the file.

Return Value



To check out a file, it must be stored in a document library on a computer running Microsoft SharePoint Server or Microsoft SharePoint Foundation.

Unlike the behavior in the user interface, the CheckOut method does not open the document. Use the Open method to open the document in the drawing window after checking it out.


This example verifies that a document can be checked out. If it can, this example checks it out; otherwise, it returns a message that the document cannot be checked out.

Sub CheckDocOut(strDocCheckOut As String)  
    If Documents.CanCheckOut(strDocCheckOut) = True Then  
        Documents.CheckOut strDocCheckOut  
        MsgBox "You are unable to check out this document " _  
            &; "at this time."  
    End If    
End Sub

To call the preceding CheckDocOut subroutine, use the following subroutine and replace servername/workspace/drawing.vdx with the path to and name of an actual file located on a Microsoft SharePoint Server computer.

Sub DocOut()  
    Call CheckDocOut _  
        (strDocCheckOut:="http://servername/workspace/drawing.vdx ")  
End Sub
© 2018 Microsoft