Online documentation - WebsydianExpress v3.5 |
APIServer.Language.GetLanguagesForSite
Field | Variable | ...as | Description |
---|---|---|---|
LanguageCode | Input | Input | This parameter specifies the language in which the texts will
be retrieved (e.g. specify German to retrieve the German version of
the language description). This is not the identification of
the language to retrieve.
Specify a blank value to retrieve the base values of the texts. |
LanguageCode | Position | Input | This is the identification of the language to retrieve. This positions the list. |
SiteKey | Position | Input | This identifies the Site the language belongs to. Mandatory - restricts the list. |
Position | Control | Input | Specifies whether the Information in the Position variable should be used to set the start position of the list. |
RowsFetched | Control | Dual | Specifies the number of rows that the function has retrieved. |
LanguageCode | FetchedData (64) | Output | The unique identification of the language. |
LanguageDescription | FetchedData
(64) |
Output | The name/description of the language - this is the text that will normally be used in lists and drop down boxes. |
SiteKey | FetchedData
(64) |
Output | The site the language belongs to. |
ImagePath | FetchedData
(64) |
Output | Specifies where an image file (e.g. a national flag) that can be used to select the language is stored. |
LanguageCharacterSet | FetchedData
(64) |
Output | The encoding that will be used when the language is selected. |
Retrieve list of languages for a site. The list is restricted on the SiteKey specified in the Position variable.
As language information can be stored in language dependent variants (like any other translated entities), you can specify the language for which you want to retrieve the information. If the language information is available in the specified language variant, the translated texts will be returned - if not, the base information will be returned.