Tinderbox v11 Icon

unlink(source,destination[,linkType])


Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Data Type Returned: 

Operator First Added: 

Operator in Current Baseline: 

Operator Last Altered: 

Operator Uses Scoped Arguments: 

Operator Has Optional Arguments: 

 Function  [other Function type actions]

 Group  [operators of similar scope]

 Linking  [other Linking operators]

 success boolean

 v10.2.0

 Baseline

 As at baseline

 [More on scoped arguments in Action Code]

 [More on optional operator arguments]


unlink(source,destination[,linkType])

unlink(source,destination[,linkType]) removes all links between an explicit source and destination note. If linkType is omitted, the linkType is assumed to be *untitled. If linkType is *, all links are deleted regardless of their linkType.

No expression left side is needed (the operator returns a true/false success boolean value. This removes a link from note "A note" to "Some note" that uses the "agree" link type.

$MyBoolean = unlink("A note", "Some note","agree"); 

The same but removing all links from "A note" to "Some note" (here with no left-side to the expression:

unlink("A note", "Some note","*"); 

The asterisk is functioning as a wildcard.