Repository.XFRACASCommandTimeout(Integer): Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 4: Line 4:
== Syntax ==
== Syntax ==
*XFRACASCommandTimeout({{APIPrefix|As Integer}})
*XFRACASCommandTimeout({{APIPrefix|As Integer}})
= Usage Example =
{{APIComment|Code Block}}
{{APIComment|'Connect to the Synthesis repository.}}
{{APIPrefix|Dim}}Success{{APIPrefix|As Boolean}}= MyRepository.[[Repository.ConnectToRepository|ConnectToRepository]]("RepositoryFileNamePath")
{{APIComment|'Get the list of XFRACAS Entities in the current project in the connected repository.}}
{{APIPrefix|If}}success{{APIPrefix|Then}}
      MyRepository.WriteToDiagnosticsLog("Successfully connected to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Information)
    {{APIPrefix|Try}}
        {{APIPrefix|Dim}}ListOfXFRACASEntities(){{APIPrefix|As}}SynthesisAPI.[[NameIdPair Class|NameIdPair]] = MyRepository.[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]]()
        {{APIPrefix|For}}i{{APIPrefix|As Integer}}= 0{{APIPrefix|To}}ListOfXFRACASEntities.GetUpperBound(0)
              MessageBox.Show(ListOfXFRACASEntities(i).Name)
        {{APIPrefix|Next}}
    {{APIPrefix|Catch}}ex{{APIPrefix|As}}Exception
        {{APIComment|'Set the wait time before terminating the attempt to execute the following XFRACAS command.}}
        XFRACASCommandTimeout(5)
        {{APIComment|'Write error message to diagnostics log}}
          MyRepository.WriteToDiagosticsLog(ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")
    {{APIPrefix|End Try}}
{{APIPrefix|End If}}

Revision as of 23:09, 20 April 2015
SynAPI.png
Main Page
Repository

Version 10 Only- Gets or sets the wait time before terminating the attempt to execute an XFRACAS command.

Syntax

  • XFRACASCommandTimeout(As Integer)


Usage Example

Code Block 


 'Connect to the Synthesis repository. 
DimSuccessAs Boolean= MyRepository.ConnectToRepository("RepositoryFileNamePath")
 'Get the list of XFRACAS Entities in the current project in the connected repository. 
IfsuccessThen
     MyRepository.WriteToDiagnosticsLog("Successfully connected to repository", SynthesisAPI.XFRACASDiagnosticsEntryType.Information) 
    Try
        DimListOfXFRACASEntities()AsSynthesisAPI.NameIdPair = MyRepository.GetAllXFRACASEntities()
        ForiAs Integer= 0ToListOfXFRACASEntities.GetUpperBound(0)
             MessageBox.Show(ListOfXFRACASEntities(i).Name)
        Next
    CatchexAsException
         'Set the wait time before terminating the attempt to execute the following XFRACAS command. 
        XFRACASCommandTimeout(5)
         'Write error message to diagnostics log 
         MyRepository.WriteToDiagosticsLog(ex, SynthesisAPI.XFRACASDiagnosticsEntryType.Error, "Reading Entities")
    End Try
End If
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.XFRACASCommandTimeout(Integer)&oldid=57553"