str-var = Get_Profile$(option-str)
|
Operands:
|
option-str
|
A string containing the name of a PROFILE option. The permitted options are:
|
|
|
Option name
|
Return value
|
NAME
|
profile-name
|
LOCK
|
LOCKED | UNLOCKED
|
ACTION
|
nnn
|
AUTOBKUP
|
ON | OFF
|
AUTOCAPS
|
ON | OFF
|
AUTONUM
|
ON | OFF
|
AUTOSAVE
|
ON | OFF PROMPT | NOPROMPT
|
BOM
|
ON | OFF
|
BNDSLINE
|
NONE or the current BNDS line
|
CAPS
|
ON | OFF | AUTO:on | AUTO:off
|
CASE
|
C | T
|
CHANGE
|
DS | CS
|
COLLATE
|
name
|
COLS
|
ON | OFF
|
DCB
|
RECFM LRECL and EOL, separated by spaces
|
EMACRO
|
NONE or the EMACRO string
|
EOL
|
CRLF | LF | CR | NL | X'xx'
|
HEX
|
ON | OFF
|
HIDE
|
X ON | OFF FILE ON | OFF
|
HILITE
|
FIND ON | OFF AUTO ON | OFF
|
IMACRO
|
NONE or the IMACRO string
|
LRECL
|
nnn
|
MACLIB
|
NONE or the MACLIB string
|
MARK
|
ON | OFF
|
MARKLINE
|
NONE or the current MARK line
|
MASKLINE
|
NONE or the current MASK line
|
MINLEN
|
nnn
|
NOTIFY
|
NONE | EDIT | ALL
|
PAGE
|
ON | OFF [ +/-nn ]
|
PRESERVE
|
ON | OFF | C
|
RECFM
|
U | F | V | VBI | VLI
|
SCROLL
|
CSR | PAGE | HALF | ... Etc.
|
SETUNDO
|
nnn
|
SOURCE
|
ANSI | UTF8 | UTF16 | UTF16BE | EBCDIC
|
START
|
PRIOR | LABEL | FIRST | LAST | NEW
|
STATE
|
ON | OFF
|
SUBARG
|
NONE | string
|
SUBCMD
|
NONE | string
|
TABS
|
ON | OFF
|
TABSLINE
|
NONE or the current TABS definition line.
|
WORD
|
A string containing all characters which are considered valid Word characters for the current Profile.
|
XFORM
|
NONE or the XFORM name
|
XTABS
|
nnn
|
|
Returns:
|
|
The string value of the requested option is returned.
RC will be 8 if the option-str is not a valid string PROFILE option name; otherwise 0.
|
Special Notes:
|
|
There is no corresponding general function to set a PROFILE option. To accomplish that, issue an SPF_CMD for the desired setting. For example: SPF_CMD("START FIRST").
For numeric settings like LRECL, if you need to work with the returned value in numeric form, you can enclose the request in a VAL() function.
Example:
DIM MyLRECL AS STRING
DIM MyLRECLn AS LONG
MyLRECL = Get_Profile$("LRECL")
MyLRECLn = VAL(Get_Profile$("LRECL"))
|
Created with the Personal Edition of HelpNDoc: Converting Word Docs to eBooks Made Easy with HelpNDoc