Share

AcAxGetXData

C++

HRESULT AXAUTOEXP AcAxGetXData(
    const AcDbObjectId& objId, 
    BSTR bstrName, 
    VARIANT* type, 
    VARIANT* data
);

File

axboiler.h

Description

Gets the xdata on the object identified by the objId.

Note

Each element in type corresponds to an element in data.

Returns HRESULT. The macros SUCCEEDED() and FAILED() can be used to determine whether the function succeeded. The return value should be forwarded to the COM client; nothing else needs to be done. The function cleans up after itself in case of an error and also sets up the Error Info object that can be queried from the COM client to get specific information about what caused any given failure.

Parameters

Parameters Description
objId Input object ID of object for which to get xdata
bstrName Input name of the registered application to use when retrieving the xdata
type Pointer to VARIANT that will be populated with a SAFEARRAY of shorts (VT_I2) where each element represents the DXF group code of the associated xdata value
data Pointer to VARIANT that will be populated with a SAFEARRAY of variants (VT_VARIANT) where each element represents the xdata value

Was this information helpful?