CLanguage.SetLanguage - Revision history

Kate Racaza at 00:21, 1 March 2016

2016-03-01T00:21:34Z

← Older revision		Revision as of 00:21, 1 March 2016
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb}}		{{DISPLAYTITLE:cLanguage.SetLanguage}}{{Template:API}}{{Template:APIBreadcrumb}}

Kate Racaza: V10.1 major update to documentation.

2016-03-01T00:09:28Z

V10.1 major update to documentation.

← Older revision		Revision as of 00:09, 1 March 2016
Line 2:		Line 2:


	<onlyinclude>Sets the API~~'s display language~~. ~~Errors and warnings~~ returned by the Synthesis repository to the API will be displayed in the specified language. ~~(VB.NET only)~~</onlyinclude>		<onlyinclude>Sets the language of the Synthesis API library. Messages returned by the Synthesis repository to the API will be displayed in the specified language.</onlyinclude>

	==Syntax==		==Syntax==
	'''~~SynthesisAPI~~.SetLanguage'''(''Language'')
			'''.SetLanguage'''(''Language'')

	====Parameters====		====Parameters====
Line 13:		Line 14:

	==Example ==		==Example ==
	~~This example assumes that a file called "RSRepository1.rsr10" exists in the C: drive.~~ To demonstrate the method's functionality, the ~~code~~ deliberately returns an error message in Portuguese.		To demonstrate the method's functionality, the example deliberately returns an error message in Portuguese by connecting to a repository that doesn't exist.

			'''VBA'''

			{{APIComment\|'Set the API's language to Portuguese}}
			{{APIPrefix\|Dim}} Lng {{APIPrefix\|As New}} cLanguage
			Lng.SetLanguage (Language_Portuguese)

			{{APIComment\|'The following code will deliberately cause the connection to fail and return an error message.}}
			{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
			MyRepository.ConnectToAccessRepository({{APIString\|"C:\RSRepositoryx122g3.rsr10"}})

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

	{{APIComment\|'Set the API's language to Portuguese}}		{{APIComment\|'Set the API's language to Portuguese}}
	~~SynthesisAPI~~.SetLanguage(~~SynthesisAPI.~~Language.Portuguese)		{{APIPrefix\|Dim}} Lng {{APIPrefix\|As New}} cLanguage
			Lng.SetLanguage (Language.Portuguese)

	{{APIComment\|'The following code will deliberately cause the ~~Synthesis repository~~ to return an error message.}}		{{APIComment\|'The following code will deliberately cause the connection to fail and return an error message.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	~~{{APIPrefix\|Dim}} m {{APIPrefix\|As New}} cModel~~		MyRepository.ConnectToAccessRepository({{APIString\|"C:\RSRepositoryx122g3.rsr10"}})

	MyRepository.ConnectToAccessRepository({{APIString\|"C:\~~RSRepository1~~.rsr10"}})
	~~m = MyRepository.Model.GetModel(47~~)

Kate Racaza: moved Common Class to CLanguage.SetLanguage: V10.1 update. Moved page to consolidate information and improve docs, as per SYN-I-4864.

2016-03-01T00:08:36Z

moved Common Class to CLanguage.SetLanguage: V10.1 update. Moved page to consolidate information and improve docs, as per SYN-I-4864.

← Older revision	Revision as of 00:08, 1 March 2016
(No difference)

Kate Racaza at 21:32, 13 November 2015

2015-11-13T21:32:46Z

← Older revision		Revision as of 21:32, 13 November 2015
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb~~\|10~~}}		{{Template:API}}{{Template:APIBreadcrumb}}

Kate Racaza at 23:36, 11 November 2015

2015-11-11T23:36:55Z

← Older revision		Revision as of 23:36, 11 November 2015
Line 13:		Line 13:

	==Example ==		==Example ==
	To demonstrate the functionality, the ~~following example~~ deliberately returns an error message in Portuguese.		This example assumes that a file called "RSRepository1.rsr10" exists in the C: drive. To demonstrate the method's functionality, the code deliberately returns an error message in Portuguese.

	'''VB.NET'''		'''VB.NET'''
Line 20:		Line 20:
	SynthesisAPI.SetLanguage(SynthesisAPI.Language.Portuguese)		SynthesisAPI.SetLanguage(SynthesisAPI.Language.Portuguese)

	{{APIComment\|'The following code ~~triggers~~ the Synthesis repository to return an error message.}}		{{APIComment\|'The following code will deliberately cause the Synthesis repository to return an error message.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{APIPrefix\|Dim}} m {{APIPrefix\|As New}} cModel		{{APIPrefix\|Dim}} m {{APIPrefix\|As New}} cModel

Kate Racaza at 22:10, 28 October 2015

2015-10-28T22:10:28Z

← Older revision		Revision as of 22:10, 28 October 2015
Line 13:		Line 13:

	==Example ==		==Example ==
	~~The~~ following example returns an error message in Portuguese.		To demonstrate the functionality, the following example deliberately returns an error message in Portuguese.

	'''VB.NET'''		'''VB.NET'''
Line 20:		Line 20:
	SynthesisAPI.SetLanguage(SynthesisAPI.Language.Portuguese)		SynthesisAPI.SetLanguage(SynthesisAPI.Language.Portuguese)

	{{APIComment\|'The following code ~~sample~~ triggers the Synthesis repository to return an error message.}}		{{APIComment\|'The following code triggers the Synthesis repository to return an error message.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{APIPrefix\|Dim}} m {{APIPrefix\|As New}} cModel		{{APIPrefix\|Dim}} m {{APIPrefix\|As New}} cModel

Kate Racaza at 17:14, 27 October 2015

2015-10-27T17:14:58Z

← Older revision		Revision as of 17:14, 27 October 2015
Line 1:		Line 1:
	{{Template:API}}{{Template:~~APIBreadcrumbClass~~}}		{{Template:API}}{{Template:APIBreadcrumb\|10}}


	<onlyinclude>Sets the language of the API ~~library~~. (VB.NET only)</onlyinclude>		<onlyinclude>Sets the API's display language. Errors and warnings returned by the Synthesis repository to the API will be displayed in the specified language. (VB.NET only)</onlyinclude>

	==Syntax==		==Syntax==
Line 9:		Line 9:
	====Parameters====		====Parameters====
	''Language''		''Language''
	:Required. The language ~~for the API library~~. Can be any [[Language_Enumeration\|Language]] constant.		:Required. The display language. Can be any [[Language_Enumeration\|Language]] constant.


	==Example ==		==Example ==
			The following example returns an error message in Portuguese.

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

	{{APIComment\|'Set the language to Portuguese}}		{{APIComment\|'Set the API's language to Portuguese}}
	SynthesisAPI.SetLanguage(SynthesisAPI.Language.Portuguese)		SynthesisAPI.SetLanguage(SynthesisAPI.Language.Portuguese)

			{{APIComment\|'The following code sample triggers the Synthesis repository to return an error message.}}
			{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
			{{APIPrefix\|Dim}} m {{APIPrefix\|As New}} cModel

			MyRepository.ConnectToAccessRepository({{APIString\|"C:\RSRepository1.rsr10"}})
			m = MyRepository.Model.GetModel(47)

Kate Racaza at 16:48, 16 October 2015

2015-10-16T16:48:05Z

← Older revision		Revision as of 16:48, 16 October 2015
Line 2:		Line 2:


	<onlyinclude>Sets the language of the API library.</onlyinclude>		<onlyinclude>Sets the language of the API library. (VB.NET only)</onlyinclude>

	==Syntax==		==Syntax==
Line 9:		Line 9:
	====Parameters====		====Parameters====
	''Language''		''Language''
	:Required. The language for the API library. Can be any [[Language_Enumeration\|Language]] ~~enumeration~~ constant.		:Required. The language for the API library. Can be any [[Language_Enumeration\|Language]] constant.


Line 15:		Line 15:
	'''VB.NET'''		'''VB.NET'''

	{{APIComment\|'Set the language to ~~English~~}}		{{APIComment\|'Set the language to Portuguese}}
	SynthesisAPI.SetLanguage(SynthesisAPI.Language.~~English~~)		SynthesisAPI.SetLanguage(SynthesisAPI.Language.Portuguese)

Kate Racaza at 17:59, 31 August 2015

2015-08-31T17:59:14Z

← Older revision		Revision as of 17:59, 31 August 2015
Line 9:		Line 9:
	====Parameters====		====Parameters====
	''Language''		''Language''
	:The language for the API library. Can be any [[Language_Enumeration\|Language]] enumeration constant.		:Required. The language for the API library. Can be any [[Language_Enumeration\|Language]] enumeration constant.

Kate Racaza at 18:33, 7 August 2015

2015-08-07T18:33:23Z

← Older revision		Revision as of 18:33, 7 August 2015
Line 1:		Line 1:
	{{Template:~~APIClass\|Global_Common\|~~ }}		{{Template:API}}{{Template:APIBreadcrumbClass}}
	{{Template:~~Common Class.Cmt~~}}

	~~== Methods ==~~
	*[[Common.SetLanguage\|SetLanguage( Language )]] {{APIComment\|{{Template:Common.SetLanguage.Cmt}}}}

	== ~~Usage Example~~ ==		<onlyinclude>Sets the language of the API library.</onlyinclude>
	~~<div style~~=~~"margin-right~~: ~~150px;">~~
			==Syntax==
			'''SynthesisAPI.SetLanguage'''(''Language'')

			====Parameters====
			''Language''
			:The language for the API library. Can be any [[Language_Enumeration\|Language]] enumeration constant.


			==Example ==
			'''VB.NET'''

	{{APIComment\|'Set the language to English}}		{{APIComment\|'Set the language to English}}
	SynthesisAPI.SetLanguage(SynthesisAPI.Language.English)		SynthesisAPI.SetLanguage(SynthesisAPI.Language.English)
	~~</div>~~