ILocalesManager.AddCustomLocale Method

ILocalesManagerAddCustomLocale Method

Ingeniux CMS Content Store API

Adds a new custom locale or updates an existing custom locale with new values.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)

Syntax

ICustomLocale AddCustomLocale(
	ILocale baseLocale,
	string regionCode,
	string description
)

Function AddCustomLocale ( 
	baseLocale As ILocale,
	regionCode As String,
	description As String
) As ICustomLocale

ICustomLocale^ AddCustomLocale(
	ILocale^ baseLocale, 
	String^ regionCode, 
	String^ description
)

abstract AddCustomLocale : 
        baseLocale : ILocale * 
        regionCode : string * 
        description : string -> ICustomLocale

Type: ICustomLocale
The created or updated custom locale.

Exceptions

Exception	Condition
ArgumentException	When base locale is a custom locale, or when region code is an existing standard ISO locale region code.

Remarks

If the region code already exists in the custom locale's collection, that custom locale will be updated with new information.

the custom locale has to be based on a standard ISO locale. It can never be based on another custom locale.

If the region code provided exists as standard ISO locale region code, the system throws an error.