Wiki

This version (15 Nov 2021 12:26) was approved by Nikhin Shetty.The Previously approved version (25 Jun 2020 07:28) is available.Diff

Click here to return back

Remove Connection

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

SSPResult RemoveConnection(string parentUid, string channelUid, string linkUid)


Arguments

  1. parentUid - The Uid of the parent canvas/Schematic onto which the plugin must be added
  2. channelUid- Uid of the channel which the link belongs to.
  3. linkUid -Uid of the link that is to be removed


Result

SSPResult contains 'IsSuccess' flag and 'Message' information of the RemoveConnection action.

  1. IsSuccess is 'True' if the remove/delete connection was successful, else 'False'.
  2. Message contains the Success/Failure information in the form of list of string.



resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/removeconnection.txt · Last modified: 15 Nov 2021 09:34 by Nikhin Shetty