Share via

Documents.CanCheckOut Method

  • Article
Visio Automation Reference

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

Version Information
 Version Added:  Visio 2002 SR-1

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 is not stored in an enhanced folder on a Microsoft SharePoint Portal Server computer.

Example

This example verifies that a document is not checked out by another user and that it can be checked out.

Visual Basic for Applications 
  
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 in an enhanced folder on a Microsoft SharePoint Portal Server computer.

Visual Basic for Applications 
  
Sub DocOut() 
    Call CheckDocOut _ 
        (strDocCheckOut:="http://servername/workspace/drawing.vdx") 
End Sub

See Also