GRX Cookbook 04: Attaching Binary ERP/PLM Metadata via XData (1001 RegApps) and AcDbXrecord Dictionaries
Store structured BOM part numbers, material grades, and cryptographic signatures inside DWG entities using Extended Entity Data (XData) and Extension Dictionaries (`AcDbXrecord`).
1. Attaching Invisible PLM/BIM Metadata: Extended Entity Data (`XData` 16KB Limit) vs. Unlimited `AcDbXrecord` Dictionaries
Commercial CAD plugins must persist non-graphical engineering data—such as SAP material master UUIDs, structural load ratings, or pipe stress node numbers—directly inside the `.dwg` file so metadata travels with the geometry across subcontractors. The GstarCAD GRX SDK provides two distinct persistence mechanisms: lightweight `XData` (`resbuf` linked lists attached to any `AcDbObject`) and arbitrary-capacity `AcDbXrecord` objects stored inside an entity's `ExtensionDictionary`.
Critical Kernel & Memory Safety Rule: Legacy `XData` (DXF group codes `1000–1071` registered under a mandatory `acdbRegApp` application name) is strictly capped at **16 KB per entity**. If your plugin stores serialized JSON schemas, XML trees, or dense coordinate arrays exceeding 16 KB, always instantiate an `AcDbXrecord` inside `object->createExtensionDictionary()`, which supports hundreds of megabytes per record without size limits.
2. Verified C++17 GRX Implementation (AcDbXrecord)
Compile the following native C++ source code against the GstarCAD 2027 GRX SDK using Visual Studio 2022 (Platform Toolset v143, Target Architecture x64, linking grx27.lib and gcdb27.lib) to implement GRX Cookbook 04: Attaching Binary ERP/PLM Metadata via XData (1001 RegApps) and AcDbXrecord Dictionaries:
// GstarCAD 2027 GRX SDK — Attaching Structured AcDbXrecord Metadata
#include "grxdefs.h"
#include "dbxrecrd.h"
#include "dbdict.h"
void AttachPlmXrecord(AcDbObject* pObj, const ACHAR* partId) {
pObj->createExtensionDictionary();
AcDbObjectId dictId = pObj->extensionDictionary();
AcDbDictionary* pDict = nullptr;
if (acdbOpenObject(pDict, dictId, AcDb::kForWrite) == Acad::eOk) {
AcDbXrecord* pXrec = new AcDbXrecord();
resbuf* pRb = acutBuildList(AcDb::kDxfText, partId, RTNONE);
pXrec->setFromRbChain(*pRb);
acutRelRb(pRb);
AcDbObjectId xrecId;
pDict->setAt(_T("GSTAR_PLM_DATA"), pXrec, xrecId);
pXrec->close();
pDict->close();
}
}
3. ObjectARX-to-GRX & .NET API Porting Matrix
When dual-targeting plugins for both AutoCAD and GstarCAD 2027 from a unified Git repository, reference the following symbol, header, and assembly mapping table:
| SDK Dimension | AutoCAD® ObjectARX / .NET | GstarCAD 2027 GRX / .NET Equivalent |
|---|---|---|
| Target API Classes | AcDbXrecord, AcDbDictionary, xData, setXData, acdbRegApp, resbuf |
Identical class & method signatures via compat headers |
| C++ Binary Extension | *.arx / *.dbx |
*.grx / *.tx (Loaded via APPLOAD or Registry) |
| Managed .NET Assemblies | acmgd.dll, acdbmgd.dll, accoremgd.dll |
GsMgd.dll, GsDbMgd.dll (Set Copy Local = False) |
4. Memory Management, Thread Safety & QA Checklist
- Deterministic Object Closure & Transaction Disposal: In C++ GRX, every
acdbOpenObject()call that returnsAcad::eOkmust be paired with an explicitpObj->close()before starting a command or returning control to the editor. In C# .NET, always wrapStartTransaction()inside ausingblock and explicitly calltr.Commit(). - Document Locking from Modeless Contexts: Whenever modifying the active DWG database from a modeless WPF
PaletteSet, WinForms dialog, or external COM event, acquire a write lock viadoc.LockDocument()to preventeLockViolationexceptions. - Multi-Core Fiber & Main-Thread Discipline: The DWG database (`AcDbDatabase`) is not thread-safe for concurrent writes. Offload heavy geometric calculations or SQL/REST I/O to background worker threads, then marshal database mutations back to the main CAD UI thread.
Production Compilation, Packaging & Enterprise Deployment Guide
When deploying this developer recipe into commercial enterprise production, development leads should configure automated CI/CD build agents (GitHub Actions or Azure DevOps) using MSBuild command-line flags. Ensure that all dependent assemblies (such as GsMgd.dll and GsDbMgd.dll) have their reference property set to Copy Local = False (Private=False) to prevent deployment conflicts with the host GstarCAD 2027 application folder:
- Target Framework Alignment: For C# .NET plugins, target .NET Framework 4.8 or .NET 8.0 Windows Desktop runtime depending on your GstarCAD host version. For C++ GRX extensions, compile using Visual Studio 2022 (MSVC v143) with the platform toolset set to 64-bit (x64) and Character Set set to Unicode.
- Registry-Free Autoloading (.bundle): Package your compiled binary and menu CUIX files into an Autodesk/GstarCAD-compatible Application Package bundle folder (e.g.,
EnterprisePlugin.bundle/PackageContents.xml) and deploy directly to%APPDATA%\Autodesk\ApplicationPluginsor%PROGRAMDATA%\Gstarsoft\ApplicationPluginsfor automatic silent loading without requiring administrative Windows registry rights. - Automated Exception Trapping & Telemetry: Always wrap top-level command methods and event handlers inside structured
try-catchor AutoLISPvl-catch-all-applyblocks to log diagnostic stack traces to corporate log repositories rather than letting unhandled exceptions crash the host drawing session.
| Build Artifact | Production Location | Deployment Verification Gate |
|---|---|---|
| C++ GRX Binary | bin/x64/Release/*.grx |
Verify zero unresolved DLL imports via Dependency Walker / dumpbin /dependents. |
| Managed .NET DLL | bin/Release/net48/*.dll |
Confirm assemblies are strong-name signed and pass NETLOAD in GstarCAD 2027. |
| AutoLISP / VLX | build/dist/*.vlx or *.lsp |
Verify clean loading in Startup Suite (APPLOAD) with zero console syntax errors. |