Document.CheckIn Method

  • Article
Visio Automation Reference

Returns a document from a local computer to a Microsoft SharePoint Portal Server computer.

Version Information
 Version Added:  Visio 2002 SR-1

Syntax

expression.CheckIn(SaveChanges, Comments, MakePublic)

expression   A variable that represents a Document object.

Parameters

Name Required/Optional Data Type Description
SaveChanges Optional Boolean True (non-zero) to save document changes before check-in; False (0) to check the document in without saving changes. The default is True.
Comments Optional Variant Any comments to be stored with this revision of the document (applies only if SaveChanges equals True).
MakePublic Optional Boolean True to publish the document after check-in. This submits the document for the approval process or, if there is no approval routing for the document, a public version is created that is available to readers of the folder (applies only if SaveChanges equals True); False leaves the document available only for private viewing. The default is False.

Return Value
Nothing

Remarks

After the document has been checked in using the CheckIn method, the document is closed. This behavior is different from the user interface; when you check in a document in the user interface, the document is closed and re-opened as read-only.

To use the CheckIn method, files must be stored in enhanced folders on a Microsoft SharePoint Portal Server computer.

Example

This example checks the server to see if the specified document can be checked in. If it can, this example saves and closes the document, and then checks it back into the server.

Visual Basic for Applications 
  
Sub CheckDocIn(varDocCheckIn As Variant)
 
    If Documents.Item(varDocCheckIn).CanCheckin = True Then 
        Documents.Item(varDocCheckIn).CheckIn 
        MsgBox varDocCheckIn & " has been checked in." 
    Else 
        MsgBox "This file cannot be checked in " _ 
            & "at this time. Please try again later." 
    End If  
 
End Sub

To call the preceding CheckDocIn 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 DocIn() 

Call CheckDocIn _ 
    (varDocCheckIn:="http://<em>servername/workspace/drawing.vdx</em>")



End Sub

See Also