# GetLocaleDisplayName

Returns the {@link java.util.Locale} display name with an optional display language/locale

## Method Signature

```
GetLocaleDisplayName(locale=[string], dspLocale=[string])
```

### Arguments

| Argument    | Type     | Required | Description                                                                          | Default |
| ----------- | -------- | -------- | ------------------------------------------------------------------------------------ | ------- |
| `locale`    | `string` | `false`  | Optional locale to target - either a common format ( "German" ), or an ISO Directive |         |
| `dspLocale` | `string` | `false`  | Optional display language locale                                                     |         |

## Examples

### Output current Locale's display name than set it to swiss locale

```java
writeOutput( getLocaleDisplayName() );
writeOutput( " → " );
setLocale( "de_ch" );
writeOutput( getLocaleDisplayName() );

```

Result: English (United States) → Deutsch (Schweiz)

### Additional Examples

[Run Example](https://try.boxlang.io/?code=eJwrL8osSXUpzS3QUEhPLfHJT07MSXXJLC7ISaz0S8xN1dBU0LTmAgAJfgzQ)

```java
writeDump( getLocaleDisplayName() );

```

## Related

* [ClearLocale](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/i18n/clearlocale)
* [CurrencyFormat](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/i18n/currencyformat)
* [GetLocale](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/i18n/getlocale)
* [GetLocaleInfo](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/i18n/getlocaleinfo)
* [IsCurrency](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/i18n/iscurrency)
* [LSCurrencyFormat](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/i18n/lscurrencyformat)
* [LSIsCurrency](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/i18n/lsiscurrency)
* [LSParseCurrency](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/i18n/lsparsecurrency)
* [ParseCurrency](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/i18n/parsecurrency)
* [SetLocale](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/i18n/setlocale)