Documents.CheckOut Method
Visio Automation Reference |
Marks a specified document as checked out and assigns edit privileges to the current user.
Version Information
Version Added:
Syntax
expression.CheckOut(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
Nothing
Remarks
Files must be stored in enhanced folders on a Microsoft SharePoint Portal Server computer to use the CheckIn and CheckOut methods.
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.
Visual Basic for Applications |
---|
|
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 |
---|
|
See Also