Session Properties Action Set: Syntax

Provides actions for managing session properties

addFormat Action

Adds a format to a format library.

Create a New Format Library in Session Scope
Create a Locale-Specific Format

CASL Syntax

sessionProp.addFormat <result=results> <status=rc> /
dataType={"string-1" <, "string-2", ...>},
defaultL=64-bit-integer,
fill={"string-1" <, "string-2", ...>},
required parameter fmtLibName="string",
required parameter fmtName="string",
fmtType="string",
fuzz=double,
locale="string",
maxL=64-bit-integer,
minL=64-bit-integer,
mult={double-1 <, double-2, ...>},
multiLabel=TRUE | FALSE,
noedit={"string-1" <, "string-2", ...>},
notSorted=TRUE | FALSE,
prefix={"string-1" <, "string-2", ...>},
ranges={"string-1" <, "string-2", ...>},
replace=TRUE | FALSE
;
indicates a required parameter

Parameter Descriptions

dataType={"string-1" <, "string-2", ...>}

Indicates whether the value is DATE, TIME, or DATETIME.

defaultL=64-bit-integer

specifies the default length of the format.

Default-1

fill={"string-1" <, "string-2", ...>}

Indicates fill character for PICTURE format.

* fmtLibName="string"

specifies a name for the format library.

* fmtName="string"

specifies a name for the format.

RestrictionA format name cannot end in a number, and it cannot be the same as the name of a format that is supplied by SAS.
RequirementString must be a valid SAS name. For a numeric format, the name can be up to 32 characters by default. For a character format, the name should begin with a dollar sign ($) and can be up to 31 characters in length. The maximum length of the format name is controlled by SAS system option VALIDFMTNAME=, which defaults to 32 characters. See SAS System Options: Reference for details.

fmtType="string"

Indicates the format type: PICTURE, INVALUE, or VALUE.

fuzz=double

specifies a fuzz factor for matching values to a range.

Default0

locale="string"

specifies the locale to use in the format name locale prefix.

maxL=64-bit-integer

specifies a maximum length for the format, in bytes.

Default-1

minL=64-bit-integer

specifies a minimum length for the format, in bytes.

Default-1

mult={double-1 <, double-2, ...>}

Indicates multiplier for PICTURE format instead of computing based on decimal points.

Default0

multiLabel=TRUE | FALSE

when set to True, multiple labels can be specified for the internal value.

DefaultFALSE

noedit={"string-1" <, "string-2", ...>}

Indicates non-picture label for PICTURE format.

notSorted=TRUE | FALSE

when set to True, values or ranges are stored in the order in which they are defined.

DefaultFALSE

prefix={"string-1" <, "string-2", ...>}

Indicates prefix characters for PICTURE format.

ranges={"string-1" <, "string-2", ...>}

specifies a list of value=label or range=label pairs. Ranges are specified as min-max=label.

RequirementYou must use a dot (.) as the decimal separator when specifying decimal range values. The formatted values are automatically displayed with the appropriate decimal separator for the locale. See List the Ranges in a Format.

replace=TRUE | FALSE

when set to True, an existing format of the same name is replaced with this format.

DefaultTRUE

addFormat Action

Adds a format to a format library.

Create a New Format Library in Session Scope
Create a Locale-Specific Format

Lua Syntax

results, info = s:sessionProp_addFormat{
dataType={"string-1" <, "string-2", ...>},
defaultL=64-bit-integer,
fill={"string-1" <, "string-2", ...>},
required parameter fmtLibName="string",
required parameter fmtName="string",
fmtType="string",
fuzz=double,
locale="string",
maxL=64-bit-integer,
minL=64-bit-integer,
mult={double-1 <, double-2, ...>},
multiLabel=true | false,
noedit={"string-1" <, "string-2", ...>},
notSorted=true | false,
prefix={"string-1" <, "string-2", ...>},
ranges={"string-1" <, "string-2", ...>},
replace=true | false
}
indicates a required parameter

Parameter Descriptions

dataType={"string-1" <, "string-2", ...>}

Indicates whether the value is DATE, TIME, or DATETIME.

defaultL=64-bit-integer

specifies the default length of the format.

Default-1

fill={"string-1" <, "string-2", ...>}

Indicates fill character for PICTURE format.

* fmtLibName="string"

specifies a name for the format library.

* fmtName="string"

specifies a name for the format.

RestrictionA format name cannot end in a number, and it cannot be the same as the name of a format that is supplied by SAS.
RequirementString must be a valid SAS name. For a numeric format, the name can be up to 32 characters by default. For a character format, the name should begin with a dollar sign ($) and can be up to 31 characters in length. The maximum length of the format name is controlled by SAS system option VALIDFMTNAME=, which defaults to 32 characters. See SAS System Options: Reference for details.

fmtType="string"

Indicates the format type: PICTURE, INVALUE, or VALUE.

fuzz=double

specifies a fuzz factor for matching values to a range.

Default0

locale="string"

specifies the locale to use in the format name locale prefix.

maxL=64-bit-integer

specifies a maximum length for the format, in bytes.

Default-1

minL=64-bit-integer

specifies a minimum length for the format, in bytes.

Default-1

mult={double-1 <, double-2, ...>}

Indicates multiplier for PICTURE format instead of computing based on decimal points.

Default0

multiLabel=true | false

when set to True, multiple labels can be specified for the internal value.

Defaultfalse

noedit={"string-1" <, "string-2", ...>}

Indicates non-picture label for PICTURE format.

notSorted=true | false

when set to True, values or ranges are stored in the order in which they are defined.

Defaultfalse

prefix={"string-1" <, "string-2", ...>}

Indicates prefix characters for PICTURE format.

ranges={"string-1" <, "string-2", ...>}

specifies a list of value=label or range=label pairs. Ranges are specified as min-max=label.

RequirementYou must use a dot (.) as the decimal separator when specifying decimal range values. The formatted values are automatically displayed with the appropriate decimal separator for the locale. See List the Ranges in a Format.

replace=true | false

when set to True, an existing format of the same name is replaced with this format.

Defaulttrue

addFormat Action

Adds a format to a format library.

Create a New Format Library in Session Scope
Create a Locale-Specific Format

Python Syntax

results= s.sessionProp.addFormat(
dataType=["string-1" <, "string-2", ...>],
defaultL=64-bit-integer,
fill=["string-1" <, "string-2", ...>],
required parameter fmtLibName="string",
required parameter fmtName="string",
fmtType="string",
fuzz=double,
locale="string",
maxL=64-bit-integer,
minL=64-bit-integer,
mult=[double-1 <, double-2, ...>],
multiLabel=True | False,
noedit=["string-1" <, "string-2", ...>],
notSorted=True | False,
prefix=["string-1" <, "string-2", ...>],
ranges=["string-1" <, "string-2", ...>],
replace=True | False
)
indicates a required parameter

Parameter Descriptions

dataType=["string-1" <, "string-2", ...>]

Indicates whether the value is DATE, TIME, or DATETIME.

defaultL=64-bit-integer

specifies the default length of the format.

Default-1

fill=["string-1" <, "string-2", ...>]

Indicates fill character for PICTURE format.

* fmtLibName="string"

specifies a name for the format library.

* fmtName="string"

specifies a name for the format.

RestrictionA format name cannot end in a number, and it cannot be the same as the name of a format that is supplied by SAS.
RequirementString must be a valid SAS name. For a numeric format, the name can be up to 32 characters by default. For a character format, the name should begin with a dollar sign ($) and can be up to 31 characters in length. The maximum length of the format name is controlled by SAS system option VALIDFMTNAME=, which defaults to 32 characters. See SAS System Options: Reference for details.

fmtType="string"

Indicates the format type: PICTURE, INVALUE, or VALUE.

fuzz=double

specifies a fuzz factor for matching values to a range.

Default0

locale="string"

specifies the locale to use in the format name locale prefix.

maxL=64-bit-integer

specifies a maximum length for the format, in bytes.

Default-1

minL=64-bit-integer

specifies a minimum length for the format, in bytes.

Default-1

mult=[double-1 <, double-2, ...>]

Indicates multiplier for PICTURE format instead of computing based on decimal points.

Default0

multiLabel=True | False

when set to True, multiple labels can be specified for the internal value.

DefaultFalse

noedit=["string-1" <, "string-2", ...>]

Indicates non-picture label for PICTURE format.

notSorted=True | False

when set to True, values or ranges are stored in the order in which they are defined.

DefaultFalse

prefix=["string-1" <, "string-2", ...>]

Indicates prefix characters for PICTURE format.

ranges=["string-1" <, "string-2", ...>]

specifies a list of value=label or range=label pairs. Ranges are specified as min-max=label.

RequirementYou must use a dot (.) as the decimal separator when specifying decimal range values. The formatted values are automatically displayed with the appropriate decimal separator for the locale. See List the Ranges in a Format.

replace=True | False

when set to True, an existing format of the same name is replaced with this format.

DefaultTrue

addFormat Action

Adds a format to a format library.

Create a New Format Library in Session Scope
Create a Locale-Specific Format

R Syntax

results <– cas.sessionProp.addFormat(s,
dataType=list("string-1" <, "string-2", ...>),
defaultL=64-bit-integer,
fill=list("string-1" <, "string-2", ...>),
required parameter fmtLibName="string",
required parameter fmtName="string",
fmtType="string",
fuzz=double,
locale="string",
maxL=64-bit-integer,
minL=64-bit-integer,
mult=list(double-1 <, double-2, ...>),
multiLabel=TRUE | FALSE,
noedit=list("string-1" <, "string-2", ...>),
notSorted=TRUE | FALSE,
prefix=list("string-1" <, "string-2", ...>),
ranges=list("string-1" <, "string-2", ...>),
replace=TRUE | FALSE
)
indicates a required parameter

Parameter Descriptions

dataType=list("string-1" <, "string-2", ...>)

Indicates whether the value is DATE, TIME, or DATETIME.

defaultL=64-bit-integer

specifies the default length of the format.

Default-1

fill=list("string-1" <, "string-2", ...>)

Indicates fill character for PICTURE format.

* fmtLibName="string"

specifies a name for the format library.

* fmtName="string"

specifies a name for the format.

RestrictionA format name cannot end in a number, and it cannot be the same as the name of a format that is supplied by SAS.
RequirementString must be a valid SAS name. For a numeric format, the name can be up to 32 characters by default. For a character format, the name should begin with a dollar sign ($) and can be up to 31 characters in length. The maximum length of the format name is controlled by SAS system option VALIDFMTNAME=, which defaults to 32 characters. See SAS System Options: Reference for details.

fmtType="string"

Indicates the format type: PICTURE, INVALUE, or VALUE.

fuzz=double

specifies a fuzz factor for matching values to a range.

Default0

locale="string"

specifies the locale to use in the format name locale prefix.

maxL=64-bit-integer

specifies a maximum length for the format, in bytes.

Default-1

minL=64-bit-integer

specifies a minimum length for the format, in bytes.

Default-1

mult=list(double-1 <, double-2, ...>)

Indicates multiplier for PICTURE format instead of computing based on decimal points.

Default0

multiLabel=TRUE | FALSE

when set to True, multiple labels can be specified for the internal value.

DefaultFALSE

noedit=list("string-1" <, "string-2", ...>)

Indicates non-picture label for PICTURE format.

notSorted=TRUE | FALSE

when set to True, values or ranges are stored in the order in which they are defined.

DefaultFALSE

prefix=list("string-1" <, "string-2", ...>)

Indicates prefix characters for PICTURE format.

ranges=list("string-1" <, "string-2", ...>)

specifies a list of value=label or range=label pairs. Ranges are specified as min-max=label.

RequirementYou must use a dot (.) as the decimal separator when specifying decimal range values. The formatted values are automatically displayed with the appropriate decimal separator for the locale. See List the Ranges in a Format.

replace=TRUE | FALSE

when set to True, an existing format of the same name is replaced with this format.

DefaultTRUE
Last updated: September 20, 2022