Function ProServerObjectsCheckout
Description
Checks out or downloads an object to the workspace. Checkout rules are processed based on the Workspace config spec, unless the version is set using ProServercheckoutoptsVersionSet(). If the config spec is LATEST, for example, the latest version of the indicated object(s) will be checked out.If an aliased URL path to the model is supplied, and more than one revision of the model is in the path, Creo Parametric will apply the workspace config spec rules against the objects which reside in that folder.
Replacement in Object TOOLKIT: |
Synopsis
#include <ProWTUtils.h>
ProServerObjectsCheckout | |
( ProMdl mdl /* (In) The top level object to checkout. Can be NULL. */ wchar_t* file /* (In) The top level object to checkout or download. Can be NULL. (One of mdl and aliased_url must not be NULL). This can be either an aliased URL to a given object or the object name. If an aliased URL path to the model is supplied, and more than one revision of the model is in the path, Creo Parametric will apply the workspace config spec rules against the objects which reside in that folder. */ ProBoolean checkout /* (In) PRO_B_TRUE to checkout and download, PRO_B_FALSE to download without checking out. */ ProServerCheckoutOptions options /* (In) An opaque handle to checkout options. Pass NULL for a default checkout (as per Creo Parametric's Checkout button in the File menu). */ wchar_t** object_url /* (Out) The url to the top level object in its downloaded/checked out location. Free this string using ProWstringFree(). */ ProServerCheckoutConflicts* conflicts /* (Out) Information about checkout conflicts. NULL if the error return != PRO_TK_CHECKOUT_CONFLICT. Pass NULL if not interested in conflicts details. */ ) |
Returns
The function succeeded. | |
One or more inputs was invalid. | |
The top level object was not found. | |
The primary server is not set when mdl is passed. | |
Conflicts occurred. Check the details in the conflicts return. |
Sample Code References
User Guide References