Differences

This shows you the differences between two versions of the page.

Link to this comparison view

receive_string [2020/04/28 12:55]
argemiro created 		receive_string [2026/08/28 03:30] (current)
hermann Sync from local documentation review
Line 1: Line 1:
-====== Receive String ====== ​+====== Receive String ======
  
 ===== Description ===== ===== Description =====
  
-Receive ​a string ​using an opened communication session.+Receives ​a string ​sent by an external application,​ such as an R script, through ​an opened communication session.
  
 ===== Inputs ===== ===== Inputs =====
 +
 None. None.
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
-^ Name ^ Type ^ Description ^ + 
-| Tag| [[string_type|String]] | String identifier.  |+^ Name  ^ Type  ^ Description ​ ^ Default Value  ​^ 
 +| Tag  | [[String ​Type]]  | Identifier used to match this string with the corresponding send call in the external application.  | Empty  |
  
 ===== Outputs ===== ===== Outputs =====
-^ Name ^ Type ^ Description ^ + 
-| String| [[string_type|String]] | Received string. ​ |+^ Name  ^ Type  ^ Description ​ ^ 
 +| String ​ | [[String ​Type]]  | Received string. ​ |
  
 ===== Group ===== ===== Group =====
Line 20: Line 23:
 [[Functor List#​Integration | Integration]] [[Functor List#​Integration | Integration]]
  
-===== Internal Name ===== +===== Notes ===== 
 + 
 +This functor blocks until the string is received. 
 + 
 +Raises an error if no communication session is open. 
 + 
 +See [[External Communication]] for how to open a session from an external application and exchange data with it. 
 + 
 +===== Internal Name =====
  
 ReceiveString ReceiveString
 +