Documents.CheckOut method (Visio)

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

Syntax

expression.CheckOut (FileName)

expression A variable that represents a Documents object.

Parameters

Return value

Nothing

Remarks

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.

Example

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  
    Else  
        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:="https://servername/workspace/drawing.vdx ")  
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.