Autodesk Vault ProfessionalVault API

CheckinFile(FileIteration,String,Boolean,DateTime,FileAssocParam[],BOM,Boolean,String,FileClassification,Boolean,Stream) Method

Autodesk.DataManagement.Client.Framework.Vault.Services.ConnectionIFileManager

Checks in a file to the Vault.

Syntax

FileIteration CheckinFile(
   FileIteration file,
   System.string comment,
   System.bool keepCheckedOut,
   System.DateTime lastWrite,
   FileAssocParam[] associations,
   BOM bom,
   System.bool copyBom,
   System.string newFileName,
   FileClassification classification,
   System.bool hidden,
   System.IO.Stream contents
)
Overloads Function CheckinFile( _
   ByVal file As FileIteration, _
   ByVal comment As System.String, _
   ByVal keepCheckedOut As System.Boolean, _
   ByVal lastWrite As System.Date, _
   ByVal associations() As FileAssocParam, _
   ByVal bom As BOM, _
   ByVal copyBom As System.Boolean, _
   ByVal newFileName As System.String, _
   ByVal classification As FileClassification, _
   ByVal hidden As System.Boolean, _
   ByVal contents As System.IO.Stream _
) As FileIteration

Parameters

NameDescription
fileThe file to check-in.
commentText data to be associated with the check-in.
keepCheckedOutIf true, the new version gets uploaded and versioned, but the file is still checked out to the user.
lastWrite
associationsThe associations on the file.
bomA bill of materials to associate with this file. Null should be passed in if there is no BOM.
copyBomIf this value is true and the 'bom' parameter is null, the BOM from the previous version will be copied for this version.
newFileNameAllows the file to be renamed during check-in. Pass in null to keep the file name the same.
classificationThe classification for the file.
hiddenA flag to indicate if a file should be hidden.
contentsContents of the new iteration of the file.

Return Value

The newly created iteration of the file. An empty stream indicates a zero-length file. A null value indicates that the file data has not changed since the last version.

See Also