VSI OpenVMS Wiki - User contributions [en]

SET FILE

2021-08-26T23:38:03Z

Puder: Minor wording adjustment to get "date" also in the description field of MODDATE. Also spelling correction.

'''SET FILE''' is a [[DCL]] command that modifies file characteristics.

=Syntax=
SET FILE filespec

=Qualifiers=

* '''/ATTRIBUTE=(file-attribute[,...])''' sets the attributes associated with a file. The following table lists possible keywords and the relationship to both ACP-QIO and OpenVMS RMS File attributes:

{| class="wikitable"
! colspan="col" | Keyword
! colspan="col" | ACP_QIO File Attribute
! colspan-"col" | OpenVMS RMS File Attribute
! colspan="col" | Description
|-
| ATTDATE=date
| FAT$C_ATTDATE
| XAB$Q_ATT
| attribute modification date
|-
| ACCDATE=date
| FAT$C_ACCDATE
| XAB$Q_ACC
| file access date
|-
| BAKDATE=date
| FAT$C_BAKDATE
| XAB$Q_BDT
| backup date
|-
| BKS:value
| FAT$B_BKTSIZE=byte
| FAB$B_BKS=byte
| bucket size
|-
| CREDATE=date
| FAT$C_CREDATE
| XAB$Q_CDT
| creation date
|-
| DEQ:value
| FAT$W_DEFEXT=word
| FAB$W_DEQ=word
| default extend quantity
|-
| EBK:value
| FAT$L_EFBLK=longword
| XAB$L_EBK=longword
| end of file VBN
|-
| EXPDATE=date
| FAT$C_EXPDATE
| XAB$Q_EDT
| expiration date
|-
| FFB:value
| FAT$W_FFBYTE=word
| XAB$W_FFB=word
| first free byte in FAT$L_EFBLK
|-
| FSZ:value
| FAT$B_VFCSIZE=byte
| FAB$B_FSZ=byte
| size in bytes of fixed-length control for VFC records
|-
| GBC:value
| FAT$W_GBC=word
| FAB$W_GBC=word
| global buffer count
|-
| HBK:value
| FAT$L_HIBLK=longword
| XAB$L_HBK=longword
| highest allocated VBN
|-
| LRL:value
| FAT$W_RSIZE=word
| XAB$W_LRL=word
| record size
|-
| MODDATE=date
| FAT$C_MODDATE
| XAB$Q_MOD
| date of the last time data was modified
|-
| MRS:value
| FAT$W_MAXREC=word
| FAB$W_MRS=word
| maximum record size
|-
| ORG:IDX
| FAT$V_FILEORG=FAT$C_INDEXED
| FAB$B_ORG=FAB$C_IDX
| indicates that the file is indexed
|-
| ORG:REL
| FAT$V_FILEORG=FAT$C_RELATIVE
| FAB$B_ORG=FAB$C_REL
| indicates that the file is relative
|-
| ORG:SEQ
| FAT$V_FILEORG=FAT$C_SEQUENTIAL
| FAB$B_ORG=FAB$C_SEQ
| indicates that the file is sequential
|-
| RAT:BLK
| FAT$B_RATTRIB=FAT$M_NOSPAN
| FAB$B_RAT=FAB$M_BLK
| indicates that the file does not have spanned records
|-
| RAT:CR
| FAT$B_RATTRIB=FAT$M_IMPLIEDCC
| FAB$B_RAT=FAB$M_CR
| indicates that the file has implied carriage control
|-
| RAT:FTN
| FAT$B_RATTRIB=FAT$M_FORTRANCC
| FAB$B_RAT=FAB$M_FTN
| indicates that the file has Fortran carriage control
|-
| RAT:MSB
| FAT$B_RATTRIB=FAT$M_MSBVAR
| FAB$B_RAT=FAB$M_MSB
|
|-
| RAT:NONE
| FAT$B_RATTRIB=0
| FAB$B_RAT=0
| indicates that no record attributes are specified
|-
| RAT:PRN
| FAT$B_RATTRIB=FAT$M_PRINTCC
| FAB$B_RAT=FAB$M_PRN
| indicates that the file has print file carriage control
|-
| REVDATE=date
| FAT$C_REVDATE
| XAB$Q_RDT
| revision date and time
|-
| RFM:FIX
| FAT$V_RTYPE=FAT$C_FIXED
| FAB$B_RFM=FAB$C_FIX
| indicates that record type is fixed-length
|-
| RFM:STM
| FAT$V_RTYPE=FAT$C_STREAM
| FAB$B_RFM=FAB$C_STM
| indicates that the file is in RMS stream format
|-
| RFM:STMCR
| FAT$V_RTYPE=FAT$C_STREAMCR
| FAB$B_RFM=FAB$C_STMCR
| indicates that the file is in RMS stream terminated by CR format
|-
| RFM:STMLF
| FAT$V_RTYPE=FAT$C_STREAMLF
| FAB$B_RFM=FAB$C_STMLF
| indicates that the file is in RMS stream terminates by LF format
|-
| RFM:UDF
| FAT$V_RTYPE=FAT$C_UNDEFINED
| FAB$B_RFM=FAB$C_UDF
| indicates that the file is in undefined record format (stream binary)
|-
| RFM:VAR
| FAT$V_RTYPE=FAT$C_VARIABLE
| FAB$B_RFM=FAB$C_VAR
| indicates that the record type is variable-length
|-
| RFM:VFC
| FAT$V_RTYPE=FAT$C_VFC
| FAB$B_RFM=FAB$C_VFC
| indicates that the record type is variable-length fixed control
|-
| VRS:value
| FAT$W_VERSIONS=word
| XAB$W_VERLIMIT=word
| default version limit (valid only if the file is a directory)
|}
* '''/[NO]BACKUP specifies whether the [[BACKUP]] utility records the contents of the file. '''/NOBACKUP''' causes only the attributes of the file to be recorded, but not its contents; this is usually used for system files such as [[INDEXF.SYS]] or [[Page File|page]] and [[Swap File|swap]] files. This qualifier is valid only for [[ODS-2]] and [[ODS-5]] files.
* '''/BEFORE[=time]''' selects only the files dated prior to the specified date. See the full description of this qualifier in the [[BEFORE Qualifier|dedicated article]].
* '''/BY_OWNER[=uic]''' selects only those files whole owner [[UIC]] matches the specified UIC. The default is the UIC of the current process.
* '''/CACHING_ATTRIBUTE=keyword''' controls the default caching option used by the [[XFC|Extended File Cache]] when an application accesses the file without specifying which caching option it wants to use on this file or, if the file is a [[Directory File|directory file]], which caching option will be inherited by new files and subdirectories created in this directory. The keywords are:
** WRITETHROUGH: the file should be cached
** NO_CACHING: the file should not be cached
* '''/[NO]CONFIRM''' controls whether a request is issued before each SET FILE operation to confirm whether the operation should be performed on each particular file. See [[CONFIRM Qualifier]] for a full description of this qualifier.
* '''/CREATED''': see '''/BEFORE''' or '''/SINCE'''.
* '''/DATA_CHECK[=([NO]READ,[NO]WRITE)]''' specifies whether a read data check (rereading each record), a write data check (reading each record after it is written), or a combination of the two is performed on the file during transfers. By default, a write data check is performed.
* '''/END_OF_FILE''' resets the end-of-file (EOF) mark to the highest block allocated.
* '''/ENTER=new-filespec''' creates an [[Alias|alias]] or a [[Hardlink|hardlink]] for the file.
* '''/ERASE_ON_DELETE''' specifies that the specified files are explicitly erased from the disk when removed with the [[DELETE]] or [[PURGE]] command.
* '''/EXCLUDE=(filespec[,...])''' excludes the specified file from the operation. See [[EXCLUDE Qualifier]] for a full description of this qualifier.
* '''/[NO]EXPIRATION_DATE[=date]''' controls whether an expiration date is assigned to specific files. Expiration date is used to protect files from overwriting: to overwrite an unexpired file, you will have to specify /OVERRIDE=EXPIRATION when you [[MOUNT Utility|mount]] the volume. Requires Read, Write, and Control [[UIC Protection|access]] to the file. Date should be specified as [[Absolute Time|absolute time]]; absolute time keywords are allowed. If you specify 0 as the date, today's date is used.
* '''/EXTENSION[=n]''' sets the extend quantity default for the file, the number of blocks to extend a sequential file. The value of n can range from 0 to 65,535. If you omit the value specification or specify a value of 0, OpenVMS Record Management Services (OpenVMS RMS) calculates its own value for the /EXTENSION qualifier.
* '''/[NO]GLOBAL_BUFFER[=keyword[=n]]''' sets the [[RMS]] global buffer count (the number of buffers that can be shared by processes accessing the file) for the specified files. The keywords are:
** COUNT=n specifies the longword count of the number of global buffers
** PERCENT=p specifies the size of the global cache as percent of the total number of blocks currently used in the file.
** DEFAULT requests RMS at runtime to recalculate the global cache size based on an algorithm that makes use of two global buffer [[SYSGEN]] parameters, [[GB_CACHEALLMAX]] and [[GB_DEFPERCENT]].
* '''/MODIFIED''' modifies the time value specified with '''/BEFORE''' or '''/SINCE'''. See [[BEFORE Qualifier]] or [[SINCE Qualifier]] for more information.
* '''/[NO]MOVE''' controls whether movefile operations are enabled on the specified volume. When you create a file, movefile operations are enabled on that file. You should disable movefile operations on specialized files that are accessed other than through the XQP (such as files accessed through logical I/O to a disk). Note that movefile operations are automatically disabled on critical system files. Do not enable movefile operations on these files.
* '''/NODIRECTORY''' removes the directory attributes of a file, which allows you to delete the file even if other files are contained in the directory. Requires [[SYSPRV]].
* '''/REMOVE''' allows you to remove [[Alias|aliases]] and [[Hardlink|hardlinks]].
* '''/SHARE''' allows you to enable or disable global buffers or statistics on a file currently being accessed by other users. Requires [[SYSPRV]].
* '''/[NO]SHELVABLE''' controls whether the file is shelvable.
* '''/SINCE''' selects only those files dated on or after the specified time. See [[SINCE Qualifier]] for a full description of this qualifier.
* '''[NO]STATISTICS''' enables the gathering of RMS statistics on the specified file. These statistics can then be viewed by using the Monitor utility, which is invoked with the [[DCL]] command [[MONITOR]]. The SET FILE/STATISTICS command applies an application ACE to the specified file. The ACE does not affect access control and is only meaningful to the application assigning it.
* '''/STYLE=keyword''' spcifies the file name format for display purposes. The valid keywords are:
** CONDENSED (default) displays a file name representation of what is generated to fit into a 255-length characters string. The filename may contain a DID or FID abbreviation in the file specification.
** EXPANDED displays the file name representation of what is stored on the disk. This filename does not contain any DID or FID abbreviations.
* '''/[NO]SYMLINK''' indicates whether the symbolic link is set. If an input file is a symbolic link, the file referred to by the symbolic link is the file that is set.
* '''/TRUNCATE''' truncates the file at the end of the block containing the end-of-file (EOF) marker, that is, the qualifier releases allocated but unused blocks of the file.
* '''/UNLOCK''' clears a file marked as deaccess locked. Deaccess locking is required by and used by those few applications that maintain their own locking and consistency, typically without the use of the OpenVMS distributed lock manager, and potentially also without the use of RMS. When an application using deaccess locking does not correctly deaccess the file (often due to an application or system failure), the file is marked as locked, and is thus inaccessable until the integrity of the contents of the file are verified and the [[SET FILE]]/UNLOCK command is used. This command does not affect the state of files that are locked using RMS or the distributed lock manager.
* '''/VERSION_LIMIT[=n]''' specifies the maximum number of [[File version|versions]] for the specified file. No value specified or 0 means that the version number is only limited by the [[Files-11] architectural limit of 32,767.

=See also=
* [https://vmssoftware.com/docs/VSI_DCL_DICT_VOL_II.pdf OpenVMS DCL Dictionary]
* [https://vmssoftware.com/docs/VSI_System_Security_Manual.pdf OpenVMS Guide to System Security]
* [https://vmssoftware.com/docs/VSI_IO_REF.pdf I/O User's Reference Manual]

Talk:F$SEARCH()

2020-10-09T17:38:32Z

Puder: Created page with "The second example that searches both *.COM and *.DAT is not very sensible. The loop will only terminate when the searches simultaneously find no more files. If one runs out b..."

The second example that searches both *.COM and *.DAT is not very sensible. The loop will only terminate when the searches simultaneously find no more files. If one runs out before the other, it will start over on the next loop and keep finding the same files again.

--[[User:Puder|Puder]] ([[User talk:Puder|talk]]) 17:38, 9 October 2020 (UTC)
----

F$TYPE

2020-10-09T17:32:07Z

Puder: /* Examples */ Added an example for an undefined symbol. Removed spurious prompt text from VMS HELP.

'''F$TYPE''' is a [[Lexical functions|lexical function]] that returns the data type of a symbol. The string INTEGER is returned if the symbol is equated to an integer, or if the symbol is equated to a string whose characters form a valid integer. The string STRING is returned if the symbol is equated to a character string whose characters do not form a valid integer. If the symbol is undefined, a null string ("") is returned.

=Syntax=

F$TYPE(symbol-name)

=Return Value=

The string INTEGER is returned if the symbol is equated to an integer, or if the symbol is equated to a string whose characters form a valid integer.

If the symbol has been produced by a call to the [[F$CONTEXT]] function with a context type of PROCESS or by a call to the [[F$PID]] function, the string returned is PROCESS_CONTEXT. A symbol retains this type until [[F$CONTEXT]] is called with the symbol and the CANCEL keyword, or until a null string ("") is returned by a call to F$PID. Similarly, the return value is the string CLUSTER_SYSTEM_CONTEXT for symbols created by the F$CSID function. If the symbol is a context symbol, then the return value will be one of the types shown in the following table.

{|class="wikitable"
! colspan="col" | Symbol Type
! colspan="col" | Lexical Creating Symbol
|-
| PROCESS_CONTEXT
| F$PID or F$CONTEXT (with PROCESS context type)
|-
| CLUSTER_SYSTEM_CONTEXT
| [[F$CSID]]
|}

=Arguments=

==symbol-name==
Specifies the name of the symbol to be evaluated.

=Examples=

$ NUM = "52"
$ TYPE = F$TYPE(NUM)
$ SHOW SYMBOL TYPE
TYPE = "INTEGER"

This example uses the F$TYPE function to determine the data type of the symbol NUM. NUM is equated to the character string "52". Because the characters in the string form a valid integer, the F$TYPE function returns the string INTEGER.

$ NUM = 52
$ TYPE = F$TYPE(NUM)
$ SHOW SYMBOL TYPE
TYPE = "INTEGER"

In this example, the symbol NUM is equated to the integer 52. The F$TYPE function shows that the symbol has an integer data type.

$ CHAR = "FIVE"
$ TYPE = F$TYPE(CHAR)
$ SHOW SYMBOL TYPE
TYPE = "STRING"

In this example, the symbol CHAR is equated to the character string FIVE. Because the characters in this string do not form a valid integer, the F$TYPE function shows that the symbol has a string value.

$ x = F$CONTEXT("PROCESS",CTX,"USERNAME","SMITH")
$ TYPE = F$TYPE(CTX)
$ SHOW SYMBOL TYPE
TYPE = "PROCESS_CONTEXT"
$ x = F$CONTEXT("PROCESS",CTX,"CANCEL")
$ TYPE = F$TYPE(CTX)
$ SHOW SYMBOL TYPE
TYPE = ""

In this example, the F$TYPE function returns the string PROCESS_CONTEXT because the symbol has been produced by a call to the F$CONTEXT function with a context type of PROCESS. The symbol returns this type until F$CONTEXT is called with the symbol and the selection-item argument value CANCEL.

$ TYPE = F$TYPE(UNDEF)
$ SHOW SYMBOL TYPE
TYPE = ""

This example uses the F$TYPE function to determine that the symbol UNDEF is undefined. Because the symbol has not been set to a value, the F$TYPE function returns the empty string.

[[Category:Lexical Functions]]

F$GETENV()

2020-10-09T17:10:21Z

Puder: Added missing quote marks on arguments.

'''F$GETENV''' is a [[Lexical functions|lexical function]] that returns the value of the specified console environment variable (valid on [[Alpha]] systems only).

=Syntax=

F$GETENV(itmlst)

=Return Value=

Returns the value of the specified console environment variable. You can modify the console environment variables when the system is in console mode. This lexical function allows you to read the contents of these variables when the system is running.

=Arguments=

==itmlst==
The defined console environment variable names are:
* Auto_action
* Boot_dev
* Bootdef_dev
* Booted_dev
* Boot_file
* Booted_file
* Boot_osflags
* Booted_osflags
* Boot_reset
* Dump_dev
* Enable_audit
* License
* Char_set
* Language
* Tty_dev

=Examples=

$ dump_device = f$getenv("dump_dev")
$ write sys$output "The dump device for this system is ", dump_ device

This function writes out the dump device for the system.

$ a = f$getenv("auto_action")
$ show sym a
A = "BOOT"

In this example, the auto action is displayed.

$ a = f$getenv("boot_dev")
$ show sym a
A = "SCSI 0 6 0 0 0 0 0"

In this example, the boot device is displayed.

$ a = f$getenv("bootdef_dev")
$ show sym a
A = "SCSI 0 6 0 0 0 0 0"

In this example, the default boot device is displayed.

$ a = f$getenv("booted_dev")
$ show sym a
A = "SCSI 0 6 0 0 0 0 0"

In this example, the current boot device is displayed.

$ a = f$getenv("boot_osflags")
$ show sym a
A = "0"

In this example, the boot flags are displayed.

$ a = f$getenv("boot_reset")
$ show sym a
A = "OFF"

In this example, the status of boot reset is displayed.

$ a = f$getenv("enable_audit")
$ show sym a
A = "ON"

This shows whether audit is enabled.

[[Category:Lexical Functions]]