Repository.Xfmea.UpdateItemInSystemHierarchy Method: Difference between revisions

Latest revision as of 18:47, 9 June 2016

Updates the properties of a given system hierarchy item in the current project. Returns a Boolean value; when true, indicates a successful update.

Syntax

.Xfmea.UpdateItemInSystemHierarchy(item)

Parameters

item

Required. The XfmeaItem object that represents the system hierarchy item to be updated.

Example

This example assumes that a system hierarchy item with record ID #1 exists in the first available project in a repository.

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 'Get a list of all items in the system hierarchy in project #1. 
  Dim ListofItems() As XfmeaItem
  MyRepository.Project.SetCurrentProject(1)  
  ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()

 'Change the first item's name to "New_Name." 
  ListofItems(0).Nm = "New_Name"

 'Send the change to the Synthesis repository. 
  Call MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))

VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 'Get a list of all items in the system hierarchy in project #1. 
  Dim ListofItems() As XfmeaItem
  MyRepository.Project.SetCurrentProject(1)  
  ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()

 'Change the first item's name to "New_Name." 
  ListofItems(0).Nm = "New_Name"

 'Send the change to the Synthesis repository. 
  MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))

@@ Line 1: / Line 1: @@
-{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
-<onlyinclude>Updates the properties of an existing system hierarchy item in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>
+<onlyinclude>Updates the properties of a given system hierarchy item in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>
 == Syntax ==
@@ Line 9: / Line 9: @@
 === Parameters ===
 ''item''
-:The [[XfmeaItem Class|XfmeaItem]] object to be updated. (Required)
+:Required. The [[XfmeaItem Class|XfmeaItem]] object that represents the system hierarchy item to be updated.
-<!--
 == Example ==
-This example assumes that a system hierarchy item with record ID#1 exists in the repository.
+This example assumes that a system hierarchy item with record ID #1 exists in the first available project in a repository.
   '''VBA'''
-  {{APIComment|'Add code to connect to a Synthesis repository.}}
+  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
     {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
-  {{APIComment|...}}
+   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
+ {{APIComment|'Get a list of all items in the system hierarchy in project #1.}}
+   {{APIPrefix|Dim}} ListofItems() {{APIPrefix|As}} XfmeaItem
+   MyRepository.Project.SetCurrentProject(1)
+   ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()
+  {{APIComment|'Change the first item's name to "New_Name."}}
-  {{APIComment|'Get the item with record ID #1 from project #1.}}
+   ListofItems(0).Nm = {{APIString|"New_Name"}}
-  {{APIPrefix|Dim}} MyItem {{APIPrefix|As}} XfmeaItem
-  MyRepository.Project.SetCurrentProject(1)
-  {{APIPrefix|Set}} MyItem = MyRepository.Xfmea.GetItemInSystemHierarchy(1)
-  {{APIComment|'Change the item's name to "New_Name."}}
+  {{APIComment|'Send the change to the Synthesis repository.}}
-  MyItem.Nm = {{APIString|"New_Name"}}
+   {{APIPrefix|Call}} MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))
- {{APIComment|'Apply the update to the item. Changes will be reflected in the repository.}}
-  {{APIPrefix|Call}} MyRepository.Xfmea.UpdateItemInSystemHierarchy(MyItem)
   '''VB.NET'''
-  {{APIComment|'Add code to connect to a Synthesis repository.}}
+  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
     {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
-  {{APIComment|...}}
+   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
+  {{APIComment|'Get a list of all items in the system hierarchy in project #1.}}
-  {{APIComment|'Get control #1 from project #1.}}
+   {{APIPrefix|Dim}} ListofItems() {{APIPrefix|As}} XfmeaItem
-  {{APIPrefix|Dim}} MyControl {{APIPrefix|As}} cXfmeaControl
+   MyRepository.Project.SetCurrentProject(1)
-  MyRepository.Project.SetCurrentProject(1)
+   ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()
-  MyControl = MyRepository.Control.GetXfmeaControl(1)
-  {{APIComment|'Change the control's name to "New_Name."}}
+  {{APIComment|'Change the first item's name to "New_Name."}}
-  MyControl.Name = {{APIString|"New_Name"}}
+   ListofItems(0).Nm = {{APIString|"New_Name"}}
-  {{APIComment|'Apply the update to the control. Changes will be reflected in the repository.}}
+  {{APIComment|'Send the change to the Synthesis repository.}}
-  MyRepository.Control.UpdateXfmeaControl(MyControl)
+   MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))
--->

Repository.Xfmea.UpdateItemInSystemHierarchy Method: Difference between revisions

Latest revision as of 18:47, 9 June 2016

Syntax

Parameters

Example

Navigation menu

Search