ThingWorx Edge C SDK > Interacting with ThingWorx > SDK Application-Initiated Interaction > Write a Property
  
Write a Property
This helper function writes a new value for a property of a specific entity on ThingWorx platform.
enum msgCodeEnum twApi_WriteProperty(enum entityTypeEnum entityType, char * entityName, char * propertyName, twPrimitive * value, int32_t timeout, char forceConnect)
The following table lists and describes the parameters for this helper function:
Parameter
Type
Description
entityType
Input
The type of entity that the property belongs to. Enumeration values can be found in twDefinitions.h.
entityName
Input
The name of the entity that the property belongs to.
propertyName
Input
The name of the property to retrieve.
value
Input
A pointer to a twPrimitive that contains the value to set for the property. Once called, the calling function will retain ownership of this pointer and must manage the memory lifecycle. NOTE: The called function WILL alter the contents of this primitive, so the original contents cannot be relied upon after the function returns..
timeout
Input
The time (in milliseconds) to wait for a response from the server. A value of -1 uses the DEFAULT_MESSAGE_TIMEOUT as defined in twDefaultSettings.h.
forceConnect
Input
A Boolean value. If TRUE and the API is in the disconnected state of the duty cycle, the API will force a reconnect to send the request.
Return:
msgCodeEnum — the result of the call. See twDefinitions.h for the enumeration definition.