SEARCH   
Home About Us Products Manufacturing Services Support ARK online Contact Us
Support > Software Downloads >
ARK® Tutorial



Introduction  |  Core Component  |  Communications  |  Additional Topics  |  Reference Guide




 
   

Reference Guide

interface IParameter2

Parameter objects store parameters for both controller components and product components.

Definition
interface IParameter : IDispatch
{
[propget]
HRESULT Name([out, retval] BSTR* rval);
[propget]
HRESULT Type([out, retval] ParameterType* rval);
[id(0), propget]
HRESULT Value([out, retval] long* rval);
[id(0), propput]
HRESULT Value([in] long value);
[propget]
HRESULT Min([out, retval] long* rval);
[propget]
HRESULT Max([out, retval] long* rval);
[propget]
HRESULT List([out, retval] IValueList** rval);
[propget]
HRESULT Units([out, retval] BSTR* rval);
};
interface IParameter2: IParameter
{
[propget]
HRESULT DefaultValue([out, retval] long* rval);
[propget]
HRESULT Channel([out, retval] long* rval);
[propget]
HRESULT Group([out, retval] long* rval);
[propget]
HRESULT Subgroup([out, retval] long* rval);
[propget]
HRESULT TextList([out, retval] ITextList** rval);
HRESULT Copy([out, retval] IParameter2** rval); };
Descriptions

[propget]
HRESULT Name([out, retval] BSTR* rval);
The name of the parameter.

[propget]
HRESULT Type([out, retval] ParameterType* rval);
The type of the parameter.

[id(0), propget]
HRESULT Value([out, retval] long* rval);

[id(0), propput]
HRESULT Value([in] long value);
The value of the parameter.

[propget]
HRESULT Min([out, retval] long* rval);
The minimum value of the parameter.

[propget]
HRESULT Max([out, retval] long* rval);
The maximum value of the parameter.

[propget]
HRESULT List([out, retval] IValueList** rval);
The list of possible values for the parameter, if the parameter is of type fList.

[propget]
HRESULT Units([out, retval] BSTR* rval);
The units that the list values are in.

[propget]
HRESULT DefaultValue([out, retval] long* rval);
The default value of the parameter.

[propget]
HRESULT Channel([out, retval] long* rval);
The channel that the parameter is associated. This property is used by the Interactive Data Sheet to assist with laying out controls.

[propget]
HRESULT Group([out, retval] long* rval);
The group that the parameter belongs to. This property is used by the Interactive Data Sheet to assist with laying out controls.

[propget]
HRESULT Subgroup([out, retval] long* rval);
The subgroup that the parameter belongs to. This property is used by the Interactive Data Sheet to assist with laying out controls.

[propget]
HRESULT TextList([out, retval] ITextList** rval);
The list of possible text values for the parameter, if the type of the parameter is fTextList or fDiscrete.

HRESULT Copy([out, retval] IParameter2** rval);
Makes a copy of the parameter object.




© ON Semiconductor  |   PRIVACY POLICY  |   TERMS OF USE