Difference between revisions of "Function.Communication.REST.ReadProperty"

From GAB Help
Jump to: navigation, search
(Added category)
 
Line 1: Line 1:
==Syntax==
+
==ReadProperty(Name, Value)==
Function.Communication.REST.ReadProperty(PropertyName [string], Return [String])
+
Gets a property value. The available properties can be found http://cdn.nsoftware.com/help/IPF/cs/REST.htm
  
==Arguments==
+
===Arguments===
===PropertyName===
+
====Name as String====
string
+
The property name
===Return===
+
====Value as Any====
String
+
The property value [as object]
  
==Examples==
+
===Examples===
 
+
<code>Function.Communication.REST.ReadProperty("Name",V.Local.Property)</code>
 
 
==Property==
 
Available properties:
 
 
 
1. Accept A list of acceptable MIME types for the request.  
 
 
 
2. Authorization The Authorization string to be sent to the server.
 
 
 
3. AuthScheme The authentication scheme to use when server authorization is required.
 
 
 
4. BuildDOM When True, an internal object model of the XML document is created.
 
 
 
5. Connected Shows whether the component is connected.
 
 
 
6. ContentType Content type for posts and puts.
 
 
 
7. Cookies Collection of cookies.
 
 
 
8. Firewall A set of properties related to firewall access: FIREWALLAUTODETECT, FIREWALLHOST, FIREWALLPASSWORD, FIREWALLPORT, FIREWALLTYPE, FIREWALLUSER.
 
 
 
9. FollowRedirects Determines what happens when the server issues a redirect.
 
 
 
10. From The email address of the HTTP agent (optional).
 
 
 
11. HTTPMethod The HTTP method used for the request.
 
 
 
12. Idle The current status of the component.
 
 
 
13. IfModifiedSince A date determining the maximum age of the desired document.
 
 
 
14. LocalFile The path to a local file for downloading. If the file exists, it is overwritten.
 
 
 
15. LocalHost The name of the local host or user-assigned IP interface through which connections are initiated or accepted.  
 
 
 
16. Namespaces A collection of namespaces in the current stack.
 
 
 
17. OtherHeaders Other headers as determined by the user (optional).
 
 
 
18. ParsedHeaders Collection of headers returned from the last request.
 
 
 
19. Password A password if authentication is to be used.
 
 
 
20. PostData The data to post with the URL if the POST method is used.
 
 
 
21. PostDataB
 
 
 
22. Proxy A set of properties related to proxy access: PROXYAUTHSCHEME, PROXYAUTODETECT, PROXYPASSWORD, PROXYPORT, PROXYSERVER, PROXYUSER.
 
 
 
23. Referer Referer URL/document (optional).
 
 
 
24. StatusLine The first line of the last server response.
 
 
 
25. Timeout A timeout for the component.
 
 
 
26. TransferredData The contents of the last response from the server.
 
 
 
27. TransferredDataB
 
 
 
28. TransferredDataLimit The maximum of bytes of data to be transferred.
 
 
 
29. TransferredHeaders The full set of headers as received from the server.
 
 
 
30. URL The URL to which information is posted.
 
 
 
31. User A user name if authentication is to be used.
 
 
 
32. Validate When True, the parser checks that the document consists of well-formed XML.
 
 
 
33. XAttributes A collection of attributes of the current element.
 
 
 
34. XChildren Collection of child elements of the current element.
 
 
 
35. XElement The name of the current element.
 
 
 
36. XErrorPath An XPath to check the server response for errors.
 
 
 
37. XNamespace The namespace of the current element.
 
 
 
38. XParent The parent of the current element.
 
 
 
39. XPath Provides a way to point to a specific element in the response.
 
 
 
40. XPrefix The prefix of the current element.
 
 
 
41. XSubTree A snapshot of the current element in the document.
 
 
 
42. XText The text of the current element.
 
 
 
 
 
==Remarks==
 
  
  
 
[[Category:Functions]]
 
[[Category:Functions]]
 +
[[Category:Function.Communication]]
 
[[Category:Function.Communication.REST]]
 
[[Category:Function.Communication.REST]]
[[Category:NeedsExample]]
+
 
[[Category:NeedsEdit]]
+
__FORCETOC__
[[Category:Function.Communication]]
 

Latest revision as of 10:24, 21 May 2020

ReadProperty(Name, Value)

Gets a property value. The available properties can be found http://cdn.nsoftware.com/help/IPF/cs/REST.htm

Arguments

Name as String

The property name

Value as Any

The property value [as object]

Examples

Function.Communication.REST.ReadProperty("Name",V.Local.Property)