Objects Reference

bsp_object::get_custom_param_desc

Prototype

virtual int get_custom_param_desc(int i,param_desc *pd)

Parameters

Parameter Type Description
i int parameter index
pd param_desc * parameter desc to be filled

Return Value

If pd=0, the number of custom parameters.

Remarks

This virtual function must be implemented by all sub-classes. It returns the number of parameters the object has and each parameter description.

When called with pd=0, it must return the number of parameters. When pd<>0, it fill the description variable pd with information on the parameter index i.