Repository.Control.GetXfmeaControl: Difference between revisions
Jump to navigation
Jump to search
Alex Ulanov (talk | contribs) (Created page with '{{Template:APIClass|Repository Class|Repository}} Returns XfmeaControl with the provided ID. Returns nothing if the XfmeaControl doesn't exist. ==Syntax== * GetXfmeaControl(ByVa…') |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{Template: | {{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}} | ||
<noinclude>Gets the Xfmea control with the designated ID number and returns it as a '''[[CXfmeaControl Class|cXfmeaControl]]''' object. Returns nothing if the control does not exist or is not in the current project.</noinclude> | |||
ID: ID of the | == Syntax == | ||
'''Control.GetXfmeaControl'''(''ID'') | |||
=== Parameters === | |||
''ID'' | |||
:Integer. The ID number of the control to retrieve. | |||
== Example == | |||
This example assumes that an Xfmea control with ID#1 exists in a repository. | |||
'''VBA''' | |||
{{APIComment|'Add code to connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...}} | |||
{{APIComment|'Get control #1 from project #1.}} | |||
{{APIPrefix|Dim}} MyControl {{APIPrefix|As}} cXfmeaControl | |||
MyRepository.Project.SetCurrentProject(1) | |||
{{APIPrefix|Set}} MyControl = MyRepository.Control.GetXfmeaControl(1) | |||
{{APIComment|'Output sample: Display the name and ID of the control.}} | |||
{{APIPrefix|Dim}} ControlName {{APIPrefix|As}} String | |||
{{APIPrefix|Dim}} ControlID {{APIPrefix|As}} Integer | |||
ControlName = MyControl.Name | |||
ControlID = MyControl.ID | |||
MsgBox ({{APIString|"ID# "}} & ControlID & {{APIString|", "}} & ControlName) | |||
'''VB.NET''' | |||
{{APIComment|'Add code to connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...}} | |||
{{APIComment|'Get control #1 from project #1.}} | |||
{{APIPrefix|Dim}} MyControl {{APIPrefix|As}} cXfmeaControl | |||
MyRepository.Project.SetCurrentProject(1) | |||
MyControl = MyRepository.Control.GetXfmeaControl(1) | |||
{{APIComment|'Output sample: Display the name and ID of the control.}} | |||
{{APIPrefix|Dim}} ControlName {{APIPrefix|As}} String | |||
{{APIPrefix|Dim}} ControlID {{APIPrefix|As}} Integer | |||
ControlName = MyControl.Name | |||
ControlID = MyControl.ID | |||
MsgBox ({{APIString|"ID# "}} & ControlID & {{APIString|", "}} & ControlName) | |||
Revision as of 18:52, 21 July 2015
 |
Member of: SynthesisAPI10.Repository
Gets the Xfmea control with the designated ID number and returns it as a cXfmeaControl object. Returns nothing if the control does not exist or is not in the current project.
Syntax
Control.GetXfmeaControl(ID)
Parameters
ID
- Integer. The ID number of the control to retrieve.
Example
This example assumes that an Xfmea control with ID#1 exists in a repository.
VBA 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... 'Get control #1 from project #1. Dim MyControl As cXfmeaControl MyRepository.Project.SetCurrentProject(1) Set MyControl = MyRepository.Control.GetXfmeaControl(1) 'Output sample: Display the name and ID of the control. Dim ControlName As String Dim ControlID As Integer ControlName = MyControl.Name ControlID = MyControl.ID MsgBox ("ID# " & ControlID & ", " & ControlName)
VB.NET 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... 'Get control #1 from project #1. Dim MyControl As cXfmeaControl MyRepository.Project.SetCurrentProject(1) MyControl = MyRepository.Control.GetXfmeaControl(1) 'Output sample: Display the name and ID of the control. Dim ControlName As String Dim ControlID As Integer ControlName = MyControl.Name ControlID = MyControl.ID MsgBox ("ID# " & ControlID & ", " & ControlName)