Difference between revisions of "SHIP:Sail:set"

From Serious Documentation
Jump to: navigation, search
(Created page with "__NOTOC__ {{SailFuncTableStart|}}<onlyinclude> |{{SailFunc|set}}||{{DataType|Node}} srcNode||style="text-align:center;"|v5.1.0||Set a property {{v5}}</onlyinclude> |} == See A...")
 
Line 9: Line 9:
 
*{{SailFunc|getChild}}, {{SailFunc|getChildIndex}}
 
*{{SailFunc|getChild}}, {{SailFunc|getChildIndex}}
 
== Prototype ==
 
== Prototype ==
<code>{{SailFunc|set}} {{DataType|Node}} node_prop, {{DataType|String}} value, {{DataType|String}} peers_value);</code>
+
<code>{{SailFunc|set}} {{DataType|Node}} node_prop, {{DataType|Integer}}/{{DataType|String}}/{{DataType|Boolean}} value, {{DataType|Integer}}/{{DataType|String}}/{{DataType|Boolean}} peers_value);</code>
  
 
== Parameters/Return Value ==
 
== Parameters/Return Value ==
Line 19: Line 19:
 
|node_prop||{{DataType|Node}}||Property to set
 
|node_prop||{{DataType|Node}}||Property to set
 
|-
 
|-
|value||{{DataType|String}}||new property value
+
|value||{{DataType|Integer}}/{{DataType|String}}/{{DataType|Boolean}}||new property value
 
|-
 
|-
|peers_value||{{DataType|String}}||new property value for peers
+
|peers_value||{{DataType|Integer}}/{{DataType|String}}/{{DataType|Boolean}}||new property value for peers
 
|-
 
|-
 
! scope="col" style="text-align:left" | Return
 
! scope="col" style="text-align:left" | Return

Revision as of 13:54, 11 October 2016

Function Returns Introduced Description
set Node srcNode v5.1.0 Set a property Badge SHIPv5.gif

See Also:

Prototype

set Node node_prop, Integer/String/Boolean value, Integer/String/Boolean peers_value);

Parameters/Return Value

Parameter Data Type Description
node_prop Node Property to set
value Integer/String/Boolean new property value
peers_value Integer/String/Boolean new property value for peers
Return no return value

Detailed Description

This function sets the property to the value indicated and sets the property of the nodes peers to the indicated peers_value.

Examples

Example Results Notes
set(pHome.visible, true, false); Set home page to visible and all other pages to non-visible