NameIdPair Class: Difference between revisions
Jump to navigation
Jump to search
Chris Kahn (talk | contribs) No edit summary |
Chris Kahn (talk | contribs) No edit summary |
||
Line 8: | Line 8: | ||
*Name (as ''string'') {{APIComment|Gets or sets the name.}} | *Name (as ''string'') {{APIComment|Gets or sets the name.}} | ||
*ID (as ''integer'') {{APIComment|Gets or sets the ID number.}} | *ID (as ''integer'') {{APIComment|Gets or sets the ID number.}} | ||
== Usage Example == | |||
{{APIComment|'Declare a new repository connection class.}} | |||
Dim MyRepository As New Repository | |||
{{APIComment|'Connect to the Synthesis repository.}} | |||
Dim Success As Boolean = False | |||
Success = MyRepository.ConnectToRepository("C:\Users\Name\Documents\ReliaSoft\Files\repository.rsr9") | |||
{{APIComment|'Get a list of names/IDs describing the projects in the current repository.}} | |||
Dim ListOfProjects() As NameIdPair | |||
ListOfProjects = MyRepository.GetAllProjects() | |||
{{APIComment|'Get the first project name in the list.}} | |||
Dim ProjectName As String | |||
String = ListOfProjects(0).Name |
Revision as of 21:54, 17 April 2014
Used with the GetAllProjects, GetCurrentProject, GetAllModelsInfo and GetAllXfracasEntities in the Repository class to store the name and ID of an element.
Constructors
- NameIdPair( Integer, String ) Creates a new NameIdPair object to store the name/ID of a project, model or XFRACAS entity. This is automatically called by the applicable methods in the Repository class.
Properties
- Name (as string) Gets or sets the name.
- ID (as integer) Gets or sets the ID number.
Usage Example
'Declare a new repository connection class. Dim MyRepository As New Repository 'Connect to the Synthesis repository. Dim Success As Boolean = False Success = MyRepository.ConnectToRepository("C:\Users\Name\Documents\ReliaSoft\Files\repository.rsr9") 'Get a list of names/IDs describing the projects in the current repository. Dim ListOfProjects() As NameIdPair ListOfProjects = MyRepository.GetAllProjects() 'Get the first project name in the list. Dim ProjectName As String String = ListOfProjects(0).Name