Wiki

Analog Devices Wiki

English
English
简体中文
简体中文
日本語
日本語
Руccкий
Руccкий

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
resources:tools-software:sigmastudiov2:usingsigmastudio:scripting:removeshape [25 Jun 2020 07:23] – Krithika Manchaleresources:tools-software:sigmastudiov2:usingsigmastudio:scripting:removeshape [15 Nov 2021 09:09] (current) – Nikhin Shetty
Line 3: Line 3:
 =====Remove Shape===== =====Remove Shape=====
  
-This action allows the user to remove/delete a given element or plugin from the parent canvas or schematic page specified. Return type is a success/failure message in the form of list of strings. The function call takes in 2 arguments.+This action allows the user to remove/delete a given element or plugin from the parent canvas or schematic page specified. The function call takes in 2 arguments. This API returns the SSPResult type.
  
 \\ \\
 ===API=== ===API===
 <code> <code>
-list<string> RemoveShape(1: string parentUid, 2: string shapeUid)+SSPResult RemoveShape(string parentUid, string shapeUid)
 </code> </code>
 \\ \\
 ===Arguments==== ===Arguments====
-  - parentUid - The Uid of the parent canvas/Schematic onto which the plugin must be added+  - parentUid - The Uid of the parent canvas/Schematic from which the plugin must be removed
   - shapeUid- Uid of the plugin to be removed.   - shapeUid- Uid of the plugin to be removed.
 \\ \\
 ===Result=== ===Result===
-“Successfully removed the element: <shapeUid>”.\\+SSPResult contains 'IsSuccess' flag and 'Message' information of the RemoveShape action. 
 +  -IsSuccess is 'True' if the shape was removed successfully, else 'False'. 
 +  -Message contains the Success/Failure information in the form of list of string.
 \\ \\
-===Error==== 
-1. The given information is incomplete/shape not found – when the arguments are not conveying the required information  
 \\ \\
-2. Failed to remove element 
-\\ 
-3. Default: Displays the error msg as obtained by the Server application. 
  
  
  
resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/removeshape.txt · Last modified: 15 Nov 2021 09:09 by Nikhin Shetty

Page Tools