Discussion:
[PATCH] doc: Fix ClearProperty documentation
(too old to reply)
Patrik Flykt
2015-10-20 10:46:05 UTC
Permalink
ClearProperty applies only on the Error property and causes the
service to go to idle state.
---
doc/service-api.txt | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/doc/service-api.txt b/doc/service-api.txt
index 88816d8..dca97cd 100644
--- a/doc/service-api.txt
+++ b/doc/service-api.txt
@@ -30,10 +30,9 @@ Methods dict GetProperties() [deprecated]

void ClearProperty(string name)

- Clears the value of the specified property.
-
- Properties cannot be cleared for hidden WiFi service
- entries or provisioned services.
+ Clears the value of the specified property. Only
+ the readonly Error property can be cleared. When
+ cleared the service is reset to the idle state.

Possible Errors: [service].Error.InvalidArguments
[service].Error.InvalidProperty
--
2.1.4
Patrik Flykt
2015-10-21 08:19:15 UTC
Permalink
ClearProperty applies only on the Error property and causes the
service to go to idle state.
---

Updated the text and noted that InvalidProperty is the only error that
can be returned.

doc/service-api.txt | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/doc/service-api.txt b/doc/service-api.txt
index 88816d8..e2e9e84 100644
--- a/doc/service-api.txt
+++ b/doc/service-api.txt
@@ -30,13 +30,12 @@ Methods dict GetProperties() [deprecated]

void ClearProperty(string name)

- Clears the value of the specified property.
+ Clears the value of the specified property. Only
+ the readonly Error property can be cleared using
+ this method call. When cleared the service is reset
+ to the idle state.

- Properties cannot be cleared for hidden WiFi service
- entries or provisioned services.
-
- Possible Errors: [service].Error.InvalidArguments
- [service].Error.InvalidProperty
+ Possible Errors: [service].Error.InvalidProperty

void Connect()
--
2.1.4
Patrik Flykt
2015-10-21 10:04:30 UTC
Permalink
Post by Patrik Flykt
ClearProperty applies only on the Error property and causes the
service to go to idle state.
---
Updated the text and noted that InvalidProperty is the only error that
can be returned.
Applied. Now the implementation is wrong and needs to be fixed according
to the corrected documentation.

Patrik

Loading...