fnGetAttribute


Prototype

const char* __cdecl fnGetAttribute
    (
        unsigned long ulThemeKey,
        CShapeRecord *pShape,
        size_t nCol
    );

Return value

None

Parameters

ulThemeKey

Theme specific data. This value was defined by the plugin in the fnLoadShapes function.

pShape

Shape for which attributes are queried.

nCol

Zero-based index of the attribute queried. This value ranges from 0 to fnGetAttributeCount - 1.

Remarks

Currently, ShapeUp does not require this function to be thread safe. However, if you plan on using this loader from SUIS, this function must be thread safe since there may be many clients accessing this function simultaneously.

Example

const char* __cdecl fnGetAttribute (
    unsigned long ulThemeKey,
    CShapeRecord *pShape,
    size_t nCol )
{
    MyThemeData *pData = (MyThemeData*) ulThemeKey;
    switch (nCol)
    {
    case NAME_COLUMN:
        return pData->GetName(pShape);
    default:
        break;
    }
    
    return "";
} 

See Also

Loader API, fnLoadShapes, fnGetAttributeCount