Category Windchill servers, Object ProServer

Function ProServerObjectsCheckin


Description
Checks in or uploads objects to the database.

NOTE: The model must be saved to the workspace (using ProMdlSave() before it can be checked in or uploaded. This function does not save the model by default.

NOTE:This function checks in the target objects by default. To upload only use ProServercheckinoptsUploadonlySet().

Replacement in Object TOOLKIT: pfcServer::UploadObjectsWithOptions
pfcServer::CheckinObjects
Synopsis
#include <ProWTUtils.h>
ProErrorProServerObjectsCheckin(
ProMdl mdl
/* (In)
The top level model to checkin or upload. Can be NULL (to check in or upload the entire workspace).
*/
ProServerCheckinOptions options
/* (In)
An opaque handle to checkin or upload options. Pass NULL for a default checkin (as per Creo Parametric's Checkin button in the File menu).
*/
ProServerCheckinConflicts* conflicts
/* (Out)
Information about checkin or upload conflicts. NULL if the error return != PRO_TK_CHECKOUT_CONFLICT. Pass NULL if not interested in conflicts details.
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSOne or more inputs was invalid.
PRO_TK_BAD_CONTEXTThe primary server is not set and/or Design Test Mode
is activethe function is not available in this mode.
PRO_TK_CHECKOUT_CONFLICTConflicts occurred. Check the details in the conflicts return.
PRO_TK_NO_PERMISSIONThe function does not have permission to operate on this model.
See Also
ProServercheckinoptsAlloc
ProServercheckinoptsDeflocationSet
ProServercheckinoptsLocationAdd
ProServercheckinoptsBaselineSet
ProServercheckinoptsKeepcheckedoutSet
ProServercheckinoptsAutoresolveSet
ProServercheckinoptsUploadonlySet

Manual References:

  1. Technical Summary of Changes for Creo 11.0.0.0: Updates to Error Types
  2. Data Management: Windchill Operations: Upload
  3. Data Management: Windchill Operations: CheckIn
  4. Data Management: Windchill Operations: CheckIn
  5. Data Management: Windchill Operations: Conflicts During Server Operations
  6. Data Management: Windchill Operations: Sample Batch Workflow

Sample Code References:

  1. pt_wc_server ( PTWCServerAddInstance.c )
  2. pt_wc_server ( PTWCServerPopulate.c )
  3. pt_wc_server ( PTWCServerUtils.c )