#include <SFBvProperty.h.hpp>

class SFBvProperty : public SFBvObject;

SFMTYPEDEFWRAPPER(SFBvProperty)

[ public ]
SFCError AddParm(
    SFBvParmSmpConstRef param   // the paramter to be added to the property
);

[ public ]
SFCError GetGroupName(
    ACharPtr buffer     // pointer to the buffer where group name will be stored
    SInt32 size         // size of buffer
    SInt32Ptr sizereq   // If buffer is null, the size required is returned
);

[ public ]
SFCError GetGroupName(
    SFXAnsiStringPtr name   // group name
);

[ public ]
SFCError GetId(
    AEEVProperty * propertyId   // upon return contains the property ID
);

[ public ]
SFCError GetNumberOfParms(
    AEEVParameter paramId   // parameter ID for which the objects cnt has to be retrieved
    SInt32Ptr num           // holds the number of SFBvParm objects with the specified id
);

[ public ]
SFCError GetParmAtIndex(
    AEEVParameter paramId   // parameter ID for which the object has to be retrieved
    SInt32 index            // the index at which the object has to be retrieved, the index is zero based
    SFBvParmSmpPtr param    // holds a pointer to the returned SFBvParm object
);

[ public ]
SFCError GetPropertyName(
    ACharPtr buffer     // pointer to the buffer where the name will be stored
    SInt32 size         // size of buffer
    SInt32Ptr sizereq   // If buffer is null, the size required is returned
);

[ public ]
SFCError GetPropertyName(
    SFXAnsiStringPtr name   // property name
);

[ public ]
SFCError InitProperty(
    AEEVProperty propertyId   // property ID, with which this object has to be initialised
    ACharPtr name             // property name, with which the user wants to initialize
    Bool parsed               // indicates whether the passed in value pValue is according to the data types mentioned, or a raw buffer, if raw buffer then it has to be encoded in UTF-8 charset
    VoidPtr value             // property value
    SInt32 size               // size of the property value
    ACharPtr group            // null-terminated property group name (optional)
);

[ public ]
SFCError InitProperty(
    AEEVProperty propertyId       // property ID, with which this object has to be initialised
    SFXAnsiStringConstRef name    // property name, with which the user wants to initialize
    Bool parsed                   // indicates whether the passed in value pValue is according to the data types mentioned, or a raw buffer, if raw buffer then it has to be encoded in UTF-8 charset
    SFXBufferConstRef value       // property value
    SFXAnsiStringConstRef group   // group name
);

[ public, static ]
SFBvPropertySmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBvPropertySmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

[ public ]
SFCError ParseValue(
    Bool parsed         // indicates whether user wants a raw data buffer or parsed
    VoidPtr buffer      // pointer to the buffer where parsed property value will be stored
    SInt32 size         // size of buffer
    SInt32Ptr sizereq   // If buffer is null, the size required is returned, ignored, otherwise
);

[ public ]
SFCError ParseValue(
    Bool parsed           // indicates whether user wants a raw data buffer or parsed
    SFXBufferPtr buffer   // pointer to the buffer where parsed property value will be stored
);

[ public ]
SFCError RemoveParm(
    SFBvParmSmpConstRef param   // the parameter object that has to be removed
);