Documents.CanCheckOut method (Visio)

Specifies whether a document can be checked out from a Microsoft SharePoint Server computer.

Syntax

expression. CanCheckOut( _FileName_ )

expression A variable that represents a Documents object.

Parameters

Name Required/Optional Data type Description
FileName Required String The server path and name of the file.

Return value

Boolean

Remarks

You cannot check out a file that is already checked out or that is not stored in a document library on a computer running Microsoft SharePoint Server or Microsoft SharePoint Foundation.

Example

This example verifies that a document is not checked out by another user and that it can 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.