acedXrefUnload

C++

Acad::ErrorStatus acedXrefUnload(
    const ACHAR* XrefBlockname, 
    const bool bQuiet = true, 
    AcDbDatabase* pHostDb = NULL
);

File

acedxref.h

Description

Unloads the xref block by its given block name. This assumes a valid xref block exists in the database specified by pHostDb (or the current document if pHostDb == NULL).

This function operates on the database specified by pHostDb, or on the current document if pHostDb == NULL. It provides document locking (if current document is used as the host) and session fiber mode internally. If these conditions are not met, the function returns Acad::ErrorStatus eLockViolation. No input validation or range checking is done other than checking for NULL pointers or strings. Input validation is the caller's responsibility.

Xref log file processing is available if that option is enabled. Normal AutoCAD behavior with regards to output indicators, such as progress meters and messages, may be turned off when scripts enabled && cmdecho == 0, or menu macros enabled && menuecho == 0, or menu encryption set.

Returns Acad::eOk if operation is successful.

Parameters