Autodesk Vault ProfessionalVault API

CheckoutFile Method

Autodesk.Connectivity.WebServices›DocumentService

Checks out a file from the vault.

Required Permissions

FileCheckOut

Syntax

public override File CheckoutFile(
   System.long fileId,
   CheckoutFileOptions option,
   System.string machine,
   System.string localPath,
   System.string comment,
   out ByteArray downloadTicket
)
Public Overrides NotOverridable Function CheckoutFile( _
   ByVal fileId As System.Long, _
   ByVal option As CheckoutFileOptions, _
   ByVal machine As System.String, _
   ByVal localPath As System.String, _
   ByVal comment As System.String, _
   ByRef downloadTicket As ByteArray _
) As File

Parameters

NameDescription
fileIdThe file ID value.
optionSpecifies where the placeholder information is to be taken from.
machineThe client's computer name.
localPathThe location of the checked-out file on the client's machine.
commentAssociates a comment with the checked out file. When the file is checked in, this comment is replaced with the check-in comment.
downloadTicketAn identifier to use for downloading the binary data. Ignore this value if no download operation is needed.

Return Value

When a file is checked out, a new version of the file is created as a placeholder. This placeholder is returned in the form of a File object.

See Also