VCOM:VectorWorks:UI:IProgressDialog::DoYield

From Vectorworks Developer
Jump to navigation Jump to search

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Description

namespace VectorWorks::UI

Member of VCOM:VectorWorks:UI:IProgressDialog

Call this function regulary to allow the dialog to update properly, and VectorWorks process to update prefenting it from hangnig.

virtual VCOMError VCOM_CALLTYPE DoYield( )= 0;

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

kVCOMError_NotInitialized Bad VCOM instance used to call the fuction.
kVCOMError_Failed Routine failed.