Differences

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

--- resources:tools-software:sigmastudiov2:usingsigmastudio:scripting:addshape [24 Jun 2020 12:23] – Krithika Manchale
+++ resources:tools-software:sigmastudiov2:usingsigmastudio:scripting:addshape [15 Nov 2021 12:28] (current) – Nikhin Shetty
@@ Line 3: / Line 3: @@
 =====Add Shape=====
-This action allows the user to add a given element or plugin onto the canvas or schematic page specified. Return type is a success/failure message in the form of list of strings. The function call takes in 3 arguments.
+This action allows the user to add a shape or plugin onto the canvas or schematic page specified.The function call takes in 3 arguments. This API returns the SSPResult type.
+\\
 \\
 ===API===
 <code>
-list<string> AddShape(1: string parentUid, 2: string shapeFullName, 3: Position newPosition)
+SSPResult AddShape(string parentUid, string shapeFullName, Position newPosition)
 </code>
 \\
@@ Line 17: / Line 17: @@
 \\
 ===Result===
-“Successfully added the element: <pluginUid>”.\\
+SSPResult contains 'IsSuccess' flag and 'Message' information of the AddShape action.
-Also, when adding a plugin which has predefined sub elements, the Uids of those are also displayed.
+  -IsSuccess is 'True' if the add shape was successful, else 'False'.
+  -Message contains the Success/Failure information in the form of list of string.
-\\
-\\
-===Error====
-.	The given information is incomplete – when the arguments are not conveying the required information
 \\
-.	Failed to add element
 \\
-.	Default: Displays the error msg as obtained by the Server application.

Wiki

Analog Devices Wiki

Differences

Analog Devices Wiki

Differences

Page Tools