|
|
Set a Property's value.
The specified timeout is a maximum duration for the operation, and the operation fails if the timeout is reached before an acknowledgement is received. Otherwise, the first acknowledgement received is returned. Broadcast operations will be cancelled immediately after the first acknowledgement, and therefore may not reach or be processed by all available providers.
- Note
- Beware that a timeout of DOF_TIMEOUT_NEVER may NEVER return if an acknowledgement is not received!
- Resource Management:
- This function allocates resources that must later be freed by calling DOFResult_Destroy.
- Parameters
-
| obj | The object on which to set the Property's value. This should not be NULL. |
| property | The Property to set. This should not be NULL. |
| value | The new value for the Property. The data type must match the property's data type. NULL is permitted for a nullable type. |
| config | Configuration options for the request operation (NULL for default configuration). |
| timeout | The time we wait for results, in milliseconds. The timeout begins after the operation has been processed and sent to appropriate connections. |
| [out] | pException | An Exception. If pException is NULL, no exception is reported. Otherwise, the output is either a DOFException, or NULL to indicate no exception occurred. DOFException_Destroy must be called to destroy the returned DOFException, if any. |
- Returns
- The result of the Set operation, indicating success.
- Exceptions
-
| NULL | is returned and pException is filled (if not null) with an appropriate exception in the following conditions:
- The provider returned an exception
- An invalid parameter was detected (including an incompatible value passed for the property)
- Insufficient resources available to perform the operation
|
|
