Repository.Xfmea.UpdateItemInSystemHierarchy Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>Applies any changes made to an existing Xfmea system hierarchy item. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>   
<onlyinclude>Applies any changes made to an existing system hierarchy item. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>   


== Syntax ==
== Syntax ==
Line 11: Line 11:
:Required. The [[XfmeaItem Class|XfmeaItem]] object to be updated.
:Required. The [[XfmeaItem Class|XfmeaItem]] object to be updated.


<!--
 
== Example ==
== Example ==
This example assumes that a system hierarchy item with record ID #1 exists in the first available project in a repository.
This example assumes that a system hierarchy item with record ID #1 exists in the first available project in a repository.
Line 22: Line 22:
   
   
    
    
  {{APIComment|'Get the item with record ID #1 from project #1.}}
  {{APIComment|'Get a list of all items in the system hierarchy in project #1.}}
   {{APIPrefix|Dim}} MyItem {{APIPrefix|As}} XfmeaItem
   {{APIPrefix|Dim}} ListofItems() {{APIPrefix|As}} XfmeaItem
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Project.SetCurrentProject(1)   
   {{APIPrefix|Set}} MyItem = MyRepository.Xfmea.GetItemInSystemHierarchy(1)
   ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()
   
   
  {{APIComment|'Change the item's name to "New_Name."}}
  {{APIComment|'Change the first item's name to "New_Name."}}
   MyItem.Nm = {{APIString|"New_Name"}}
   ListofItems(0).Nm = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the change to the item. Changes are recorded in the Synthesis repository.}}
  {{APIComment|'Apply the change to the item. Changes are recorded in the Synthesis repository.}}
   {{APIPrefix|Call}} MyRepository.Xfmea.UpdateItemInSystemHierarchy(MyItem)
   {{APIPrefix|Call}} MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))


  '''VB.NET'''
  '''VB.NET'''
Line 40: Line 40:
   
   
    
    
  {{APIComment|'Get control #1 from project #1.}}
  {{APIComment|'Get a list of all items in the system hierarchy in project #1.}}
   {{APIPrefix|Dim}} MyControl {{APIPrefix|As}} cXfmeaControl
   {{APIPrefix|Dim}} ListofItems() {{APIPrefix|As}} XfmeaItem
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Project.SetCurrentProject(1)   
   MyControl = MyRepository.Control.GetXfmeaControl(1)
   ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()
   
   
  {{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 change to the control. Changes are recorded in the Synthesis repository.}}
  {{APIComment|'Apply the change to the item. Changes are recorded in the Synthesis repository.}}
   MyRepository.Control.UpdateXfmeaControl(MyControl)
   MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))
-->

Revision as of 22:47, 11 September 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Applies any changes made to an existing system hierarchy item. Returns a Boolean value; when true, indicates a successful save.

Syntax

.Xfmea.UpdateItemInSystemHierarchy(item)

Parameters

item

Required. The XfmeaItem object 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

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 

 
 '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"

 'Apply the change to the item. Changes are recorded in the Synthesis repository. 
 Call MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))
VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 

 
 '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"

 'Apply the change to the item. Changes are recorded in the Synthesis repository. 
 MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))