close_active_document
Closes the active SolidWorks document to prevent file collisions; defaults to error on unsaved changes unless force discards them.
Instructions
Cerrar el documento activo en SolidWorks.
Útil para flujos iterativos (build → save_as → close → new_part → rebuild) que de otra manera dejan ventanas viejas abiertas y hacen que save_as falle por colisión de archivo. Por defecto exige que el documento esté guardado; pasa force=True para descartar cambios sin aviso. [en: Close the active document in SolidWorks. Used in iterative build/save/rebuild flows that otherwise pile up open windows and make save_as collide on the open file. Default refuses to close a dirty doc; force=True discards unsaved changes silently.]
Args: force: False (default) raises if the active document has unsaved changes. True silently discards them — use ONLY when the doc is disposable (e.g., rebuilding from scratch). Distinct verbs under the hood: ISldWorks.CloseDoc for clean docs, ISldWorks.QuitDoc for force-discards.
Returns dict: closed: True if the close succeeded. name: The document title at the time of close (trailing '*' stripped if present). was_modified: Whether the document had unsaved changes at the moment of close (== True only when force=True was needed).
Raises: - SolidWorksError if no active document. - SolidWorksError if the document was dirty and force=False.
Example — canonical iterative-rebuild flow: save_as(r"C:\CAD\output\shaft.SLDPRT") close_active_document() # default: errors if unsaved new_part() # fresh blank # ... rebuild geometry ...
Example — force-close a throwaway probe: close_active_document(force=True)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| force | No |