Session Properties Action Set: Syntax

Provides actions for managing session properties

listFmtRanges Action

Displays the range information for a format.

See:	Results
Example:	List the Ranges in a Format

CASL Syntax

Expand all Collapse all

sessionProp.listFmtRanges <result=results> <status=rc> /

displayLocale=TRUE | FALSE,

fmtLibName="string",

fmtName="string",

fuzz=double,

locale="string",

showLocale=TRUE | FALSE

;

Parameter Descriptions

displayLocale=TRUE | FALSE

use locale when displaying numeric format range.

Default	TRUE

fmtLibName="string"

specifies the format library name.

Requirement	You must specify parameter fmtLibName or fmtName. You can specify both.
Note	If you specify parameter fmtLibName without fmtName, the ranges for all of the formats in the specified format library are listed.

fmtName="string"

specifies the name of a format.

Default	Lists the format ranges for all of the formats in the format library specified in parameter fmtLibName.
Requirement	You must specify parameter fmtName or fmtLibName. You can specify both.
Note	If you specify parameter fmtName without fmtLibName, the ranges are listed for the specified format in all of the format libraries listed in the current format library search list.
Tips	To override the default locale, instead of using the locale parameter, you can add the locale prefix to the format name as shown in the following example: `"fr_FR-$codes"`.
Tips	When locale-prefixed and unprefixed formats exist such as $abc, en_US-$abc, and fr_FR-$abc, to list the ranges for format $abc, specify fmtName="$abc" and locale="NONE".

fuzz=double

specifies a fuzz factor for matching values to a range.

Default	0

locale="string"

specifies a locale to embed in the format name or NONE to override the default search order.

Interaction	If a locale prefix is specified in fmtName, it overrides the locale parameter.
Tip	When locale-prefixed and unprefixed formats exist such as $abc, en_US-$abc, and fr_FR-$abc, to specify the unprefixed format $abc, use locale="NONE" and fmtName="$abc".

showLocale=TRUE | FALSE

show locale used to find the format.

Default	FALSE

listFmtRanges Action

Displays the range information for a format.

See:	Results
Example:	List the Ranges in a Format

Lua Syntax

Expand all Collapse all

results, info = s:sessionProp_listFmtRanges{

displayLocale=true | false,

fmtLibName="string",

fmtName="string",

fuzz=double,

locale="string",

showLocale=true | false

}

Parameter Descriptions

displayLocale=true | false

use locale when displaying numeric format range.

Default	true

fmtLibName="string"

specifies the format library name.

Requirement	You must specify parameter fmtLibName or fmtName. You can specify both.
Note	If you specify parameter fmtLibName without fmtName, the ranges for all of the formats in the specified format library are listed.

fmtName="string"

specifies the name of a format.

Default	Lists the format ranges for all of the formats in the format library specified in parameter fmtLibName.
Requirement	You must specify parameter fmtName or fmtLibName. You can specify both.
Note	If you specify parameter fmtName without fmtLibName, the ranges are listed for the specified format in all of the format libraries listed in the current format library search list.
Tips	To override the default locale, instead of using the locale parameter, you can add the locale prefix to the format name as shown in the following example: `"fr_FR-$codes"`.
Tips	When locale-prefixed and unprefixed formats exist such as $abc, en_US-$abc, and fr_FR-$abc, to list the ranges for format $abc, specify fmtName="$abc" and locale="NONE".

fuzz=double

specifies a fuzz factor for matching values to a range.

Default	0

locale="string"

specifies a locale to embed in the format name or NONE to override the default search order.

Interaction	If a locale prefix is specified in fmtName, it overrides the locale parameter.
Tip	When locale-prefixed and unprefixed formats exist such as $abc, en_US-$abc, and fr_FR-$abc, to specify the unprefixed format $abc, use locale="NONE" and fmtName="$abc".

showLocale=true | false

show locale used to find the format.

Default	false

listFmtRanges Action

Displays the range information for a format.

See:	Results
Example:	List the Ranges in a Format

Python Syntax

Expand all Collapse all

results=s.sessionProp.listFmtRanges(

displayLocale=True | False,

fmtLibName="string",

fmtName="string",

fuzz=double,

locale="string",

showLocale=True | False

)

Parameter Descriptions

displayLocale=True | False

use locale when displaying numeric format range.

Default	True

fmtLibName="string"

specifies the format library name.

Requirement	You must specify parameter fmtLibName or fmtName. You can specify both.
Note	If you specify parameter fmtLibName without fmtName, the ranges for all of the formats in the specified format library are listed.

fmtName="string"

specifies the name of a format.

Default	Lists the format ranges for all of the formats in the format library specified in parameter fmtLibName.
Requirement	You must specify parameter fmtName or fmtLibName. You can specify both.
Note	If you specify parameter fmtName without fmtLibName, the ranges are listed for the specified format in all of the format libraries listed in the current format library search list.
Tips	To override the default locale, instead of using the locale parameter, you can add the locale prefix to the format name as shown in the following example: `"fr_FR-$codes"`.
Tips	When locale-prefixed and unprefixed formats exist such as $abc, en_US-$abc, and fr_FR-$abc, to list the ranges for format $abc, specify fmtName="$abc" and locale="NONE".

fuzz=double

specifies a fuzz factor for matching values to a range.

Default	0

locale="string"

specifies a locale to embed in the format name or NONE to override the default search order.

Interaction	If a locale prefix is specified in fmtName, it overrides the locale parameter.
Tip	When locale-prefixed and unprefixed formats exist such as $abc, en_US-$abc, and fr_FR-$abc, to specify the unprefixed format $abc, use locale="NONE" and fmtName="$abc".

showLocale=True | False

show locale used to find the format.

Default	False

listFmtRanges Action

Displays the range information for a format.

See:	Results
Example:	List the Ranges in a Format

R Syntax

Expand all Collapse all

results <– cas.sessionProp.listFmtRanges(s,

displayLocale=TRUE | FALSE,

fmtLibName="string",

fmtName="string",

fuzz=double,

locale="string",

showLocale=TRUE | FALSE

)

Parameter Descriptions

displayLocale=TRUE | FALSE

use locale when displaying numeric format range.

Default	TRUE

fmtLibName="string"

specifies the format library name.

Requirement	You must specify parameter fmtLibName or fmtName. You can specify both.
Note	If you specify parameter fmtLibName without fmtName, the ranges for all of the formats in the specified format library are listed.

fmtName="string"

specifies the name of a format.

Default	Lists the format ranges for all of the formats in the format library specified in parameter fmtLibName.
Requirement	You must specify parameter fmtName or fmtLibName. You can specify both.
Note	If you specify parameter fmtName without fmtLibName, the ranges are listed for the specified format in all of the format libraries listed in the current format library search list.
Tips	To override the default locale, instead of using the locale parameter, you can add the locale prefix to the format name as shown in the following example: `"fr_FR-$codes"`.
Tips	When locale-prefixed and unprefixed formats exist such as $abc, en_US-$abc, and fr_FR-$abc, to list the ranges for format $abc, specify fmtName="$abc" and locale="NONE".

fuzz=double

specifies a fuzz factor for matching values to a range.

Default	0

locale="string"

specifies a locale to embed in the format name or NONE to override the default search order.

Interaction	If a locale prefix is specified in fmtName, it overrides the locale parameter.
Tip	When locale-prefixed and unprefixed formats exist such as $abc, en_US-$abc, and fr_FR-$abc, to specify the unprefixed format $abc, use locale="NONE" and fmtName="$abc".

showLocale=TRUE | FALSE

show locale used to find the format.

Default	FALSE

Last updated: March 14, 2023