Session Properties Action Set: Syntax

Provides actions for managing session properties

deleteFormat Action

Deletes a format from a format library.

Example:

Remove a Format from a Format Library

CASL Syntax

Expand all Collapse all

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

fmtLibName="string",

fmtName="string",

locale="string"

;

indicates a required parameter

Parameter Descriptions

* fmtLibName="string"

specifies the format library name.

* fmtName="string"

specifies the name of a format.

Tip	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"`.

locale="string"

specifies the locale to embed in the format name.

Interaction	If a locale prefix is specified in fmtName, it overrides the locale parameter.

deleteFormat Action

Deletes a format from a format library.

Example:

Remove a Format from a Format Library

Lua Syntax

Expand all Collapse all

results, info = s:sessionProp_deleteFormat{

fmtLibName="string",

fmtName="string",

locale="string"

}

indicates a required parameter

Parameter Descriptions

* fmtLibName="string"

specifies the format library name.

* fmtName="string"

specifies the name of a format.

Tip	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"`.

locale="string"

specifies the locale to embed in the format name.

Interaction	If a locale prefix is specified in fmtName, it overrides the locale parameter.

deleteFormat Action

Deletes a format from a format library.

Example:

Remove a Format from a Format Library

Python Syntax

Expand all Collapse all

results=s.sessionProp.deleteFormat(

fmtLibName="string",

fmtName="string",

locale="string"

)

indicates a required parameter

Parameter Descriptions

* fmtLibName="string"

specifies the format library name.

* fmtName="string"

specifies the name of a format.

Tip	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"`.

locale="string"

specifies the locale to embed in the format name.

Interaction	If a locale prefix is specified in fmtName, it overrides the locale parameter.

deleteFormat Action

Deletes a format from a format library.

Example:

Remove a Format from a Format Library

R Syntax

Expand all Collapse all

results <– cas.sessionProp.deleteFormat(s,

fmtLibName="string",

fmtName="string",

locale="string"

)

indicates a required parameter

Parameter Descriptions

* fmtLibName="string"

specifies the format library name.

* fmtName="string"

specifies the name of a format.

Tip	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"`.

locale="string"

specifies the locale to embed in the format name.

Interaction	If a locale prefix is specified in fmtName, it overrides the locale parameter.

Last updated: March 19, 2025