Table of Contents

CHECKIN Command

Description

Performs a check-in operation on a specified file or many files.

Syntax

checkin -search -recursive -filePath -comment -Checkinoptions

Parameters

  • search: The search operation to use.

  • recursive: When used with search, includes files in subfolders.

  • filePath: The file(s) to be checked in. This is the default parameter.

  • comment: The comment to add to the check-in. In the visual command builder, the default value is Checked by PDMShell.

  • Checkinoptions: The check-in options to use.

Examples

checkin -filePath "file1.sldprt"

Remarks

  • The search parameter searches the current directory and does not drill down. The search query is a PDM one, so you can use % for wildcard.
  • If combining Checkinoptions parameters, the user needs to add + between the values.

Checkinoptions Parameter Values:

Member Description
EdmUnlock_FailOnRegenerationNeed Fail if the file needs to be regenerated in the CAD program. NOTE: Only files resaved in SOLIDWORKS 2009 or later can trigger this flag
EdmUnlock_ForceUnlock Unlock the file even if it is not modified
EdmUnlock_IgnoreCorruptFile Ignore files with file formats unrecognized by SOLIDWORKS PDM Professional; without this flag, SOLIDWORKS PDM Professional returns E_EDM_INVALID_FILE if it encounters a corrupt file or a file containing a newer format than SOLIDWORKS PDM Professional can handle
EdmUnlock_IgnoreReferences Silently unlock parent files without their references
EdmUnlock_IgnoreRefsNotLockedByCaller Ignore references not locked by caller
EdmUnlock_IgnoreRefsOutsideVault Ignore references to files outside the vault
EdmUnlock_KeepLocked Keep the file checked out after creating the new version in the archive
EdmUnlock_OverwriteLatestVersion Do not create a new version; overwrite the last version of the file with new changes
EdmUnlock_RemoveLocalCopy Remove the local copy of the file from the hard disk after the file has been checked in
EdmUnlock_Simple Check in the file using default behavior

Availability

Available since PDMShell 2.0.0 or earlier.