Share

acdbOverlayXref

C++

Acad::ErrorStatus acdbOverlayXref(
    AcDbDatabase* pHostDb, 
    const ACHAR * pFilename, 
    const ACHAR * pBlockName, 
    AcDbObjectId& xrefBlkId
);

File

acdbxref.h

Description

Overlays the xref file specified by pFilename to the database specified by pDb, thus creating a new xref AcDbBlockTableRecord. The new block table record's name is specified in pBlockName. Its object ID is returned in xrefBlkId.

This function does not lock the document, nor does it create an AcDbBlockReference instance of the new block table record.

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

This function is available to non-AutoCAD-based host applications.

Returns Acad::eOk if the operation is successful.

Returns Acad::eInvalidInput if either pDb or pFilename is null.

Parameters

Parameters Description
pHostDb Input pointer to host AcDbDatabase
pFilename Input xref file path name
pBlockName Input xref block name symbol to use
xrefBlkId Output object ID of the attached xref block

Was this information helpful?