Repository.XFRACAS.WriteExceptionToDiagnosticsLog - Revision history

Kate Racaza at 16:45, 10 March 2016

2016-03-10T16:45:23Z

← Older revision		Revision as of 16:45, 10 March 2016
Line 21:		Line 21:

	== Example ==		== Example ==
	The following example demonstrates how to write messages and exceptions to the XFRACAS diagnostics log. ~~It assumes that the enterprise repository has existing connections to XFRACAS entities.~~		The following example demonstrates how to write messages and exceptions to the XFRACAS diagnostics log.

	'''VB.NET'''		'''VB.NET'''

Kate Racaza at 22:32, 13 November 2015

2015-11-13T22:32:19Z

← Older revision		Revision as of 22:32, 13 November 2015
Line 1:		Line 1:
	~~{{InProgress}}~~{{DISPLAYTITLE:Repository.XFRACAS.WriteExceptionToDiagnosticsLog Method}}{{Template:API}}{{Template:APIBreadcrumb\|9\|.[[Repository Class\|Repository]]}}		{{DISPLAYTITLE:Repository.XFRACAS.WriteExceptionToDiagnosticsLog Method}}{{Template:API}}{{Template:APIBreadcrumb\|.[[Repository Class\|Repository]]}}

Kate Racaza: /* Example */

2015-11-10T15:09:54Z

Example

← Older revision		Revision as of 15:09, 10 November 2015
Line 46:		Line 46:
	{{APIPrefix\|Catch}} Ex {{APIPrefix\|As}} Exception		{{APIPrefix\|Catch}} Ex {{APIPrefix\|As}} Exception
	{{APIComment\|'Write error message to diagnostics log.}}		{{APIComment\|'Write error message to diagnostics log.}}
	MyRepository.XFRACAS.~~WriteExceptionToDiagosticsLog~~(Ex, XFRACASDiagnosticsEntryType.Error, {{APIString\|"Reading Entities"}})		MyRepository.XFRACAS.WriteExceptionToDiagnosticsLog(Ex, XFRACASDiagnosticsEntryType.Error, {{APIString\|"Reading Entities"}})

	{{APIPrefix\|End Try}}		{{APIPrefix\|End Try}}
	{{APIPrefix\|End If}}		{{APIPrefix\|End If}}

Kate Racaza at 15:21, 5 November 2015

2015-11-05T15:21:44Z

← Older revision		Revision as of 15:21, 5 November 2015
Line 21:		Line 21:

	== Example ==		== Example ==
	The following example demonstrates how to write messages and exceptions to the XFRACAS diagnostics log. It assumes that the repository has existing connections to XFRACAS entities.		The following example demonstrates how to write messages and exceptions to the XFRACAS diagnostics log. It assumes that the enterprise repository has existing connections to XFRACAS entities.

	'''VB.NET'''		'''VB.NET'''

	{{APIComment\|'Connect to the Synthesis repository~~. The following code}}~~		{{APIComment\|'Connect to the Synthesis enterprise repository.}}
	~~{{APIComment\|'assumes that a file called "RSRepository1.rsr10" exists in the C: drive~~.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{APIPrefix\|Dim}} Success {{APIPrefix\|As}} Boolean		{{APIPrefix\|Dim}} Success {{APIPrefix\|As}} Boolean
	Success = MyRepository.~~ConnectToRepository~~ ({{APIString\|"~~C:\RSRepository1.rsr10~~"}})		Success = MyRepository.ConnectToSQLRepository ({{APIString\|"MyServer"}}, {{APIString\|"MyDatabase"}})

	{{APIComment\|'Record a message to diagnostic log if the connection to the repository is successful.}}		{{APIComment\|'Record a message to diagnostic log if the connection to the repository is successful.}}
Line 47:		Line 46:
	{{APIPrefix\|Catch}} Ex {{APIPrefix\|As}} Exception		{{APIPrefix\|Catch}} Ex {{APIPrefix\|As}} Exception
	{{APIComment\|'Write error message to diagnostics log.}}		{{APIComment\|'Write error message to diagnostics log.}}
	MyRepository.XFRACAS.WriteExceptionToDiagosticsLog(Ex, XFRACASDiagnosticsEntryType.Error, {{~~APIPrefix~~\|"Reading Entities"}})		MyRepository.XFRACAS.WriteExceptionToDiagosticsLog(Ex, XFRACASDiagnosticsEntryType.Error, {{APIString\|"Reading Entities"}})

	{{APIPrefix\|End Try}}		{{APIPrefix\|End Try}}
	{{APIPrefix\|End If}}		{{APIPrefix\|End If}}

Kate Racaza at 22:21, 28 October 2015

2015-10-28T22:21:51Z

← Older revision		Revision as of 22:21, 28 October 2015
Line 2:		Line 2:


	<onlyinclude>Writes exception information to the XFRACAS diagnostics log. ~~(VB.NET only)~~</onlyinclude>		<onlyinclude>Writes exception information to the XFRACAS diagnostics log. </onlyinclude>

	== Syntax ==		== Syntax ==

Kate Racaza at 21:58, 28 October 2015

2015-10-28T21:58:03Z

← Older revision		Revision as of 21:58, 28 October 2015
Line 2:		Line 2:


	<onlyinclude>Writes exception information to the XFRACAS diagnostics log.</onlyinclude>		<onlyinclude>Writes exception information to the XFRACAS diagnostics log. (VB.NET only)</onlyinclude>

	== Syntax ==		== Syntax ==

Kate Racaza at 21:09, 28 October 2015

2015-10-28T21:09:06Z

← Older revision		Revision as of 21:09, 28 October 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:Repository.XFRACAS.WriteExceptionToDiagnosticsLog Method}}{{Template:API}}{{Template:APIBreadcrumb\|9\|.[[Repository Class\|Repository]]}}		{{InProgress}}{{DISPLAYTITLE:Repository.XFRACAS.WriteExceptionToDiagnosticsLog Method}}{{Template:API}}{{Template:APIBreadcrumb\|9\|.[[Repository Class\|Repository]]}}


Line 21:		Line 21:

	== Example ==		== Example ==
	The following example demonstrates		The following example demonstrates how to write messages and exceptions to the XFRACAS diagnostics log. It assumes that the repository has existing connections to XFRACAS entities.

	'''VB.NET'''		'''VB.NET'''

Kate Racaza at 21:05, 28 October 2015

2015-10-28T21:05:06Z

← Older revision		Revision as of 21:05, 28 October 2015
Line 1:		Line 1:
	{{Template:~~APIClass~~\|Repository Class\|Repository}}		{{DISPLAYTITLE:Repository.XFRACAS.WriteExceptionToDiagnosticsLog Method}}{{Template:API}}{{Template:APIBreadcrumb\|9\|.[[Repository Class\|Repository]]}}
	~~{{Template:Repository.WriteToDiagnosticsLog (System.Exception,mXFRACASDiagnosticEntryType, String)~~.~~Cmt}}~~

			<onlyinclude>Writes exception information to the XFRACAS diagnostics log.</onlyinclude>

	== Syntax ==		== Syntax ==
	*WriteToDiagnosticsLog(exObject ~~{{APIPrefix\|As}} System~~.Exception ~~, entrytype {{APIPrefix\|As}}~~ [[~~Repository.XFRACASDiagnosticEntryType~~\|~~XFRACASDiagnosticEntryType~~]]~~, {{APIPrefix\|~~ Optional~~}} comment{{APIPrefix\|As~~ String~~}})~~		'''.WriteExceptionToDiagnosticsLog''' (''exObject'', ''entryType'', ''comment'')

			===Parameters===
			''exObject''

			:Required. Exception. Represents the error that occurred during application execution.

			''entryType''

			:Required. The XFRACAS diagnostics type. Can be any [[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]] enumeration.

			''comment''
			:Optional. String. The text to write to the XFRACAS diagnostics log.


	~~Parameters~~		== Example ==
	~~:''exObject'': Represents an error that occurs during application execution~~		The following example demonstrates
	~~:''entryType'':~~ The ~~type of diagnostics entry type, specified as [[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]]~~
	~~:''comment'': ''Optional'' comment to write to the diagnostics log~~

	~~= Usage Example =~~		'''VB.NET'''
	{{APIComment\|'Connect to the Synthesis repository.}}
	{{APIPrefix\|Dim}}Success{{APIPrefix\|As ~~Boolean~~}}= MyRepository~~.[[Repository~~.ConnectToRepository\|~~ConnectToRepository]](~~"~~RepositoryFileNamePath~~")		{{APIComment\|'Connect to the Synthesis repository. The following code}}
	{{APIComment\|'~~Get~~ the ~~list of XFRACAS Entities in~~ the ~~current project in the connected~~ repository.}}		{{APIComment\|'assumes that a file called "RSRepository1.rsr10" exists in the C: drive.}}
	{{APIPrefix\|If}}~~success~~{{APIPrefix\|Then}}		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	MyRepository.XFRACAS.WriteMessageToDiagnosticsLog("Successfully connected to repository", ~~SynthesisAPI.[[~~XFRACASDiagnosticsEntryType ~~Enumeration\|XFRACASDiagnosticsEntryType]]~~.Information)		{{APIPrefix\|Dim}} Success {{APIPrefix\|As}} Boolean
	{{APIPrefix\|Try}}		Success = MyRepository.ConnectToRepository ({{APIString\|"C:\RSRepository1.rsr10"}})
	{{APIPrefix\|Dim}}ListOfXFRACASEntities(){{APIPrefix\|As}}~~SynthesisAPI.[[~~NameIdPair ~~Class\|NameIdPair]]~~ = MyRepository.XFRACAS~~.[[Repository~~.GetAllXFRACASEntities~~\|GetAllXFRACASEntities]]()~~
	{{APIPrefix\|~~For~~}}i{{APIPrefix\|As Integer}}= 0{{APIPrefix\|To}}ListOfXFRACASEntities.GetUpperBound(0)		{{APIComment\|'Record a message to diagnostic log if the connection to the repository is successful.}}
	MessageBox.Show(ListOfXFRACASEntities(i).Name)		{{APIPrefix\|If}} Success {{APIPrefix\|Then}}
	{{APIPrefix\|Next}}		MyRepository.XFRACAS.WriteMessageToDiagnosticsLog({{APIString\|"Successfully connected to repository"}}, XFRACASDiagnosticsEntryType.Information)
	{{APIPrefix\|Catch}}ex{{APIPrefix\|As}}Exception
	{{APIComment\|'Write error message to diagnostics log}}		{{APIComment\|'Get a list of all XFRACAS entities connected to the repository.}}
	MyRepository.XFRACAS.WriteExceptionToDiagosticsLog(ex, ~~SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|~~XFRACASDiagnosticsEntryType]].Error, "Reading Entities")		{{APIPrefix\|Try}}
	{{APIPrefix\|End Try}}		{{APIPrefix\|Dim}} ListOfXFRACASEntities() {{APIPrefix\|As}} NameIdPair
			ListofXFRACASEntities = MyRepository.XFRACAS.GetAllXFRACASEntities

			{{APIPrefix\|Dim}} i {{APIPrefix\|As}} Integer
			{{APIPrefix\|For}} i = 0 {{APIPrefix\|To}} ListOfXFRACASEntities.GetUpperBound(0)
			MessageBox.Show(ListOfXFRACASEntities(i).Name)
			{{APIPrefix\|Next}}

			{{APIPrefix\|Catch}} Ex {{APIPrefix\|As}} Exception
			{{APIComment\|'Write error message to diagnostics log.}}
			MyRepository.XFRACAS.WriteExceptionToDiagosticsLog(Ex, XFRACASDiagnosticsEntryType.Error, {{APIPrefix\|"Reading Entities"}})

			{{APIPrefix\|End Try}}
	{{APIPrefix\|End If}}		{{APIPrefix\|End If}}

Alex Ulanov: /* Usage Example */

2015-05-27T16:06:39Z

Usage Example

← Older revision		Revision as of 16:06, 27 May 2015
Line 15:		Line 15:
	{{APIComment\|'Get the list of XFRACAS Entities in the current project in the connected repository.}}		{{APIComment\|'Get the list of XFRACAS Entities in the current project in the connected repository.}}
	{{APIPrefix\|If}}success{{APIPrefix\|Then}}		{{APIPrefix\|If}}success{{APIPrefix\|Then}}
	MyRepository.XFRACAS.~~WriteToDiagnosticsLog~~("Successfully connected to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Information)		MyRepository.XFRACAS.WriteMessageToDiagnosticsLog("Successfully connected to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Information)
	{{APIPrefix\|Try}}		{{APIPrefix\|Try}}
	{{APIPrefix\|Dim}}ListOfXFRACASEntities(){{APIPrefix\|As}}SynthesisAPI.[[NameIdPair Class\|NameIdPair]] = MyRepository.XFRACAS.[[Repository.GetAllXFRACASEntities\|GetAllXFRACASEntities]]()		{{APIPrefix\|Dim}}ListOfXFRACASEntities(){{APIPrefix\|As}}SynthesisAPI.[[NameIdPair Class\|NameIdPair]] = MyRepository.XFRACAS.[[Repository.GetAllXFRACASEntities\|GetAllXFRACASEntities]]()
Line 23:		Line 23:
	{{APIPrefix\|Catch}}ex{{APIPrefix\|As}}Exception		{{APIPrefix\|Catch}}ex{{APIPrefix\|As}}Exception
	{{APIComment\|'Write error message to diagnostics log}}		{{APIComment\|'Write error message to diagnostics log}}
	MyRepository.XFRACAS.~~WriteToDiagosticsLog~~(ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")		MyRepository.XFRACAS.WriteExceptionToDiagosticsLog(ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")
	{{APIPrefix\|End Try}}		{{APIPrefix\|End Try}}
	{{APIPrefix\|End If}}		{{APIPrefix\|End If}}

Alex Ulanov: /* Usage Example */

2015-05-27T15:50:12Z

Usage Example

← Older revision		Revision as of 15:50, 27 May 2015
Line 11:		Line 11:

	= Usage Example =		= Usage Example =
	~~{{APIComment\|Code Block}}~~


	{{APIComment\|'Connect to the Synthesis repository.}}		{{APIComment\|'Connect to the Synthesis repository.}}
	{{APIPrefix\|Dim}}Success{{APIPrefix\|As Boolean}}= MyRepository.[[Repository.ConnectToRepository\|ConnectToRepository]]("RepositoryFileNamePath")		{{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.}}		{{APIComment\|'Get the list of XFRACAS Entities in the current project in the connected repository.}}
	{{APIPrefix\|If}}success{{APIPrefix\|Then}}		{{APIPrefix\|If}}success{{APIPrefix\|Then}}
	MyRepository.WriteToDiagnosticsLog("Successfully connected to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Information)		MyRepository.XFRACAS.WriteToDiagnosticsLog("Successfully connected to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Information)
	{{APIPrefix\|Try}}		{{APIPrefix\|Try}}
	{{APIPrefix\|Dim}}ListOfXFRACASEntities(){{APIPrefix\|As}}SynthesisAPI.[[NameIdPair Class\|NameIdPair]] = MyRepository.[[Repository.GetAllXFRACASEntities\|GetAllXFRACASEntities]]()		{{APIPrefix\|Dim}}ListOfXFRACASEntities(){{APIPrefix\|As}}SynthesisAPI.[[NameIdPair Class\|NameIdPair]] = MyRepository.XFRACAS.[[Repository.GetAllXFRACASEntities\|GetAllXFRACASEntities]]()
	{{APIPrefix\|For}}i{{APIPrefix\|As Integer}}= 0{{APIPrefix\|To}}ListOfXFRACASEntities.GetUpperBound(0)		{{APIPrefix\|For}}i{{APIPrefix\|As Integer}}= 0{{APIPrefix\|To}}ListOfXFRACASEntities.GetUpperBound(0)
	MessageBox.Show(ListOfXFRACASEntities(i).Name)		MessageBox.Show(ListOfXFRACASEntities(i).Name)
Line 26:		Line 23:
	{{APIPrefix\|Catch}}ex{{APIPrefix\|As}}Exception		{{APIPrefix\|Catch}}ex{{APIPrefix\|As}}Exception
	{{APIComment\|'Write error message to diagnostics log}}		{{APIComment\|'Write error message to diagnostics log}}
	MyRepository.WriteToDiagosticsLog(ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")		MyRepository.XFRACAS.WriteToDiagosticsLog(ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")
	{{APIPrefix\|End Try}}		{{APIPrefix\|End Try}}
	{{APIPrefix\|End If}}		{{APIPrefix\|End If}}

← Older revision		Revision as of 15:09, 10 November 2015
Line 46:		Line 46:
	{{APIPrefix\|Catch}} Ex {{APIPrefix\|As}} Exception		{{APIPrefix\|Catch}} Ex {{APIPrefix\|As}} Exception
	{{APIComment\|'Write error message to diagnostics log.}}		{{APIComment\|'Write error message to diagnostics log.}}
	MyRepository.XFRACAS.~~WriteExceptionToDiagosticsLog~~(Ex, XFRACASDiagnosticsEntryType.Error, {{APIString\|"Reading Entities"}})		MyRepository.XFRACAS.WriteExceptionToDiagnosticsLog(Ex, XFRACASDiagnosticsEntryType.Error, {{APIString\|"Reading Entities"}})

	{{APIPrefix\|End Try}}		{{APIPrefix\|End Try}}
	{{APIPrefix\|End If}}		{{APIPrefix\|End If}}

← Older revision		Revision as of 15:21, 5 November 2015
Line 21:		Line 21:

	== Example ==		== Example ==
	The following example demonstrates how to write messages and exceptions to the XFRACAS diagnostics log. It assumes that the repository has existing connections to XFRACAS entities.		The following example demonstrates how to write messages and exceptions to the XFRACAS diagnostics log. It assumes that the enterprise repository has existing connections to XFRACAS entities.

	'''VB.NET'''		'''VB.NET'''

	{{APIComment\|'Connect to the Synthesis repository~~. The following code}}~~		{{APIComment\|'Connect to the Synthesis enterprise repository.}}
	~~{{APIComment\|'assumes that a file called "RSRepository1.rsr10" exists in the C: drive~~.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{APIPrefix\|Dim}} Success {{APIPrefix\|As}} Boolean		{{APIPrefix\|Dim}} Success {{APIPrefix\|As}} Boolean
	Success = MyRepository.~~ConnectToRepository~~ ({{APIString\|"~~C:\RSRepository1.rsr10~~"}})		Success = MyRepository.ConnectToSQLRepository ({{APIString\|"MyServer"}}, {{APIString\|"MyDatabase"}})

	{{APIComment\|'Record a message to diagnostic log if the connection to the repository is successful.}}		{{APIComment\|'Record a message to diagnostic log if the connection to the repository is successful.}}
Line 47:		Line 46:
	{{APIPrefix\|Catch}} Ex {{APIPrefix\|As}} Exception		{{APIPrefix\|Catch}} Ex {{APIPrefix\|As}} Exception
	{{APIComment\|'Write error message to diagnostics log.}}		{{APIComment\|'Write error message to diagnostics log.}}
	MyRepository.XFRACAS.WriteExceptionToDiagosticsLog(Ex, XFRACASDiagnosticsEntryType.Error, {{~~APIPrefix~~\|"Reading Entities"}})		MyRepository.XFRACAS.WriteExceptionToDiagosticsLog(Ex, XFRACASDiagnosticsEntryType.Error, {{APIString\|"Reading Entities"}})

	{{APIPrefix\|End Try}}		{{APIPrefix\|End Try}}
	{{APIPrefix\|End If}}		{{APIPrefix\|End If}}

← Older revision		Revision as of 21:05, 28 October 2015
Line 1:		Line 1:
	{{Template:~~APIClass~~\|Repository Class\|Repository}}		{{DISPLAYTITLE:Repository.XFRACAS.WriteExceptionToDiagnosticsLog Method}}{{Template:API}}{{Template:APIBreadcrumb\|9\|.[[Repository Class\|Repository]]}}
	~~{{Template:Repository.WriteToDiagnosticsLog (System.Exception,mXFRACASDiagnosticEntryType, String)~~.~~Cmt}}~~

			<onlyinclude>Writes exception information to the XFRACAS diagnostics log.</onlyinclude>

	== Syntax ==		== Syntax ==
	*WriteToDiagnosticsLog(exObject ~~{{APIPrefix\|As}} System~~.Exception ~~, entrytype {{APIPrefix\|As}}~~ [[~~Repository.XFRACASDiagnosticEntryType~~\|~~XFRACASDiagnosticEntryType~~]]~~, {{APIPrefix\|~~ Optional~~}} comment{{APIPrefix\|As~~ String~~}})~~		'''.WriteExceptionToDiagnosticsLog''' (''exObject'', ''entryType'', ''comment'')

			===Parameters===
			''exObject''

			:Required. Exception. Represents the error that occurred during application execution.

			''entryType''

			:Required. The XFRACAS diagnostics type. Can be any [[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]] enumeration.

			''comment''
			:Optional. String. The text to write to the XFRACAS diagnostics log.


	~~Parameters~~		== Example ==
	~~:''exObject'': Represents an error that occurs during application execution~~		The following example demonstrates
	~~:''entryType'':~~ The ~~type of diagnostics entry type, specified as [[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]]~~
	~~:''comment'': ''Optional'' comment to write to the diagnostics log~~

	~~= Usage Example =~~		'''VB.NET'''
	{{APIComment\|'Connect to the Synthesis repository.}}
	{{APIPrefix\|Dim}}Success{{APIPrefix\|As ~~Boolean~~}}= MyRepository~~.[[Repository~~.ConnectToRepository\|~~ConnectToRepository]](~~"~~RepositoryFileNamePath~~")		{{APIComment\|'Connect to the Synthesis repository. The following code}}
	{{APIComment\|'~~Get~~ the ~~list of XFRACAS Entities in~~ the ~~current project in the connected~~ repository.}}		{{APIComment\|'assumes that a file called "RSRepository1.rsr10" exists in the C: drive.}}
	{{APIPrefix\|If}}~~success~~{{APIPrefix\|Then}}		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	MyRepository.XFRACAS.WriteMessageToDiagnosticsLog("Successfully connected to repository", ~~SynthesisAPI.[[~~XFRACASDiagnosticsEntryType ~~Enumeration\|XFRACASDiagnosticsEntryType]]~~.Information)		{{APIPrefix\|Dim}} Success {{APIPrefix\|As}} Boolean
	{{APIPrefix\|Try}}		Success = MyRepository.ConnectToRepository ({{APIString\|"C:\RSRepository1.rsr10"}})
	{{APIPrefix\|Dim}}ListOfXFRACASEntities(){{APIPrefix\|As}}~~SynthesisAPI.[[~~NameIdPair ~~Class\|NameIdPair]]~~ = MyRepository.XFRACAS~~.[[Repository~~.GetAllXFRACASEntities~~\|GetAllXFRACASEntities]]()~~
	{{APIPrefix\|~~For~~}}i{{APIPrefix\|As Integer}}= 0{{APIPrefix\|To}}ListOfXFRACASEntities.GetUpperBound(0)		{{APIComment\|'Record a message to diagnostic log if the connection to the repository is successful.}}
	MessageBox.Show(ListOfXFRACASEntities(i).Name)		{{APIPrefix\|If}} Success {{APIPrefix\|Then}}
	{{APIPrefix\|Next}}		MyRepository.XFRACAS.WriteMessageToDiagnosticsLog({{APIString\|"Successfully connected to repository"}}, XFRACASDiagnosticsEntryType.Information)
	{{APIPrefix\|Catch}}ex{{APIPrefix\|As}}Exception
	{{APIComment\|'Write error message to diagnostics log}}		{{APIComment\|'Get a list of all XFRACAS entities connected to the repository.}}
	MyRepository.XFRACAS.WriteExceptionToDiagosticsLog(ex, ~~SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|~~XFRACASDiagnosticsEntryType]].Error, "Reading Entities")		{{APIPrefix\|Try}}
	{{APIPrefix\|End Try}}		{{APIPrefix\|Dim}} ListOfXFRACASEntities() {{APIPrefix\|As}} NameIdPair
			ListofXFRACASEntities = MyRepository.XFRACAS.GetAllXFRACASEntities

			{{APIPrefix\|Dim}} i {{APIPrefix\|As}} Integer
			{{APIPrefix\|For}} i = 0 {{APIPrefix\|To}} ListOfXFRACASEntities.GetUpperBound(0)
			MessageBox.Show(ListOfXFRACASEntities(i).Name)
			{{APIPrefix\|Next}}

			{{APIPrefix\|Catch}} Ex {{APIPrefix\|As}} Exception
			{{APIComment\|'Write error message to diagnostics log.}}
			MyRepository.XFRACAS.WriteExceptionToDiagosticsLog(Ex, XFRACASDiagnosticsEntryType.Error, {{APIPrefix\|"Reading Entities"}})

			{{APIPrefix\|End Try}}
	{{APIPrefix\|End If}}		{{APIPrefix\|End If}}

← Older revision		Revision as of 16:06, 27 May 2015
Line 15:		Line 15:
	{{APIComment\|'Get the list of XFRACAS Entities in the current project in the connected repository.}}		{{APIComment\|'Get the list of XFRACAS Entities in the current project in the connected repository.}}
	{{APIPrefix\|If}}success{{APIPrefix\|Then}}		{{APIPrefix\|If}}success{{APIPrefix\|Then}}
	MyRepository.XFRACAS.~~WriteToDiagnosticsLog~~("Successfully connected to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Information)		MyRepository.XFRACAS.WriteMessageToDiagnosticsLog("Successfully connected to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Information)
	{{APIPrefix\|Try}}		{{APIPrefix\|Try}}
	{{APIPrefix\|Dim}}ListOfXFRACASEntities(){{APIPrefix\|As}}SynthesisAPI.[[NameIdPair Class\|NameIdPair]] = MyRepository.XFRACAS.[[Repository.GetAllXFRACASEntities\|GetAllXFRACASEntities]]()		{{APIPrefix\|Dim}}ListOfXFRACASEntities(){{APIPrefix\|As}}SynthesisAPI.[[NameIdPair Class\|NameIdPair]] = MyRepository.XFRACAS.[[Repository.GetAllXFRACASEntities\|GetAllXFRACASEntities]]()
Line 23:		Line 23:
	{{APIPrefix\|Catch}}ex{{APIPrefix\|As}}Exception		{{APIPrefix\|Catch}}ex{{APIPrefix\|As}}Exception
	{{APIComment\|'Write error message to diagnostics log}}		{{APIComment\|'Write error message to diagnostics log}}
	MyRepository.XFRACAS.~~WriteToDiagosticsLog~~(ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")		MyRepository.XFRACAS.WriteExceptionToDiagosticsLog(ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")
	{{APIPrefix\|End Try}}		{{APIPrefix\|End Try}}
	{{APIPrefix\|End If}}		{{APIPrefix\|End If}}

← Older revision		Revision as of 15:50, 27 May 2015
Line 11:		Line 11:

	= Usage Example =		= Usage Example =
	~~{{APIComment\|Code Block}}~~


	{{APIComment\|'Connect to the Synthesis repository.}}		{{APIComment\|'Connect to the Synthesis repository.}}
	{{APIPrefix\|Dim}}Success{{APIPrefix\|As Boolean}}= MyRepository.[[Repository.ConnectToRepository\|ConnectToRepository]]("RepositoryFileNamePath")		{{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.}}		{{APIComment\|'Get the list of XFRACAS Entities in the current project in the connected repository.}}
	{{APIPrefix\|If}}success{{APIPrefix\|Then}}		{{APIPrefix\|If}}success{{APIPrefix\|Then}}
	MyRepository.WriteToDiagnosticsLog("Successfully connected to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Information)		MyRepository.XFRACAS.WriteToDiagnosticsLog("Successfully connected to repository", SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Information)
	{{APIPrefix\|Try}}		{{APIPrefix\|Try}}
	{{APIPrefix\|Dim}}ListOfXFRACASEntities(){{APIPrefix\|As}}SynthesisAPI.[[NameIdPair Class\|NameIdPair]] = MyRepository.[[Repository.GetAllXFRACASEntities\|GetAllXFRACASEntities]]()		{{APIPrefix\|Dim}}ListOfXFRACASEntities(){{APIPrefix\|As}}SynthesisAPI.[[NameIdPair Class\|NameIdPair]] = MyRepository.XFRACAS.[[Repository.GetAllXFRACASEntities\|GetAllXFRACASEntities]]()
	{{APIPrefix\|For}}i{{APIPrefix\|As Integer}}= 0{{APIPrefix\|To}}ListOfXFRACASEntities.GetUpperBound(0)		{{APIPrefix\|For}}i{{APIPrefix\|As Integer}}= 0{{APIPrefix\|To}}ListOfXFRACASEntities.GetUpperBound(0)
	MessageBox.Show(ListOfXFRACASEntities(i).Name)		MessageBox.Show(ListOfXFRACASEntities(i).Name)
Line 26:		Line 23:
	{{APIPrefix\|Catch}}ex{{APIPrefix\|As}}Exception		{{APIPrefix\|Catch}}ex{{APIPrefix\|As}}Exception
	{{APIComment\|'Write error message to diagnostics log}}		{{APIComment\|'Write error message to diagnostics log}}
	MyRepository.WriteToDiagosticsLog(ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")		MyRepository.XFRACAS.WriteToDiagosticsLog(ex, SynthesisAPI.[[XFRACASDiagnosticsEntryType Enumeration\|XFRACASDiagnosticsEntryType]].Error, "Reading Entities")
	{{APIPrefix\|End Try}}		{{APIPrefix\|End Try}}
	{{APIPrefix\|End If}}		{{APIPrefix\|End If}}