Jane.doe at 05:10, 15 December 2019

2019-12-15T05:10:42Z

← Older revision		Revision as of 05:10, 15 December 2019
Line 31:		Line 31:
	\| CBT \|\| style="text-align:center;" \| String \|\| TRUE if contiguous-best-try; otherwise FALSE.		\| CBT \|\| style="text-align:center;" \| String \|\| TRUE if contiguous-best-try; otherwise FALSE.
	\|-		\|-
	\| CDT \|\| style="text-align:center;" \| String \|\| Creation date/time.		\| CDT \|\| style="text-align:center;" \| String \|\| [[Creation Date\|Creation date/time]].
	\|-		\|-
	\| CTG \|\| style="text-align:center;" \| String \|\| TRUE if contiguous; otherwise FALSE.		\| CTG \|\| style="text-align:center;" \| String \|\| TRUE if contiguous; otherwise FALSE.

Darya.zelenina at 05:47, 15 January 2019

2019-01-15T05:47:19Z

← Older revision		Revision as of 05:47, 15 January 2019
Line 65:		Line 65:
	\| GRP \|\| style="text-align:center;" \| Integer \|\| Owner group number.		\| GRP \|\| style="text-align:center;" \| Integer \|\| Owner group number.
	\|-		\|-
	\| JOURNAL_FILE \|\| style="text-align:center;" \| String \|\| TRUE if the file is a journal; otherwise FALSE.		\| JOURNAL_FILE \|\| style="text-align:center;" \| String \|\| TRUE if the file is a [[RMS journaling\|journal]]; otherwise FALSE.
	\|-		\|-
	\| KNOWN \|\| style="text-align:center;" \| String \|\| Known file; returns TRUE or FALSE to indicate whether file is installed with the Install utility (INSTALL). However, returns NOSUCHFILE if a file does not exist (for example, the file has been installed but subsequently deleted).		\| KNOWN \|\| style="text-align:center;" \| String \|\| Known file; returns TRUE or FALSE to indicate whether file is installed with the Install utility (INSTALL). However, returns NOSUCHFILE if a file does not exist (for example, the file has been installed but subsequently deleted).
Line 130:		Line 130:
	RFM = "VAR"		RFM = "VAR"
	</pre>		</pre>

			[[Category: Lexical Functions]]

Maxim Megalinskiy: Changed the horizontal alignment of the text in the Return Type column

2018-09-13T09:49:52Z

Changed the horizontal alignment of the text in the Return Type column

Show changes

Darya.zelenina: Created page with "'''F$FILE_ATTRIBUTES()''' is a lexical function that returns attribute information for a specified file. =Format= F$FILE_ATTRIBUTES (filespec,item) ==..."

2018-08-23T10:27:04Z

Created page with "'''F$FILE_ATTRIBUTES()''' is a lexical function that returns attribute information for a specified file. =Format= F$FILE_ATTRIBUTES (filespec,item) ==..."

New page

'''F$FILE_ATTRIBUTES()''' is a [[Lexical functions|lexical function]] that returns attribute information for a specified file.

=Format=

F$FILE_ATTRIBUTES (filespec,item)

==filespec==

Specifies the name of the file about which you are requesting information. You must specify the file name as a character string expression.

You can specify only one file name. Wildcard characters are not allowed.

==item==

{| class="wikitable"
|-
! Item !! Return type !! Information required
|-
| AI || String || TRUE if after-image (AI) journaling is enabled; FALSE if disabled.
|-
| ALQ || Integer || Allocation quantity.
|-
| BDT || String || [[Backup]] date/time.
|-
| BI || String || TRUE if before-image (BI) journaling is enabled; FALSE if disabled.
|-
| BKS || Integer || Bucket size.
|-
| BLS || Integer || Block size.
|-
| CBT || String || TRUE if contiguous-best-try; otherwise FALSE.
|-
| CDT || String || Creation date/time.
|-
| CTG || String || TRUE if contiguous; otherwise FALSE.
|-
| DEQ || Integer || Default extension quantity.
|-
| DID || String || Directory ID string.
|-
| DIRECTORY || String || Returns TRUE or FALSE. Returns TRUE if it is a directory.
|-
| DVI || String || [[Device name]] string.
|-
| EDT || String || Expiration date/time.
|-
| EOF || Integer || Number of blocks used.
|-
| ERASE || String || TRUE if a file's contents are erased before a file is deleted; otherwise FALSE.
|-
| FFB || Integer || First free byte.
|-
| FID || String || File ID string.
|-
| FILE_LENGTH_HINT || String || Record count and data byte count in the form (
|-
| FSZ || Integer || Fixed control area size.
|-
| GBC || Integer || Global buffer count.
|-
| GBC32 || Integer || Enhanced longword version of global buffer count with a per-file maximum size of about 2.1 billion for indexed files.
|-
| GBCFLAGS || String || Per-file management flags for sizing of global buffer cache. Returns PERCENT if global buffer count is expresses as a percent, DEFAULT if global buffer size is determined at runtime by an algorithm using two global buffer SYSGEN parameters (GB_CACHEALLMAX and GB_DEFPERCENT); or NONE if no per-file management flags are enabled for the file.
|-
| GRP || Integer || Owner group number.
|-
| JOURNAL_FILE || String || TRUE if the file is a journal; otherwise FALSE.
|-
| KNOWN || String || Known file; returns TRUE or FALSE to indicate whether file is installed with the Install utility (INSTALL). However, returns NOSUCHFILE if a file does not exist (for example, the file has been installed but subsequently deleted).
|-
| LOCKED || String || TRUE if a file is deaccessed-locked; otherwise FALSE.
|-
| LRL || Integer || Longest record length.
|-
| MBM || Integer || Owner [[UIC|member number]].
|-
| MOVE || String || TRUE if movefile operations are enabled; otherwise FALSE.
|-
| MRN || Integer || Maximum record number.
|-
| MRS || Integer || Maximum record size.
|-
| NOA || Integer || Number of areas.
|-
| NOBACKUP || String || FALSE if the file is marked for backup; TRUE if the file is marked NOBACKUP.
|-
| NOK || Integer || Number of keys.
|-
| ORG || String || [[File organization]]; returns SEQ, REL, IDX.
|-
| PRESHELVED || String || TRUE if the file is preshelved; otherwise FALSE.
|-
| PRO || String || File [[UIC protection|protection string]].
|-
| PVN || Integer || Prolog version number.
|-
| RAT || String || Record attributes; returns CR, PRN, FTN, "".
|-
| RCK || String || TRUE if read check; otherwise FALSE.
|-
| RDT || String || Revision date/time.
|-
| RFM || String || [[Record format]] string; returns the values VAR, FIX, VFC, UDF, STM, STMLF, STMCR.
|-
| RU || String || TRUE if recovery unit (RU) journaling is enabled; returns TRUE or FALSE.
|-
| RVN || Integer || Revision number.
|-
| SHELVABLE || String || TRUE if the file is shelvable; otherwise FALSE.
|-
| SHELVED || String || TRUE if the file is shelved; otherwise FALSE.
|-
| STORED_SEMANTICS || String || ASCII string that represents stored semantics.
|-
| UIC || String || Owner [[UIC|user identification code]] (UIC) string.
|-
| VERLIMIT || Integer || [[File version|Version]] limit number. The value 32767 indicates that no version limit was set.
|-
| WCK || String || TRUE if write check; otherwise FALSE.
|}

=Examples=

<pre>$ FILE_ORG = F$FILE_ATTRIBUTES("QUEST.DAT","ORG")
$ SHOW SYMBOL FILE_ORG
FILE_ORG = "SEQ"

$ RFM = F$FILE_ATTRIBUTES("KANSAS::USE$:[CARS]SALES.CMD","RFM")
$ SHOW SYMBOL RFM
RFM = "VAR"
</pre>

F$FILE ATTRIBUTES() - Revision history

Jane.doe at 05:10, 15 December 2019

Darya.zelenina at 05:47, 15 January 2019

Maxim Megalinskiy: Changed the horizontal alignment of the text in the Return Type column

Darya.zelenina: Created page with "'''F$FILE_ATTRIBUTES()''' is a lexical function that returns attribute information for a specified file. =Format= F$FILE_ATTRIBUTES (filespec,item) ==..."