Check Out DesignSync Files

The checkout operation for DesignSync files follow the same sequence as checkout of ordinary files.

As with checkin, the check and action triggers are available. Macros available to these triggers include VCINDEX, containing the index number of the vcconnection (the connection associating the business object to the DesignSync file). The index number provides all other information about the connection including the format and filename. Therefore, the checkin event macros FORMAT, FILENAME_ORIGINAL and FILENAME are not available.

For information on how to write a client that performs a checkout of a vcfile, see Write Checkout of Vcfile and Vcfolder.

To check out a different version of a vcfile than the one it specifies, you need to pass in a string that has one of these keywords:

  • selector
  • versionid
  • versiontag
  • branchid
  • branchtag

followed by a colon, followed by the appropriate specification of a selector, versionid, versiontag, branchid, or branchtag. If branchid or branchtag is used, it can optionally be followed by a colon and a qualifier (where the qualifier is in the form allowed when specifying a vcfile connection).