Function ProServerMultiobjectsCheckout
Description
Checks out or downloads multiple objects 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 a 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>
ProServerMultiobjectsCheckout | |
( wchar_t** files /* (In) ProArray of top level objects to checkout or download. This can contain either aliased URLs 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 objects in its downloaded/checked out location. Free this array using ProWstringproarrayFree(). */ 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. | |
Conflicts occurred. Check the details in the conflicts return. |
See Also
User Guide References