Category Pro/INTRALINK, Object ProObj

Function ProObjModelsCheckOut


DEPRECATED: Since Creo 1
SUPERSEDED BY: ProServerObjectsCheckout,ProServerMultiobjectsCheckout
Description

NOTE: This function is deprecated. Pro/INTRALINK 3.4 is not supported. Please use Pro/INTRALINK 10.0 functions ProServerObjectsCheckout() or ProServerMultiobjectsCheckout() instead.

Checks out the latest version of Pro/INTRALINK objects from the Commonspace to a Workspace using a a non-Pro/INTRALINK process.
Replacement in Object TOOLKIT: pfcBaseSession::CheckoutToWS
Synopsis
#include <ProWorkspace.h>
ProErrorProObjModelsCheckOut(
ProBoolean linkOrCopy
/* (In)
If this is PRO_B_TRUE, check out the object as a copy; otherwise, check out as a link.
*/
ProName workspaceName
/* (In)
The name of the Workspace to which the objects are checked out.
*/
int objNo
/* (In)
The number of objects to check out.
*/
ProFileName* objNames
/* (In)
An array of names of objects to check out, in the format "object.ext".
*/
int* objVersions
/* (In)
Reserved for future use. Pass NULL.
*/
int relCriteria
/* (In)
The relationship criteria. This argument identifies which dependents should be checked out with the objNames. The possible values are as follows:
  • 1 -- Include all the dependents.
  • 2 -- Include the required dependents only.
  • 3 -- Do not include any dependents.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully checked out the objects.
PRO_TK_BAD_INPUTSThe specified number of objects is less than zero, the relationship criteria is not valid, the Workspace name is invalid, or the object versions do not exist.
PRO_TK_E_NOT_FOUNDThe specified objects were not found in the Commonspace; or the Pro/INTRALINK Client is not in the latest frame when attempting the checkout.
PRO_TK_COMM_ERRORA Pro/INTRALINK Client is not available, and the Creo Parametric user has not registered Pro/INTRALINK as a server. (This function will work if the Pro/INTRALINK client has been authenticated previously through the Creo Parametric dialog.)
PRO_TK_NOT_IMPLEMENTEDInitially, some of the options above might not be implemented.
PRO_TK_GENERAL_ERRORAnother problem occurred and the function failed.

Manual References:

  1. Technical Summary of Changes for Creo 11.0.0.0: Functions superseded from Creo 1.0 to Creo 11.0