Wiki

Differences

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

Link to this comparison view

resources:tools-software:sigmastudiov2:usingsigmastudio:scripting:removeconnection [25 Jun 2020 07:28] – created Krithika Manchaleresources:tools-software:sigmastudiov2:usingsigmastudio:scripting:removeconnection [15 Nov 2021 09:34] (current) Nikhin Shetty
Line 3: Line 3:
 =====Remove Connection===== =====Remove Connection=====
  
-This action allows the user to remove a specified connection between two elements on the parent canvas or schematic page. Return type is a success/failure message in the form of list of strings. It also returns channel and link created. The function call takes in 3 arguments.+This action allows the user to remove a specified connection between two elements on the parent canvas or schematic page. The function call takes in 3 arguments. Return type is a SSPResult which contains a IsSuccess flag for  success/failure and Message in the form of list of strings. 
 \\ \\
 ===API=== ===API===
 <code> <code>
-list<string> RemoveConnection(1: string parentUid, 2: string channelUid, 3: string linkUid)+SSPResult RemoveConnection(string parentUid, string channelUid, string linkUid)
 </code> </code>
 \\ \\
Line 16: Line 16:
 \\ \\
 ===Result=== ===Result===
-“Successfully removed the link: <linkUid>.\\+SSPResult contains 'IsSuccess' flag and 'Message' information of the RemoveConnection action. 
 +  -IsSuccess is 'True' if the remove/delete connection was successful, else 'False'
 +  -Message contains the Success/Failure information in the form of list of string. 
 +\\
 \\ \\
-===Error==== 
-Error message sent out by the server application. 
resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/removeconnection.txt · Last modified: 15 Nov 2021 09:34 by Nikhin Shetty