SetNewValue
Function
The function SetNewValue allows setting a new value of the given object.
Declaration
APIRET SetNewValue(HOBJ Id, const UniValPtr value)Parameters
The parameter Id defines the identifier of the changed object and value defines a new value and a status of the object. The item time of the parameter value determines a value time. If the value of the parameter time is 0, the value time is to be current time.
Return code
Code | Description. |
|---|---|
API_OK | Value was sent to the D2000 Server. |
API_UnknownId | Object Id is unknown for the interface D2000 ObjApi. The interface D2000 ObjApi includes an internal list of used objects, which is filled at callings the functions NewValueProc, NewDefProc, OpenObject, GetObjectValue and GetObjectId. In this case, the object ID could not be get in the correct way via ObjAPI. |
API_ValTypeError | The type of new object value is not the same as the value type in the system. A value change can cause unexpected problems during the runtime of the D2000 Server. |
Related pages: