BrokenLinkCancelEnabled

Writing a TRUE value enables the functions ProjectUpdatePages or PageOpen to exit and report the error E-POINTER when encountering the first broken link (missing reference) during execution. If set to FALSE, these functions will succeed, but will issue a BrokenLink event for every unresolved reference on a page.

Syntax

BrokenLinkCancelEnabled(CancelEnabled)

CancelEnabled:

TRUE if enabled.

Return Value

If retrieving the current setting, TRUE or FALSE. If setting this option, 0 (zero) if successful. In both cases, an error is returned if unsuccessful.

For details and a VB example on handling return and error values, see Error Handling.

Related Functions

BrokenLink, ProjectUpdatePages, PageOpen

Note: This function is implemented in the C++ environment as two separate functions: put_BrokenLinkCancelEnabled enables or disables this option, and get_BrokenLinkCancelEnabled retrieves the current setting.