CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode Parameter_DeclareParameterChanged ( CPHOBJECT const  hParameter,
CPUINT16 const  wIndex,
CPUINT16 const  wRawValue 
)

This can be used to declare a parameter value change without sending immediately the feedback. Then the CHAI can call the IInput_ParameterNotificationHandler::OnParameter_RequestCurrentValue when it deems it necessary. This is a convenient way to limit the bandwidth used by parameter's current value feedback.

Remarks
The change declaration is supported only if the new value is different than the actual current value.
Parameters
[in]hParameterParameter handle.
[in]wIndexthe related parameter index, or 0 if the parameter is not indexed.
[in]wRawValuethe new value if the parameter is related to a Modifier or a Selector. This argument is not used in case of Text parameter.
Returns
Standard CHAILink Client return code. See CLC_ErrorCode enumeration.
Warning
This function can only be called in CopperLan context. This means in the pseudo task CPDoProcess(), in notification handlers or in asynchronous return handlers and not in SystemDoProcess() for instance.