CLanguage.SetLanguage: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) m (moved Common Class to CLanguage.SetLanguage: V10.1 update. Moved page to consolidate information and improve docs, as per SYN-I-4864.) |
Kate Racaza (talk | contribs) (V10.1 major update to documentation.) |
||
| Line 2: | Line 2: | ||
<onlyinclude>Sets the API | <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== | ||
''' | |||
'''.SetLanguage'''(''Language'') | |||
====Parameters==== | ====Parameters==== | ||
| Line 13: | Line 14: | ||
==Example == | ==Example == | ||
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}} | ||
{{APIPrefix|Dim}} Lng {{APIPrefix|As New}} cLanguage | |||
Lng.SetLanguage (Language.Portuguese) | |||
{{APIComment|'The following code will deliberately cause the | {{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 | ||
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepositoryx122g3.rsr10"}}) | |||
MyRepository.ConnectToAccessRepository({{APIString|"C:\ | |||
Revision as of 00:09, 1 March 2016
 |
Member of: SynthesisAPI
Sets the language of the Synthesis API library. Messages returned by the Synthesis repository to the API will be displayed in the specified language.
Syntax
.SetLanguage(Language)
Parameters
Language
- Required. The display language. Can be any Language constant.
Example
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 'Set the API's language to Portuguese Dim Lng As New cLanguage Lng.SetLanguage (Language_Portuguese) 'The following code will deliberately cause the connection to fail and return an error message. Dim MyRepository As New Repository MyRepository.ConnectToAccessRepository("C:\RSRepositoryx122g3.rsr10")
VB.NET 'Set the API's language to Portuguese Dim Lng As New cLanguage Lng.SetLanguage (Language.Portuguese) 'The following code will deliberately cause the connection to fail and return an error message. Dim MyRepository As New Repository MyRepository.ConnectToAccessRepository("C:\RSRepositoryx122g3.rsr10")