Repository.Xfmea.GetAllXfmeaFunctionsDictionary Method: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template:API}}{{Template:APIBreadcrumb | {{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}} | ||
<onlyinclude> | <onlyinclude>Returns a dictionary object that contains all available FMEA functions associated with a system hierarchy item. The dictionary syntax is '''Dictionary(Of Integer, XfmeaFunction)''', where the ID numbers are the keys, and the [[XfmeaFunction Class|XfmeaFunction]] objects that represent the FMEA functions are the associated values. (.NET only)</onlyinclude> | ||
== Syntax == | == Syntax == | ||
| Line 9: | Line 9: | ||
===Parameters=== | ===Parameters=== | ||
''HID'' | ''HID'' | ||
:Integer. The | :Required. Integer. The record ID of the system hierarchy item. | ||
''IncludeLinkedAnalyses'' | ''IncludeLinkedAnalyses'' | ||
:Boolean. Indicates whether to include linked FMEAs in the dictionary. | :Required. Boolean. Indicates whether to include linked FMEAs in the dictionary. | ||
== Example == | == Example == | ||
This example assumes that system hierarchy items with FMEAs exists in the first available project of | This example assumes that system hierarchy items with FMEAs exists in the first available project of a repository. | ||
'''VB.NET''' | '''VB.NET''' | ||
{{APIComment|' | {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}} | ||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | ||
{{APIComment|... | MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}}) | ||
{{APIComment|'Set the first project in the repository as the current project.}} | |||
MyRepository.Project.SetCurrentProject(1) | |||
{{APIComment|'Declare a new dictionary object.}} | |||
{{APIPrefix|Dim}} Dict {{APIPrefix|As}} Dictionary (of Integer, XfmeaFunction) | |||
{{APIComment|' | {{APIComment|'Add values to the dictionary.}} | ||
Dict = MyRepository.Xfmea.GetAllXfmeaFunctionsDictionary(1, {{APIPrefix|True)}} | |||
{{APIComment|'Output sample: Display the number of | {{APIComment|'Output sample: Display the number of entries in the dictionary.}} | ||
MsgBox(Dict.Count) | |||
Latest revision as of 15:09, 3 August 2017
 |
Member of: SynthesisAPI.Repository
Returns a dictionary object that contains all available FMEA functions associated with a system hierarchy item. The dictionary syntax is Dictionary(Of Integer, XfmeaFunction), where the ID numbers are the keys, and the XfmeaFunction objects that represent the FMEA functions are the associated values. (.NET only)
Syntax
.Xfmea.GetAllXfmeaFunctionsDictionary(HID,IncludeLinkedAnalyses)
Parameters
HID
- Required. Integer. The record ID of the system hierarchy item.
IncludeLinkedAnalyses
- Required. Boolean. Indicates whether to include linked FMEAs in the dictionary.
Example
This example assumes that system hierarchy items with FMEAs exists in the first available project of a repository.
VB.NET 'Declare a new Repository object and connect to a Synthesis repository. Dim MyRepository As New Repository MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10") 'Set the first project in the repository as the current project. MyRepository.Project.SetCurrentProject(1) 'Declare a new dictionary object. Dim Dict As Dictionary (of Integer, XfmeaFunction) 'Add values to the dictionary. Dict = MyRepository.Xfmea.GetAllXfmeaFunctionsDictionary(1, True) 'Output sample: Display the number of entries in the dictionary. MsgBox(Dict.Count)