Category Creo Parametric fundamentals, Object ProMdl

Function ProMdlIsSaveAllowed


Description
Check if given model can be saved along with all its subordinate models that are to be saved together with it according to their modification status and the configuration option 'save_objects'. Note this will also check the current UI context to see if it is currently safe to save the model, and so calling this function at different times might return different results. A negative result indicates that ProMdlSave() would fail for this model.
Replacement in Object TOOLKIT: pfcModel::CheckIsSaveAllowed
Synopsis
#include <ProMdl.h>
ProErrorProMdlIsSaveAllowed(
ProMdl p_model
/* (In)
Model to check access to.
*/
ProBoolean show_ui
/* (In)
Indicates whether the Conflicts dialog should be shown to user to resolve conflicts (if they are detected); when set to PRO_B_FALSE no UI is enabled and the model is considered as modifiable if there are no conflicts that could not be overridden or resolved by default resolution actions.
*/
ProBoolean* save_allowed
/* (Out)
The save access status. If it is PRO_B_TRUE, the check is successful. If it is PRO_B_FALSE, the model or at least one of its subordinate models can not be saved due to remaining unresolved non-overridable conflicts. Conflicts will not be shown if the model currently cannot be saved due to UI restrictions; the function will return PRO_B_FALSE regardless of this flag.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the information.
PRO_TK_BAD_INPUTSOne or more arguments are invalid.
PRO_TK_GENERAL_ERRORThe function could not check access to the model.

Manual References:

  1. Core: Models and Model Items: File Management Operations
  2. Core: Models and Model Items: File Management Operations