AcDbObject::xData

C++

virtual ACDBCORE2D_PORT resbuf* xData(
    const ACHAR* regappName = nullptr
) const;

Description

Returns a linked list of resbuf structures containing a copy of the xdata for the object. If regappName == NULL is passed in, all xdata is returned, otherwise only the xdata for the specified name is returned. If not all xdata is required, but the xdata for more than one regappName is desired, then multiple calls to this member function must be made--one for each regappName.

The caller of this function is responsible for releasing the memory used by the resbuf list that is returned. The most commonly used way to deallocate such a list is via the acutRelRb() function.

This function is virtual because some objects or entities may need to store some or all of their "built-in" state as xdata. Classes defining such objects can override this function in order to monitor and validate xdata requests as they see fit. If an object does not care about what xdata is attached to it (which is the preferred practice), then it need not override this member.

If a failure accessing the xdata occurs, NULL is returned.

Parameters

Links

AcDbObject