SystemOptionsServices.RemoveCustomLocale Method

SystemOptionsServicesRemoveCustomLocale Method

Ingeniux CMS Web Services API

Removes a custom locale by its locale name.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<bool> RemoveCustomLocale(
	string locale,
	bool isCustomLocale
)

Public Function RemoveCustomLocale ( 
	locale As String,
	isCustomLocale As Boolean
) As XHRServiceResponseGeneric(Of Boolean)

public:
virtual XHRServiceResponseGeneric<bool>^ RemoveCustomLocale(
	String^ locale, 
	bool isCustomLocale
) sealed

abstract RemoveCustomLocale : 
        locale : string * 
        isCustomLocale : bool -> XHRServiceResponseGeneric<bool> 
override RemoveCustomLocale : 
        locale : string * 
        isCustomLocale : bool -> XHRServiceResponseGeneric<bool>

Parameters

locale: Type: SystemString
Locale name of the custom locale
Examples

"en-us-tx"
isCustomLocale: Type: SystemBoolean
[Missing <param name="isCustomLocale"/> documentation for "M:IngeniuxCMService.SystemOptionsServices.RemoveCustomLocale(System.String,System.Boolean)"]

Return Value

Type: XHRServiceResponseGenericBoolean
True if custom locale with given name exists and removed, false otherwise.

Remarks

If there are any Pages still using the custom locale, then the locale cannot be removed. Returns error status.

Reference

SystemOptionsServices Class

IngeniuxCMService Namespace