CheckinFile(FileIteration,String,Boolean,FileAssocParam[],BOM,Boolean,String,FileClassification,Boolean,FilePathAbsolute) Method
Checks in a file to the Vault.
Syntax
FileIteration CheckinFile(
FileIteration file,
System.string comment,
System.bool keepCheckedOut,
FileAssocParam[] associations,
BOM bom,
System.bool copyBom,
System.string newFileName,
FileClassification classification,
System.bool hidden,
FilePathAbsolute filePath
)Overloads Function CheckinFile( _
ByVal file As FileIteration, _
ByVal comment As System.String, _
ByVal keepCheckedOut As System.Boolean, _
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, _
Optional ByVal filePath As FilePathAbsolute _
) As FileIterationParameters
| Name | Description |
|---|---|
| file | The file to check-in. |
| comment | Text data to be associated with the check-in. |
| keepCheckedOut | If true, the new version gets uploaded and versioned, but the file is still checked out to the user. |
| associations | The associations on the file. |
| bom | A bill of materials to associate with this file. Null should be passed in if there is no BOM. |
| copyBom | If this value is true and the 'bom' parameter is null, the BOM from the previous version will be copied for this version. |
| newFileName | Allows the file to be renamed during check-in. Pass in null to keep the file name the same. |
| classification | The classification for the file. |
| hidden | A flag to indicate if a file should be hidden. |
| filePath | The location of the file on disk. If null, the working folder location will be used. |
Return Value
The newly created iteration of the file.