VSI OpenVMS Wiki - User contributions [en]

Main Page

2019-05-29T09:42:56Z

Maxim Megalinskiy:

{| style="float:left;vertical-align:top;background-color:white;"
|
{| class="wikitable"
! style="text-align:center; background-color:#2758AA;color:white;height:50px;width:1200px;" | <big>Introduction</big>
|-
| style="text-align:left;height:50px;width:1200px;"| <big>About this wiki</big>

VSI OpenVMS wiki is the world's biggest encyclopedia entirely dedicated to the OpenVMS operating system.
The purpose of the project is to consolidate and organize information about this operating system and create an easily searcheable reference base to answer any questions about it. Ultimately, this encyclopedia should contain basic information on common features of OpenVMS and operations frequently performed by programmers and system managers using this system as well as links to the current documentation. The wiki model used to create this encyclopedia allows any registered user to write an article or suggest changes to an existing article, thus maximizing the number of contributions and maintaining the integrity and neutrality of the data.
To date, our wiki has {{NUMBEROFARTICLES}} articles. View the full list [[Special:AllPages|here]] or use the search box in the top right corner to search this wiki. Or, if you are feeling adventurous, visit [[Special:Random|a random page]].

<big>About OpenVMS</big>

OpenVMS is an operating system created in 1977 by the Digital Equipment Corporation and still widely used by large companies in the military, healthcare, banking, telecommunications and other industries. It is primarily known for its security and unrivaled clustering capabilities. It currently supports VAX, Alpha, and Itanium architectures and is working on a port to x86.
|}
|-
|
{| class="wikitable"
|-
! scope='col'; style="text-align:center;height:50px;width:1200px;background-color:#2758AA;color:white;" | <big>Categories</big>
|-
| style=text-align:left;height:50px;width:1200px;" |
* [[:Category:Architectures|Architectures]]
* [[:Category:Lexical Functions|Lexical Functions]]
* [[:Category:Security|Security]]
* [[:Category:User Management|User Management]]
* [[:Category:Volume Management|Volume Management]]
* [[:Category:System Files|System Files]]
* [[:Category:Disk Quota|Disk Quota]]
* [[:Category:Password|Password]]
* [[:Category:Startup Command Procedures|Startup Command Procedures]]
[[Special:AllPages|Browse all articles]]
|}
|}

{| style="float:right;vertical-align:top;background-color:white;"
|
{| class="wikitable"
! scope='col' style="height:50px; width:400px; text-align:center;background-color:#2758AA;color:white;" | <big>Article of the day</big>
|-
| style="height:50px; width:400px; text-align:left;" | <big>'''BADBLK.SYS'''</big>
'''BADBLK.SYS''' is a system file that resides in the master file directory of a Files-11 volume. This file contains all the bad blocks on the volume. The system detects bad disk blocks dynamically and prevents their reuse once the files to which they are allocated have been deleted.
[[BADBLK.SYS|Read more]]
|}
|-
|
{| class="wikitable"
! colpan="3" style="height:50px; width:400px; text-align:center;background-color:#2758AA;color:white;" | <big>Resources</big>
|-
| style="height:50px; width:400px; text-align:left;" |
* [https://en.wikipedia.org/wiki/Help:Wikitext| Wiki guidelines]
* [http://vmssoftware.com/| VMS Software Inc.]
* [http://vmssoftware.com/products_doc_hp_legacy.html| OpenVMS Documentation]
|}
|-
|
{| class="wikitable"
! colpan="3" style="height:50px; width:400px; text-align:center;background-color:#2758AA;color:white;" | <big>Did you know...</big>
|-
| style="height:50px; width:400px; text-align:left;" |
* that you could use angle brackets (<>) instead of square brackets ([]) in DCL [[File specification|directory specifications]]?
* that the maximum value of the [[LGI parameters|LGI_HID_TIM]] parameter which specifies how long OpenVMS does not let intruders log in to the system is 1261440000 seconds, or 40 years?
* that a [[Label|label]] name can contain a maximum of 255 characters?
|}
|}

{| class="wikitable" style="background-color:white;float:bottom;style=height:100px;width:1680px;"
! scope="col" colspan="3" style="height:50px; width:1680px; text-align:center;" | <big>You can help</big>
|-
| colspan="3" style="height:50px; width:1680px;text-align:left; |Please help this wiki become the most informative and reliable source of information on OpenVMS!
To help the project, you can:
* [[How to write an article|write new articles]]
* [[How to edit an article|expand and edit existing articles]]
* add links to dead end pages
* add pages to categories
* translate this wiki to your language and more.
To get editing access to this wiki, log in by clicking the button above. If you don't have an account or see a registration link, please contact training@vmssoftware.com for a registration.
|}

{| style="background-color:white;float:bottom;style=height:100px;width:1680px;"
|
{| class="wikitable"
! scope='col' style="height:50px; width:400px; text-align:center;" | <big>Write</big>
|-
| style="height:50px; width:400px; text-align:left;" | You can help the project by writing the following articles:
* [[Integrity]]
* [[ODS-5]]
* [[Detached process]]
* [[MONITOR]]
* [[DECnet Phase IV‏‎]]
[[Special:WantedPages|See all wanted pages]]
|}
|
{| class="wikitable"
! scope='col' style="height:50px; width:400px; text-align:center;" | <big>Add</big>
|-
| style="height:50px; width:400px; text-align:left;" | You can help the project by expanding the following articles:
* [[‎INDEXF.SYS]]
* [[‎SETPRV]]
* [[‎ADDUSER.COM]]
* [[‎BADLOG.SYS]]
* [[BADBLK.SYS]]
[[Special:ShortPages|See all short pages]]
|}
|
{| class="wikitable"
! scope='col' style="height:50px; width:400px; text-align:center;" | <big>Edit</big>
|-
| style="height:50px; width:400px; text-align:left;" | You can help the project by editing the following articles:
* [[Audit ACE]]
* [[Identifier ACE]]‏‎
* [[ACE‏‎]]
* [[BADBLK.SYS‏‎]]
* [[Default directory‏‎]]
[[Special:FewestRevisions|See all nonrevised pages]]
|}
|
{| class="wikitable"
! scope='col' style="height:50px; width:400px; text-align:center;" | <big>Categorize</big>
|-
| style="height:50px; width:400px; text-align:left;" | You can help the project by categorizing the following articles:
* [[$GETQUI output item codes]]
* [[ACE]]
* [[ACL]]
* [[ACP DATACHECK]]
* [[ACP SWAPFLGS]]
[[Special:UncategorizedPages|See all uncategorized pages]]
|}
|}

User talk:Maxim Megalinskiy

2019-05-28T12:46:00Z

Maxim Megalinskiy: Blanked the page

MediaWiki:Sidebar

2019-05-28T08:31:36Z

Maxim Megalinskiy:

MediaWiki:Sidebar

2019-05-28T08:30:17Z

Maxim Megalinskiy:

MediaWiki:Sidebar

2019-05-28T08:27:51Z

Maxim Megalinskiy:

MediaWiki:Sidebar

2019-05-28T08:27:13Z

Maxim Megalinskiy:

MediaWiki:Sidebar

2019-05-28T08:26:42Z

Maxim Megalinskiy:

MediaWiki:Sidebar

2019-05-28T08:26:13Z

User:Maxim Megalinskiy

2019-05-21T09:55:19Z

Maxim Megalinskiy: Blanked the page

User talk:Maxim Megalinskiy

2019-04-17T11:19:57Z

Maxim Megalinskiy: Blanked the page

User talk:Darya.zelenina

2019-04-17T11:19:24Z

Maxim Megalinskiy:

test
response
Test again

User talk:Maxim Megalinskiy

2019-04-17T10:01:25Z

Maxim Megalinskiy: Reverted edits by Maxim Megalinskiy (talk) to last revision by Darya.zelenina

test test

User talk:Maxim Megalinskiy

2019-04-17T09:48:03Z

Maxim Megalinskiy: Blanked the page

User talk:Darya.zelenina

2019-04-17T09:44:58Z

Maxim Megalinskiy: Created page with "Random test"

Random test

Lexical functions

2018-10-19T12:32:45Z

Maxim Megalinskiy: /* String operations */

'''Lexical''' functions are constructs that return information about your OpenVMS system and arithmetic and string expressions and perform other functions. There are 43 lexical functions in OpenVMS 8.4-L2.

=Format=

F$function-name([args,...])

Note that you must use the brackets even if no arguments are required. Sometimes it is required to specify an empty string ("") as an argument, and sometimes they follow a specific order and you need to keep the commas in place if you omit certain arguments.

=Lexical functions by topic=

Lexical functions serve a number of purposes: unit, data type, datetime conversion, returning information about system objects and establishing context for such information, etc.

==Conversion and data types==
* [[F$STRING()]] returns the string equivalent of the result of the specified expression.
<pre>$ write sys$output f$string(5)
5</pre>
* [[F$INTEGER()]] returns the integer equivalent of the result of the specified expression.
<pre>$ write sys$output f$integer("y")
1
$ write sys$output f$integer("a")
0</pre>
* [[F$IDENTIFIER()]] converts an identifier in named format to its integer equivalent, or vice versa.
<pre>$ WRITE SYS$OUTPUT F$IDENTIFIER("SLOANE","NAME_TO_NUMBER")
15728665</pre>
* [[F$CUNITS]] converts a number from one specified unit of measure to another.
* [[F$CVUI]] extracts bit fields from character string data and converts the result, as an unsigned value, to an integer.
* [[F$CVSI()]] extracts bit fields from character string data and converts the result, as a signed value, to an integer.
* [[F$TYPE]] determines the data type of a symbol

==String operations==
* [[F$LOCATE()]] locates a character or character substring within a string and returns its offset within the string.

<pre>$ WRITE SYS$OUTPUT F$LOCATE("E","HELLO")
1</pre>

* [[F$LENGTH()]] returns the length of a specified string.

<pre>$ WRITE SYS$OUTPUT F$LENGTH("HELLO")
5</pre>

* [[F$FAO()]] converts the specified control string to a formatted ASCII output string.

<pre>$ WRITE SYS$OUTPUT F$FAO("!5SL !5UB !5SL",-1,2,"pcs")
-1 2 pcs

$ REPORT = F$FAO("There !0UL!1%Cis!%Eare!%F !-!UL !-!0UL!1%Cchild!%Echildren!%F here",OFFSPRING)
$ SHOW SYMBOL REPORT
$ REPORT ="There is 1 child here"
</pre>
* [[F$EXTRACT()]] extracts a substring from a character string expression.

<pre>$ WRITE SYS$OUTPUT F$EXTRACT("1",2,"HELLO")
EL
</pre>
* [[F$ELEMENT()]] extracts an element from a string in which the elements are separated by a specified delimiter.

<pre>$ WRITE SYS$OUTPUT F$ELEMENT(0,"/","1/2/3")
1</pre>

* [[F$EDIT()]] edits a character string based on the edits specified (upcases, removes spaces and comments).

<pre>$ WRITE SYS$OUTPUT F$EDIT(" HELLO ","COLLAPSE,LOWERCASE")
hello</pre>

==Files==
* [[F$SEARCH()]] looks for the file you specify
* [[F$PARSE()]] invokes the $PARSE RMS service to parse a file specification and return either the expanded file specification or the particular file specification field that you request.
* [[F$FILE_ATTRIBUTES()]] returns attribute information for a specified file.
* [[F$FID_TO_NAME()]] translates a file identification to a [[File specification|file specification]].

==Processes==
* [[F$CONTEXT]] specifies selection criteria for use with the F$PID function.
* [[F$GETJPI]] returns accounting, status, and identification information for a process.
* [[F$PID()]] for each invocation, returns the next [[PID|process identification number]] in sequence.

==Devices==
* [[F$DEVICE()]] returns device names of all [[Device|devices]] on a system that meet the specified selection criteria.
* [[F$GETDVI()]] returns information about a specified [[Device|device]].
* [[F$MULTIPATH()]] returns a specified item of information for a specific [[Multipath|multipath]]-capable device.

==Time==
* [[F$TIME()]] returns the current date and time of day, in the format dd-mmm-yyyy hh:mm:ss.cc.
* [[F$DELTA_TIME()]] returns the time difference between a given start and end time.
* [[F$CVTIME()]] retrieves information about an absolute, combination, or delta time string.

==System and cluster==
* [[F$GETSYI()]] returns status and identification information about the local system, or about a node in the local cluster, if your system is part of a cluster.
* [[F$CSID()]] returns an OpenVMS Cluster identification number and updates the context symbol to point to the current position in the system's cluster node list.

==Queues==
* [[F$GETQUI()]] returns information about queues, batch and print jobs currently in those queues, form definitions, and characteristic definitions kept in the queue database.

==Logical names==
[[F$TRNLNM()]] used for translating [[Logical names|logical names]] and obtaining their attributes.

==User environment==
* [[F$USER()]] returns the current user's [[UIC]]
* [[F$VERIFY()]] returns the integer 1 if command procedure verification is set on; returns the integer 0 if command procedure verification is set off. The F$VERIFY function also can set new verification states.
* [[F$PROCESS()]] returns the current process name string.
* [[F$MODE()]] shows the [[Mode of execution|mode]] in which a process is executing.
* [[F$MESSAGE()]] returns the message text associated with a specified system status code value.
* [[F$GETENV()]] returns the value of the specified console environment variable.
* [[F$ENVIRONMENT()]] obtains information about the DCL command environment.
* [[F$DIRECTORY()]] returns the current [[Default directory|default]] directory name string.
===Privileges===
* [[F$SETPRV()]] sets the specified [[User privileges|privileges]] and returns a list of keywords indicating the previous state of these privileges for the current process.
* [[F$PRIVILEGE()]] returns a value of TRUE or FALSE depending on whether your current process privileges match the privileges listed in the argument.

==Miscellaneous==
* [[F$MATCH_WILD()]] performs a wildcard matching between a candidate and a pattern string.
* [[f$LICENSE()]] checks whether the specified [[Licensing|license]] is loaded on the system.

Quick guide to F$FAO()

2018-09-13T10:48:46Z

Maxim Megalinskiy: Missing parenthesis

'''F$FAO()''' can be used to create good-looking formatted output including tables, dividers, numeric conversion, and more. The full list of F$FAO() control strings can be found in the [[F$FAO()|main article]].

=Choosing a control string=
{| class="wikitable"
|-
! You need to insert... !! Directive to use !! Example !! Result
|-
|a string||!AS||f$fao("Welcome back, !AS","John")||Welcome back, John
|-
|a singular/plural (more [[Quick guide to F$FAO()#Dealing with plurals|below]])||!%S||f$fao("I have !ZL apple!%S",5") f$fao("I have !ZL apple!%S",1")||I have 5 apples I have 1 apple
|-
| a number|| !SL|| f$fao("!SL",-112)|| -112
|-
|the current time||!%T||f$fao("It's !%T now",0)||It's 12:14:55.90 now
|-
|the current date/time||!%D||f$fao("It's !%D now",0)||It's 16-AUG-2018 12:15:02.28 now
|-
| a new line|| !/|| f$fao("hello !/ goodbye")|| <pre>$ write sys$output f$fao("hello !/goodbye") hello goodbye</pre>
|-
| a line of dashes/asterisks||!n*-||f$fao("!25*-!/")||-------------------------
|-
|put it in a field||!nDD||f$fao("Total: !20SL",73)||<pre>Total: 73</pre>
|}

* To insert an actual exclamation point, use two exclamation points:
<pre>$ write sys$output f$fao("Hello!!")
Hello!
</pre>

* Watch your argument types. If you use a wrong type of argument, such as an integer for !AS, you will get %SYSTEM-F-ACCVIO, access violation message.

=Dealing with plurals=

There is a special directive for English plurals (that are normally just -s): !%S. It inserts an "s" if the most recently
converted number is not 1:

<pre>$ write sys$output f$fao("I have !SL apple!%S",5)
I have 5 apples
$ write sys$output f$fao("I have !SL apple!%S",1)
I have 1 apple</pre>

There is also a different directive that lets you use other endings. For example, if you have the word "child", the regular "s" will not work there. Here's what you can use:

* '''!n%Cyour_ending''' inserts a character string (your_ending) when the most recently evaluated argument has the value n
* '''!%Eyour_ending''' inserts a character string (your_ending) when the most recently evaluated argument does not match any of the preceding !n%C directives.
* When you are done defining the forms of that single word, use the !%F directive to mark the end of the plurals statement.**

So, for the case with '''child''', you need the system to use no ending if the number is 1 and the ending "ren" if the number is anything but one:

<pre>$ write sys$output f$fao("I have !SL child!1%C !%Eren !%F",1)
I have 1 child
$ write sys$output f$fao("I have !SL child!1%C !%Eren !%F",5)
I have 5 children</pre>

Another example is offered by the online help on F$FAO:

<pre>REPORT = F$FAO("There !0UL!1%Cis!%Eare!%F !-!UL !-!0UL!1%Cchild!%Echildren!%F here",OFFSPRING)</pre>

Here's how this works for languages with multiple number forms. For example, let's count cats in Polish:

<pre>$ write sys$output f$fao("!SB kot!1%C !2%Cy !3%Cy !4%Cy !%Eow !%F",1)
1 kot
$ write sys$output f$fao("!SB kot!1%C !2%Cy !3%Cy !4%Cy !%Eow !%F",2)
2 koty
$ write sys$output f$fao("!SB kot!1%C !2%Cy !3%Cy !4%Cy !%Eow !%F",3)
3 koty
$ write sys$output f$fao("!SB kot!1%C !2%Cy !3%Cy !4%Cy !%Eow !%F",4)
4 koty
$ write sys$output f$fao("!SB kot!1%C !2%Cy !3%Cy !4%Cy !%Eow !%F",5)
5 kotow
$ write sys$output f$fao("!SB kot!1%C !2%Cy !3%Cy !4%Cy !%Eow !%F",6)
6 kotow
$ write sys$output f$fao("!SB kot!1%C !2%Cy !3%Cy !4%Cy !%Eow !%F",7)
7 kotow
</pre>

F$FAO()

2018-09-13T10:45:32Z

Maxim Megalinskiy: Some more formatting

'''F$FAO()''' converts character and numeric input to ASCII character strings. FAO stands for "formatted ASCII output".

=Format=

F$FAO (control-string[,argument[,...]])

'''Control strings''' tell the system what the resulting string should look like. The full list of control strings is presented below. 
'''Arguments''' (optional) are variables whose values to be used for the control string directives.

=Full list of control strings=

==Character string insertion==

{| class="wikitable"
|-
! Directive !! Value !! Description
|-
| style="text-align:center;" |!AS|| style="text-align:center;" | None || Inserts a character string as is: <pre>$ write sys$output f$fao("Welcome back, !AS","John")
Welcome back, John</pre>
|}

==Zero-filled numeric conversion==

{| class="wikitable"
|-
! Directive !! Value !! Description
|-
| style="text-align:center;" |!OB|| style="text-align:center;" | None || Converts a byte to octal notation: <pre>$ write sys$output f$fao("!OB",9)
011</pre>
|-
| style="text-align:center;" |!OW|| style="text-align:center;" | None || Converts a word to octal notation: <pre>$ write sys$output f$fao("!OW",9)
000011</pre>
|-
| style="text-align:center;" |!OL|| style="text-align:center;" | None || Converts a longword to octal notation: <pre>$ write sys$output f$fao("!OL",9)
00000000011</pre>
|-
| style="text-align:center;" |!XB|| style="text-align:center;" | None || Converts a byte to hexadecimal notation: <pre>$ write sys$output f$fao("!XB",15)
0F</pre>
|-
| style="text-align:center;" |!XW|| style="text-align:center;" | None || Converts a word to hexadecimal notation: <pre>$ write sys$output f$fao("!XW",15)
000F</pre>
|-
| style="text-align:center;" |!XL|| style="text-align:center;" | None || Converts a longword to hexadecimal notation: <pre>$ write sys$output f$fao("!XL",15)
0000000F</pre>
|-
| style="text-align:center;" |!ZB|| style="text-align:center;" | None || Converts a byte to decimal notation: <pre>$ write sys$output f$fao("!ZB",100)
100
$ write sys$output f$fao("!ZB",257)
1</pre>
|-
| style="text-align:center;" |!ZW|| style="text-align:center;" | None || Converts a word to decimal notation: <pre>$ write sys$output f$fao("!ZW",257)
257
$ write sys$output f$fao("!ZW",65536)
0</pre>
|-
| style="text-align:center;" |!ZL|| style="text-align:center;" | None || Converts a longword to decimal notation: <pre>$ write sys$output f$fao("!ZL",4294967296)
0</pre>
|}

==Blank-filled numeric conversion==

{| class="wikitable"
|-
! Directive !! Value !! Description
|-
| style="text-align:center;" |!UB || style="text-align:center;" | Integer || Converts a byte to decimal notation without adjusting for negative numbers: <pre>$ write sys$output f$fao("!UB",255)
255
$ write sys$output f$fao("!UB",256)
0
$ write sys$output f$fao("!UB",-1)
255</pre>
|-
| style="text-align:center;" |!UW|| style="text-align:center;" | None ||Converts a word to decimal notation without adjusting for negative numbers: <pre>$ write sys$output f$fao("!UW",-1)
65535
$ write sys$output f$fao("!UW",65536)
0</pre>
|-
| style="text-align:center;" |!UL|| style="text-align:center;" | None ||Converts a longword to decimal notation without adjusting for negative numbers: <pre>$ write sys$output f$fao("!UL",4294967296)
0
$ write sys$output f$fao("!UL",-1)
4294967295</pre>
|-
| style="text-align:center;" |!SB|| style="text-align:center;" | None ||Converts a byte to decimal notation with negative numbers converted properly: <pre>$ write sys$output f$fao("!SB",-1)
-1
$ write sys$output f$fao("!SB",256)
0
$ write sys$output f$fao("!SB",127)
127
$ write sys$output f$fao("!SB",128)
-128</pre>
|-
| style="text-align:center;" |!SW|| style="text-align:center;" | None ||Converts a word to decimal notation with negative numbers converted properly: <pre>$ write sys$output f$fao("!SW",32000)
32000
$ write sys$output f$fao("!SW",-32000)
-32000
$ write sys$output f$fao("!SW",64000)
-1536
$ write sys$output f$fao("!SW",65537)
1</pre>
|-
| style="text-align:center;" |!SL|| style="text-align:center;" | None ||Converts a longword to decimal notation with negative numbers converted properly: <pre>$ write sys$output f$fao("!SL",65537)
65537
$ write sys$output f$fao("!SL",4294967294)
-2</pre>
|}

==Special formatting==

{| class="wikitable"
|-
! Directive !! Value !! Description
|-
| style="text-align:center;" |!/|| style="text-align:center;" | None ||Inserts a carriage return and a line feed: <pre>$ write sys$output f$fao("Hello!/Goodbye")
Hello
Goodbye</pre>
|-
| style="text-align:center;" |!_|| style="text-align:center;" | None ||Inserts a tab: <pre>$ write sys$output f$fao("Hello!_Goodbye")
Hello Goodbye</pre>
|-
| style="text-align:center;" |!^|| style="text-align:center;" | None ||Inserts a form feed: <pre>$ write sys$output f$fao("Hello!^Goodbye")
Hello

Goodbye</pre>
|-
| style="text-align:center;" |!!|| style="text-align:center;" | None ||Inserts an exclamation point (!): <pre>$ write sys$output f$fao("Hello!!")
Hello!
$ write sys$output f$fao("Hello!")
%SYSTEM-F-BADPARAM, bad parameter value
\Hello!\</pre>
|-
| style="text-align:center;" |!%I (as in Irene) || style="text-align:center;" | None ||Converts a longword integer to a named UIC in the format [group-identifier,member-identifier].|
<pre>$ write sys$output f$fao("!%I",65540)
[SYSTEM]</pre>
|-
| style="text-align:center;" |!%S|| style="text-align:center;" | None ||Inserts an "s" if the most recently converted number is not 1. (Not recommended for use with multilingual products.)|
<pre>$ write sys$output f$fao("I have !SL apple!%S",5)
I have 5 apples
$ write sys$output f$fao("I have !SL apple!%S",1)
I have 1 apple</pre>
|-
| style="text-align:center;" |!%U|| style="text-align:center;" | None ||Converts a longword integer to a numeric UIC in the format [g,m], where g is the group number and m is the member number. The directive inserts the brackets and the comma.|
<pre>$ write sys$output f$fao("!%U",65540)
[1,4]]</pre>
|-
| style="text-align:center;" |!nx|| style="text-align:center;" | None ||Left-justifies and blank-fills all data represented by x in a field of n characters wide.|
<pre>$ write sys$output f$fao("!10SL",5)
5</pre>
|-
| style="text-align:center;" |!n* c|| style="text-align:center;" | None ||Repeats the character represented by c for n times.|
<pre>$ write sys$output f$fao("!5*a")
aaaaa</pre>
|-
| style="text-align:center;" |!n%C|| style="text-align:center;" | None || Inserts a character string when the most recently evaluated argument has the value n. (Recommended for use with multilingual products.) <pre>REPORT = F$FAO("There !0UL!1%Cis!%Eare!%F !-!UL !-!0UL!1%Cchild!%Echildren!%F here",OFFSPRING)</pre>
|-
| style="text-align:center;" |!%E|| style="text-align:center;" | None ||Inserts a character string when the value of the most recently evaluated argument does not match any preceding !n%C directives. (Recommended for use with multilingual products.) <pre>REPORT = F$FAO("There !0UL!1%Cis!%Eare!%F !-!UL !-!0UL!1%Cchild!%Echildren!%F here",OFFSPRING)</pre>
|-
| style="text-align:center;" |!%F|| style="text-align:center;" | None ||Marks the end of a plurals statement. <pre>REPORT = F$FAO("There !0UL!1%Cis!%Eare!%F !-!UL !-!0UL!1%Cchild!%Echildren!%F here",OFFSPRING)</pre>
|-
| style="text-align:center;" |!%T|| style="text-align:center;" | 0 ||Inserts the current time: <pre>$ write sys$output f$fao("It's !%T",0)
It's 12:54:00.68</pre>
|-
| style="text-align:center;" |!%D|| style="text-align:center;" | 0 ||Inserts the current date/time: <pre>$ write sys$output f$fao("It's !%D",0)
It's 16-AUG-2018 12:54:08.98</pre>
|}

=See also=
* [[Quick guide to F$FAO()]]

F$FAO()

2018-09-13T10:33:13Z

Maxim Megalinskiy: Formatting

'''F$FAO()''' converts character and numeric input to ASCII character strings. FAO stands for "formatted ASCII output".

=Format=

F$FAO (control-string[,argument[,...]])

'''Control strings''' tell the system what the resulting string should look like. The full list of control strings is presented below. 
'''Arguments''' (optional) are variables whose values to be used for the control string directives.

=Full list of control strings=

==Character string insertion==

{| class="wikitable"
|-
! Directive !! Value !! Description
|-
| !AS|| style="text-align:center;" | None || Inserts a character string as is: <pre>$ write sys$output f$fao("Welcome back, !AS","John")
Welcome back, John</pre>
|}

==Zero-filled numeric conversion==

{| class="wikitable"
|-
! Directive !! Value !! Description
|-
| !OB|| style="text-align:center;" | None || Converts a byte to octal notation: <pre>$ write sys$output f$fao("!OB",9)
011</pre>
|-
| !OW|| style="text-align:center;" | None || Converts a word to octal notation: <pre>$ write sys$output f$fao("!OW",9)
000011</pre>
|-
| !OL|| style="text-align:center;" | None || Converts a longword to octal notation: <pre>$ write sys$output f$fao("!OL",9)
00000000011</pre>
|-
| !XB|| style="text-align:center;" | None || Converts a byte to hexadecimal notation: <pre>$ write sys$output f$fao("!XB",15)
0F</pre>
|-
| !XW|| style="text-align:center;" | None || Converts a word to hexadecimal notation: <pre>$ write sys$output f$fao("!XW",15)
000F</pre>
|-
| !XL|| style="text-align:center;" | None || Converts a longword to hexadecimal notation: <pre>$ write sys$output f$fao("!XL",15)
0000000F</pre>
|-
| !ZB|| style="text-align:center;" | None || Converts a byte to decimal notation: <pre>$ write sys$output f$fao("!ZB",100)
100
$ write sys$output f$fao("!ZB",257)
1</pre>
|-
| !ZW|| style="text-align:center;" | None || Converts a word to decimal notation: <pre>$ write sys$output f$fao("!ZW",257)
257
$ write sys$output f$fao("!ZW",65536)
0</pre>
|-
| !ZL|| style="text-align:center;" | None || Converts a longword to decimal notation: <pre>$ write sys$output f$fao("!ZL",4294967296)
0</pre>
|}

==Blank-filled numeric conversion==

{| class="wikitable"
|-
! Directive !! Value !! Description
|-
| !UB || style="text-align:center;" | Integer || Converts a byte to decimal notation without adjusting for negative numbers: <pre>$ write sys$output f$fao("!UB",255)
255
$ write sys$output f$fao("!UB",256)
0
$ write sys$output f$fao("!UB",-1)
255</pre>
|-
|!UW|| style="text-align:center;" | None ||Converts a word to decimal notation without adjusting for negative numbers: <pre>$ write sys$output f$fao("!UW",-1)
65535
$ write sys$output f$fao("!UW",65536)
0</pre>
|-
|!UL|| style="text-align:center;" | None ||Converts a longword to decimal notation without adjusting for negative numbers: <pre>$ write sys$output f$fao("!UL",4294967296)
0
$ write sys$output f$fao("!UL",-1)
4294967295</pre>
|-
|!SB|| style="text-align:center;" | None ||Converts a byte to decimal notation with negative numbers converted properly: <pre>$ write sys$output f$fao("!SB",-1)
-1
$ write sys$output f$fao("!SB",256)
0
$ write sys$output f$fao("!SB",127)
127
$ write sys$output f$fao("!SB",128)
-128</pre>
|-
|!SW|| style="text-align:center;" | None ||Converts a word to decimal notation with negative numbers converted properly: <pre>$ write sys$output f$fao("!SW",32000)
32000
$ write sys$output f$fao("!SW",-32000)
-32000
$ write sys$output f$fao("!SW",64000)
-1536
$ write sys$output f$fao("!SW",65537)
1</pre>
|-
|!SL|| style="text-align:center;" | None ||Converts a longword to decimal notation with negative numbers converted properly: <pre>$ write sys$output f$fao("!SL",65537)
65537
$ write sys$output f$fao("!SL",4294967294)
-2</pre>
|}

==Special formatting==

{| class="wikitable"
|-
! Directive !! Value !! Description
|-
|!/|| style="text-align:center;" | None ||Inserts a carriage return and a line feed: <pre>$ write sys$output f$fao("Hello!/Goodbye")
Hello
Goodbye</pre>
|-
|!_|| style="text-align:center;" | None ||Inserts a tab: <pre>$ write sys$output f$fao("Hello!_Goodbye")
Hello Goodbye</pre>
|-
|!^|| style="text-align:center;" | None ||Inserts a form feed: <pre>$ write sys$output f$fao("Hello!^Goodbye")
Hello

Goodbye</pre>
|-
|!!|| style="text-align:center;" | None ||Inserts an exclamation point (!): <pre>$ write sys$output f$fao("Hello!!")
Hello!
$ write sys$output f$fao("Hello!")
%SYSTEM-F-BADPARAM, bad parameter value
\Hello!\</pre>
|-
|!%I (as in Irene) || style="text-align:center;" | None ||Converts a longword integer to a named UIC in the format [group-identifier,member-identifier].|
<pre>$ write sys$output f$fao("!%I",65540)
[SYSTEM]</pre>
|-
|!%S|| style="text-align:center;" | None ||Inserts an "s" if the most recently converted number is not 1. (Not recommended for use with multilingual products.)|
<pre>$ write sys$output f$fao("I have !SL apple!%S",5)
I have 5 apples
$ write sys$output f$fao("I have !SL apple!%S",1)
I have 1 apple</pre>
|-
|!%U|| style="text-align:center;" | None ||Converts a longword integer to a numeric UIC in the format [g,m], where g is the group number and m is the member number. The directive inserts the brackets and the comma.|
<pre>$ write sys$output f$fao("!%U",65540)
[1,4]]</pre>
|-
|!nx|| style="text-align:center;" | None ||Left-justifies and blank-fills all data represented by x in a field of n characters wide.|
<pre>$ write sys$output f$fao("!10SL",5)
5</pre>
|-
|!n* c|| style="text-align:center;" | None ||Repeats the character represented by c for n times.|
<pre>$ write sys$output f$fao("!5*a")
aaaaa</pre>
|-
|!n%C|| style="text-align:center;" | None || Inserts a character string when the most recently evaluated argument has the value n. (Recommended for use with multilingual products.) <pre>REPORT = F$FAO("There !0UL!1%Cis!%Eare!%F !-!UL !-!0UL!1%Cchild!%Echildren!%F here",OFFSPRING)</pre>
|-
|!%E|| style="text-align:center;" | None ||Inserts a character string when the value of the most recently evaluated argument does not match any preceding !n%C directives. (Recommended for use with multilingual products.) <pre>REPORT = F$FAO("There !0UL!1%Cis!%Eare!%F !-!UL !-!0UL!1%Cchild!%Echildren!%F here",OFFSPRING)</pre>
|-
|!%F|| style="text-align:center;" | None ||Marks the end of a plurals statement. <pre>REPORT = F$FAO("There !0UL!1%Cis!%Eare!%F !-!UL !-!0UL!1%Cchild!%Echildren!%F here",OFFSPRING)</pre>
|-
|!%T|| style="text-align:center;" | 0 ||Inserts the current time: <pre>$ write sys$output f$fao("It's !%T",0)
It's 12:54:00.68</pre>
|-
|!%D|| style="text-align:center;" | 0 ||Inserts the current date/time: <pre>$ write sys$output f$fao("It's !%D",0)
It's 16-AUG-2018 12:54:08.98</pre>
|}

=See also=
* [[Quick guide to F$FAO()]]

F$GETDVI()

2018-09-13T10:23:36Z

Maxim Megalinskiy: Fixed minor typos, changed formatting of the tables

'''F$GETDVI()''' is a [[Lexical functions|lexical function]] that returns information about a specified device.

=Format=

F$GETDVI(device-name,item[,pathname])

==device-name==

Specifies a physical device name or a [[Logical name|logical name]] equated to a physical device name. Specify the device name as a character string expression.

After the device-name argument is evaluated, the F$GETDVI function examines the first character of the name. If the first character is an underscore (_), the name is considered a physical device name; otherwise, a single level of [[Logical names|logical name]] translation is performed and the equivalence name, if any, is used.

==item==

Specifies the type of device information to be returned. The item must be specified as a character string expression (use quotes). You can specify any one of the items listed below. For detailed descriptions of each item code, see the VSI OpenVMS DCL Dictionary.

==pathname==

If the pathname argument is specified, it is validated against the existing paths for the specified device. If the path does not exist, the NOSUCHPATH error is returned, even if the specified item code does not make use of the pathname argument.

=List of F$GETDVI() items by topic=

==Logicals==
{| class="wikitable"
|-
! Item !! Value Returned !! Description
|-
| CONCEALED|| style="text-align:center;" | String || TRUE or FALSE to indicate whether the [[Logical name|logical device name]] translates to a [[Concealed logical|concealed]] device.
|}

===Volumes===

{| class="wikitable"
|-
! Item !! Value Returned !! Description
|-
| ACCESSTIMES_RECORDED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume supports the recording of access times
|-
| CLUSTER || style="text-align:center;" | Integer || Volume cluster size
|-
| CYLINDERS || style="text-align:center;" | Integer || Number of cylinders on the volume (disks only)
|-
| DIR || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is directory structured
|-
| EXPSIZE || style="text-align:center;" | Integer || Current [[Volume expansion limit|expansion limit]] on the volume
|-
| ERASE_ON_DELETE || style="text-align:center;" | String || TRUE or FALSE to indicate whether disk blocks are zeroed upon file deletion on the volume.
|-
| FREEBLOCKS || style="text-align:center;" | Integer || Number of free blocks on the volume (disks only)
|-
| HARDLINKS_SUPPORTED || style="text-align:center;" | String || TRUE or FALSE to indicate whether [[Hardlink|Hardlink]]hardlinks, rather than [[Alias|aliases]], are supported on the volume
|-
| LOGVOLNAM || style="text-align:center;" | String || Logical volume name
|-
| MAXBLOCK || style="text-align:center;" | Integer || Number of [[Logical block|logical blocks]] on the volume
|-
| MAXFILES || style="text-align:center;" | Integer || Maximum number of files on the volume
|-
| NEXTDEVNAM || style="text-align:center;" | String || Device name of the next volume in a [[Volume set|volume set]]
|-
| ROOTDEVNAM || style="text-align:center;" | String || Device name of the root volume in a volume set (disks only)
|-
| NOCACHE_ON_VOLUME || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is mounted with all caching disabled
|-
| NOHIGHWATER || style="text-align:center;" | String || TRUE or FALSE to indicate whether [[High-water marking|high-water marking]] is disabled on the volume
|-
| NOSHARE_MOUNTED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is mounted with /NOSHARE
|-
| NOXFCCACHE_ON_VOLUME || style="text-align:center;" | String || TRUE or FALSE to indicate whether the XFC caching is disabled on the volume
|-
| ODS2_SUBSET0 || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume mounted supports only a subset of the [[ODS-2]] file structure
|-
| ODS5 || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is mounted [[ODS-5]]
|-
| SDI || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is single-directory structured
|-
| SECTORS || style="text-align:center;" | Integer || Number of sectors per track (disks only)
|-
| SERIALNUM || style="text-align:center;" | Integer || Volume serial number (disks only)
|-
| TRACKS || style="text-align:center;" | Integer || Number of tracks per cylinder (disks only)
|-
| TRANSCNT || style="text-align:center;" | Integer || Volume [[Transaction count|transaction count]]
|-
| VOLCHAR || style="text-align:center;" | String || 128-bit string (16 bytes) that represents the volume characteristics or capabilities of the mounted device. If a bit is set, the volume is capable of performing the function
|-
| VOLCOUNT || style="text-align:center;" | Integer || The count of volumes in a volume set (disks only)
|-
| VOLNAM || style="text-align:center;" | String || The volume name
|-
| VOLNUMBER || style="text-align:center;" | Integer || Number of the current volume in a volume set (disks only)
|-
| VOLSETMEM || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a volume set (disks only)
|-
| VOLSIZE || style="text-align:center;" | Integer || The volume's current logical volume size
|-
| VOLUME_EXTEND_QUANTITY || style="text-align:center;" | Integer || Number of blocks to be used as the default extension size for all files on the volume
|-
| VOLUME_MOUNT_GROUP || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is mounted /GROUP
|-
| VOLUME_MOUNT_SYS || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is mounted /SYSTEM
|-
| VOLUME_PENDING_WRITE_ERR || style="text-align:center;" | String || The number of pending write errors on the volume
|-
| VOLUME_RETAIN_MAX || style="text-align:center;" | String || The maximum retention time for the volume, as specified with the DCL command SET VOLUME/RETENTION
|-
| VOLUME_RETAIN_MIN || style="text-align:center;" | String || The minimum retention time for the volume, as specified with the DCL command SET VOLUME/RETENTION
|-
| VOLUME_SPOOLED_DEV_CNT || style="text-align:center;" | Integer || The number of devices [[Spooling|spooled]] to the volume
|-
| VOLUME_WINDOW || style="text-align:center;" | Integer || The default window size for the volume
|-
| VPROT || style="text-align:center;" | String || The volume [[Protection mask|protection mask]]
|-
| WRITETHRU_CACHE_ENABLED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is mounted with [[Write-through caching|write through caching]] enabled
|}

===Tapes===
{| class="wikitable"
|-
! Item !! Value Returned !! Description
|-
| MT3_DENSITY || style="text-align:center;" | String || Current density of the device
|-
| MT3_SUPPORTED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device supports densities defined in the MT3DEF (for Alpha tapes only)
|-
| SQD || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is sequential block-oriented
|}

===Fibre Channel===
{| class="wikitable"
|-
! Item !! Value Returned !! Description
|-
| FC_HBA_FIRMWARE_REV || style="text-align:center;" | String || Firmware revision information of a Fibre Channel host bus adapter. A null string is returned for all other devices
|-
| FC_NODE_NAME || style="text-align:center;" | String || The Fibre Channel host bus adapter node name
|-
| FC_PORT_NAME || style="text-align:center;" | String || The Fibre Channel host bus adapter node name
|-
| WWID || style="text-align:center;" | String || Worldwide Identifier for a Fibre Channel device
|}

===SCSI===
{| class="wikitable"
|-
! Item !! Value Returned !! Description
|-
| SCSI_DEVICE_FIRMWARE_REV || style="text-align:center;" | String || Firmware revision number of a SCSI disk or SCSI tape. A null string is returned for any other device
|}

===Shadow sets===
{| class="wikitable"
|-
! Item !! Value Returned !! Description
|-
| SHDW_CATCHUP_COPYING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a member that is the target of a full copy operation
|-
| SHDW_COPIER_NODE || style="text-align:center;" | String || The name of the node that is actively performing the copy or merge operation
|-
| SHDW_DEVICE_COUNT || style="text-align:center;" | Integer || The total number of devices in the virtual unit, including devices being added as copy targets
|-
| SHDW_GENERATION || style="text-align:center;" | String || The current internal revision number for the virtual unit. This value is subject to change
|-
| SHDW_MASTER || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a virtual unit
|-
| SHDW_MASTER_MBR || style="text-align:center;" | String || The name of the master member unit that will be used for merge and copy repair operations and for shadow set recovery operations
|-
| SHDW_MASTER_NAME || style="text-align:center;" | String || Device name of the virtual unit that represents the shadow set of which the specified device is a member. F$GETDVI returns a null string ("") if the specified device is not a member, or is itself a virtual unit
|-
| SHDW_MBR_COPY_DONE || style="text-align:center;" | String || The percent of the copy operation completed on this member unit
|-
| SHDW_MBR_COUNT || style="text-align:center;" | Integer || The number of full source members in the virtual unit. Devices being added as copy targets are not full source members
|-
| SHDW_MBR_MERGE_DONE || style="text-align:center;" | String || The percent of the merge operation completed on this member unit
|-
| SHDW_MBR_READ_COST || style="text-align:center;" | String || The current value set for the member unit. This value can be modified to use a user-specified value
|-
| SHDW_MEMBER || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a shadow set member
|-
| SHDW_MERGE_COPYING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a merge member of the shadow set
|-
| SHDW_MINIMERGE_ENABLE || style="text-align:center;" | String || A value of TRUE indicates that the virtual unit will undergo a mini-merge, not a full merge, if a system in the cluster crashes
|-
| SHDW_NEXT_MBR_NAME || style="text-align:center;" | String || Device name of the next member in the shadow set. If you specify a virtual unit, F$GETDVI returns the device name of a member of the shadow set. If you specify the name of a shadow set member unit with the device name and item arguments, F$GETDVI returns the name of the "next" member unit or a null string if there are no more members. To determine all the members of a shadow set, first specify the virtual unit to F$GETDVI; on subsequent calls, specify the member name returned by the previous F$GETDVI call until it has finished, when it returns a null member name. The device name includes the allocation class if the allocation class is not zero; otherwise it includes the device name of the disk controller
|-
| SHDW_READ_SOURCE || style="text-align:center;" | String || The name of the member unit that will be used for reads at this time. The unit with the lowest sum total of its queue length and read cost is used. This is a dynamic value
|-
| SHDW_SITE || style="text-align:center;" | Integer || The site value for the specified device. This value is set by the SET DEVICE or SET SHADOW command
|-
| SHDW_TIMEOUT || style="text-align:center;" | Integer || The user-specified timeout value set for the device. If the user has not set a value by using the SETSHOSHADOW utility, the value of the SYSGEN parameter SHADOW_MBR_TMO is used for member units and the value of MVTIMEOUT is used for virtual units
|}

===Multipath===
{| class="wikitable"
|-
! Item !! Value Returned !! Description
|-
| MULTIPATH || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a member of a multipath set
|-
| ALT_HOST_AVAIL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the host serving the alternate path is available
|-
| ALT_HOST_NAME || style="text-align:center;" | String || Name of the host serving the alternate path
|-
| ALT_HOST_TYPE || style="text-align:center;" | String || Hardware type of the host serving the alternate path
|-
| AVAILABLE_PATH_COUNT || style="text-align:center;" | Integer || Number of available, working paths for a multipath-capable device
|-
| HOST_AVAIL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the host serving the primary path is available
|-
| HOST_COUNT || style="text-align:center;" | Integer || Number of hosts that make the device available to other nodes in the OpenVMS Cluster
|-
| HOST_NAME || style="text-align:center;" | String || Name of the host serving the primary path
|-
| HOST_TYPE || style="text-align:center;" | String || Hardware type of the host serving the primary path
|-
| MPDEV_AUTO_PATH_SW_CNT || style="text-align:center;" | Integer || Number of times a multipath device has automatically switched paths because of an I/O error or as the result of automatically "failing back" to a local path from a remote path once the local path became available
|-
| MPDEV_CURRENT_PATH || style="text-align:center;" | String || Current path name for multipath devices. If the device is not part of a multipath set, this lexical returns the name of the device path if the class driver for this device supports path names. SYS$DKDRIVER, SYS$DUDRIVER, SYS$MKDRIVER, and SYS$GKDRIVER support path names. Returns a null string if the class driver for the device does not support path names
|-
| MPDEV_MAN_PATH_SW_CNT || style="text-align:center;" | Integer || Number of times a multipath device has manually switched paths because of a SET DEVICE /PATH /SWITCH command or use of the $SET_DEVICE system service
|-
| PATH_AVAILABLE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the specified path is available. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
|-
| PATH_NOT_RESPONDING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the specified path is marked as not responding. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
|-
| PATH_POLL_ENABLED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the specified path is enabled for multipath polling. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
|-
| PATH_SWITCH_FROM_TIME || style="text-align:center;" | String || Time from which this path was switched, either manually or automatically. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
|-
| PATH_SWITCH_TO_TIME || style="text-align:center;" | String || Time to which this path was switched, either manually or automatically. This item code is typically used with the pathname parameter. If thepathname parameter is omitted, information about the current path of the multipath device is returned
|-
| PATH_USER_DISABLED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the specified path has been disabled using the SET DEVICE /PATH /NOENABLE command. This item code is typically used with the pathname parameter. If thepathname parameter is omitted, information about the current path of the multipath device is returned
|-
| TOTAL_PATH_COUNT || style="text-align:center;" | Integer || Number of paths for a multipath-capable device
|}

===Network devices===
{| class="wikitable"
|-
! Item !! Value Returned !! Description
|-
| NET || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a network device
|-
| LAN_ALL_MULTICAST_MODE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is enabled to receive all multicast packets rather than only packets addressed to enabled multicast addresses
|-
| LAN_AUTONEG_ENABLED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is set to autonegotiate the speed and duplex settings
|-
| LAN_DEFAULT_MAC_ADDRESS || style="text-align:center;" | String || The default MAC (media access control) address of the device
|-
| LAN_FULL_DUPLEX || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is operating in full-duplex mode
|-
| LAN_JUMBO_FRAMES_ENABLED || style="text-align:center;" | String || TRUE or FALSE to indicate whether jumbo frames are enabled on the device
|-
| LAN_LINK_STATE_VALID || style="text-align:center;" | String || TRUE or FALSE to indicate whether or not the device driver for the LAN device correctly maintains the link status. The device drivers for the following devices do not maintain the link status: DEMNA, any TURBOchannel adapter, any PCMPIA Ring adapter, Galaxy shared memory, TGEC, DE205, DE422, DE425, DE434, DE435, DE500 (the -XA and -AA variants; only the -BA variant is supported.)
|-
| LAN_LINK_UP || style="text-align:center;" | String || TRUE or FALSE to indicate whether the link is up. This item code is valid only for the template device (that is, unit number 0); this item returns 0 if used with a non-template LAN device. This item is supported only on newer adapters; to determine whether or not a particular device supports LAN_LINK_UP, you must first use F$GETDVI with the item LAN_LINK_STATE_VALID. See that item description for more information. If LAN_LINK_UP is used on an adapter that does not maintain the link status, the returned status will be SS$_UNSUPPORTED.
|-
| LAN_MAC_ADDRESS || style="text-align:center;" | String || The current MAC (media access control) address of the device. For more information about the distinction between the default and current MAC addresses, see the HP OpenVMS System Services Reference Manual|
|-
| LAN_PROMISCUOUS_MODE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is enabled to receive all packets, rather than only packets addressed to the MAC addresses and to enabled multicast addresses
|-
| LAN_PROTOCOL_NAME || style="text-align:center;" | String || The name of the LAN protocol running on the device
|-
| LAN_PROTOCOL_TYPE || style="text-align:center;" | String || The type of the LAN protocol running on the device
|-
| LAN_SPEED || style="text-align:center;" | Integer || The speed of the LAN device, in units of megabits per second. Valid values are 4, 10, 16, 100, 1000, and 10000
|-
| SET_HOST_TERMINAL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a remote terminal for a SET HOST session from a remote node
|}

===Printers===
{| class="wikitable"
|-
! Item !! Value Returned !! Description
|-
| QLEN || style="text-align:center;" | Integer || The queue length for the device. This value is the number of I/O requests already in the driver --- not the depth of the I/O pending queue
|-
| SPL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is being spooled
|-
| SPLDEVNAM || style="text-align:center;" | String || Name of the device being spooled
|}

==Terminals==
{| class="wikitable"
|-
! Item !! Value Returned !! Description
|-
| TRM || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a terminal
|-
| TT_ACCPORNAM || style="text-align:center;" | String || The terminal server name and port name
|-
| TT_ALTYPEAHD || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has an alternate type-ahead buffer
|-
| TT_ANSICRT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is an ANSI CRT terminal
|-
| TT_APP_KEYPAD || style="text-align:center;" | String || TRUE or FALSE to indicate whether the keypad is in applications mode
|-
| TT_AUTOBAUD || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has automatic baud rate detection
|-
| TT_AVO || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has a VT100-family terminal display
|-
| TT_BLOCK || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has block mode capability
|-
| TT_BRDCSTMBX || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal uses mailbox broadcast messages
|-
| TT_CHARSET || style="text-align:center;" | Integer || A bitmap indicating the coded character set supported by the terminal
|-
| TT_CRFILL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal requires fill after a carriage return
|-
| TT_CS_HANGUL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal supports the DEC Korean coded character set
|-
| TT_CS_HANYU || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal supports the DEC Hanyu coded character set
|-
| TT_CS_HANZI || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal supports the DEC Hanzi coded character set
|-
| TT_CS_KANA || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal supports the DEC Kana coded character set
|-
| TT_CS_KANJI || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal supports the DEC Kanji coded character set
|-
| TT_CS_THAI || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal supports the DEC Thai coded character set
|-
| TT_DECCRT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT terminal
|-
| TT_DECCRT2 || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT2 terminal
|-
| TT_DECCRT3 || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT3 terminal
|-
| TT_DECCRT4 || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT4 terminal
|-
| TT_DIALUP || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is connected to dialup
|-
| TT_DISCONNECT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal can be disconnected
|-
| TT_DMA || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has direct memory access (DMA) mode
|-
| TT_DRCS || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal supports loadable character fonts
|-
| TT_EDIT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the edit characteristic is set
|-
| TT_EDITING || style="text-align:center;" | String || TRUE or FALSE to indicate whether advanced editing is enabled
|-
| TT_EIGHTBIT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal uses the 8-bit ASCII character set
|-
| TT_ESCAPE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal generates escape sequences
|-
| TT_FALLBACK || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal uses the multinational fallback option
|-
| TT_HALFDUP || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is in half-duplex mode
|-
| TT_HANGUP || style="text-align:center;" | String || TRUE or FALSE to indicate whether the hangup characteristic is set
|-
| TT_HOSTSYNC || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has host/terminal communication
|-
| TT_INSERT || style="text-align:center;" | String || TRUE or FALSE to indicate whether insert mode is the default line editing mode
|-
| TT_LFFILL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal requires fill after a line feed
|-
| TT_LOCALECHO || style="text-align:center;" | String || TRUE or FALSE to indicate whether the local echo characteristic is set
|-
| TT_LOWER || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has the lowercase characters set
|-
| TT_MBXDSABL || style="text-align:center;" | String || TRUE or FALSE to indicate whether mailboxes associated with the terminal will receive unsolicited input notification or input notification
|-
| TT_MECHFORM || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has mechanical form feed
|-
| TT_MECHTAB || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has mechanical tabs and is capable of tab expansion
|-
| TT_MODEM || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is connected to a modem
|-
| TT_MODHANGUP || style="text-align:center;" | String || TRUE or FALSE to indicate whether the modify hangup characteristic is set
|-
| TT_NOBRDCST || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal will receive broadcast messages
|-
| TT_NOECHO || style="text-align:center;" | String || TRUE or FALSE to indicate whether the input characters are echoed
|-
| TT_NOTYPEAHD || style="text-align:center;" | String || TRUE or FALSE to indicate whether data must be solicited by a read operation
|-
| TT_OPER || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is an operator terminal
|-
| TT_PAGE || style="text-align:center;" | String || Terminal page length
|-
| TT_PASTHRU || style="text-align:center;" | String || TRUE or FALSE to indicate whether PASSALL mode with flow control is available
|-
| TT_PHYDEVNAM || style="text-align:center;" | String || Physical device name associated with a channel number or virtual terminal
|-
| TT_PRINTER || style="text-align:center;" | String || TRUE or FALSE to indicate whether there is a printer port available
|-
| TT_READSYNC || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has read synchronization
|-
| TT_REGIS || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has ReGIS graphics
|-
| TT_REMOTE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has established modem control
|-
| TT_SCOPE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is a video screen display
|-
| TT_SECURE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal can recognize the secure server
|-
| TT_SETSPEED || style="text-align:center;" | String || TRUE or FALSE to indicate whether you cannot set the speed on the terminal line
|-
| TT_SIXEL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the sixel is supported
|-
| TT_SYSPWD || style="text-align:center;" | String || TRUE or FALSE to indicate whether the system password is enabled for a particular terminal
|-
| TT_TTSYNC || style="text-align:center;" | String || TRUE or FALSE to indicate whether there is terminal/host synchronization
|-
| TT_WRAP || style="text-align:center;" | String || TRUE or FALSE to indicate whether a new line should be inserted if the cursor moves beyond the right margin
|}

===Miscellaneous===

====Allocation and mounting====
{| class="wikitable"
|-
! Item !! Value Returned !! Description
|-
| ALL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is [[Device allocation|allocated]]
|-
| FOR || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is mounted using the /FOREIGN qualifier
|-
| DMT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is marked for dismount
|-
| MNT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is mounted
|-
| MOUNT_TIME || style="text-align:center;" | String || Time at which the volume was mounted. For volumes mounted in a cluster, only the time of the initial mount is recorded; the time of any subsequent mount is not recorded
|-
| MOUNTCNT || style="text-align:center;" | Integer || Number of times the volume has been mounted on the local system. The value of MOUNTCNT displayed by the SHOW DEVICE command is the total of all mounts of the volume across all members of the cluster
|-
| MOUNTVER_ELIGIBLE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is eligible to undergo [[Mount verification|mount verification]]. A volume mounted with either the /FOREIGN or /NOMOUNT_VERIFICATION qualifier is not subject to mount verification
|-
| MVSUPMSG || style="text-align:center;" | String || TRUE or FALSE to indicate whether mount verification OPCOM messages are currently being suppressed on this device. See the MVSUPMSG_INTVL and MVSUPMSG_NUM system parameters for more information on the suppression of mount verification messages
|}

====Device information====
{| class="wikitable"
|-
! Item !! Value Returned !! Description
|-
| ALLOCLASS || style="text-align:center;" | Longword integer|| [[Allocation class]] of the host
|-
| ALLDEVNAM || style="text-align:center;" | String || Allocation class device name
|-
| DEVCLASS || style="text-align:center;" | Integer || [[Device class]]
|-
| DEVLOCKNAM || style="text-align:center;" | String || A unique lock name for the device
|-
| DEVNAM || style="text-align:center;" | String || Device name
|-
| DEVTYPE || style="text-align:center;" | Integer || [[Device type]]
|-
| FULLDEVNAM || style="text-align:center;" | String || Fully qualified device name
|-
|}

====Other====
{| class="wikitable"
|-
! Item !! Value Returned !! Description
|-
| ACPPID || style="text-align:center;" | String || Ancillary control process (ACP) identification
|-
| ACPTYPE || style="text-align:center;" | String || ACP type code, as one of the following strings: F11V1, F11V2, F11V3, F11V4, F11V5, F64, HBS, JNL, MTA, NET, REM, UCX, or ILLEGAL. The ACPTYPE item returns ILLEGAL if the device is not mounted or is mounted using the /FOREIGN qualifier or the ACPTYPE is not currently defined.
|-
| AVL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is available for use.
|-
| CCL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a carriage control device.
|-
| DEVBUFSIZ || style="text-align:center;" | Integer || Device buffer size
|-
| DEVCHAR || style="text-align:center;" | Integer || Device characteristics
|-
| DEVCHAR2 || style="text-align:center;" | Integer || Additional device characteristics
|-
| DEVDEPEND || style="text-align:center;" | Integer || Device-dependent information
|-
| DEVDEPEND2 || style="text-align:center;" | Integer || Additional device-dependent information
|-
| DEVICE_TYPE_NAME || style="text-align:center;" | String || Device type name. Note that if the device is a SCSI tape or disk, the device type name is retrieved directly from the device
|-
| DEVSTS || style="text-align:center;" | String || Device-dependent status information
|-
| DFS_ACCESS || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a virtual disk connected to a remote Distributed File System (DFS) server.
|-
| DUA || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a generic device.
|-
| ELG || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device has error logging enabled.
|-
| ERRCNT || style="text-align:center;" | Integer || [[Device error count|Error count]] of the device. If the error count has been reset with the SET DEVICE /RESET=ERRCNT command, you can use the SHOW DEVICE/FULL command to display the date and time that the error count was reset. If the pathname parameter is specified, only the error count for that path is returned. If the pathname parameter is omitted, the summation of the error counts for all paths in a multipath device is returned.
|-
| ERROR_RESET_TIME || style="text-align:center;" | String || Time at which the error count was reset.
|-
| EXISTS || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device exists on the system.
|-
| FOD || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a files-oriented device.
|-
| GEN || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a generic device.
|-
| IDV || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is capable of providing input.
|-
| LOCKID || style="text-align:center;" | Integer || Clusterwide lock identification.
|-
| MAILBOX_BUFFER_QUOTA || style="text-align:center;" | Integer longword|| The current mailbox quota as an unsigned integer longword.
|-
| MAILBOX_INITIAL_QUOTA || style="text-align:center;" | Integer longword|| The initial mailbox quota as an unsigned integer longword.
|-
| MBX || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a [[Mailbox|mailbox]].
|-
| MEDIA_ID || style="text-align:center;" | Integer || Nondecoded media ID.
|-
| MEDIA_NAME || style="text-align:center;" | String || Either the name of the disk or the tape type.
|-
| MEDIA_TYPE || style="text-align:center;" | String || Device name prefix.
|-
| ODV || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is capable of providing output.
|-
| OPCNT || style="text-align:center;" | Integer || [[Operation count]] of the device. Note that the operation count may have been reset with the SET DEVICE/RESET=OPCNT command. If the pathname parameter is specified, only the operation count for that path is returned. If the pathname parameter is omitted, the summation of the operation counts for all paths in a multipath device is returned.
|-
| OPR || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is an operator.
|-
| OWNUIC || style="text-align:center;" | String || [[UIC|User identification code]] (UIC) of the device owner.
|-
| PID || style="text-align:center;" | String || [[PID|Process identification number]] of the device owner.
|-
| PREFERRED_CPU || style="text-align:center;" | Integer || Return argument is a 32-bit CPU bit mask with a bit set indicating the preferred CPU. A return argument containing a bit mask of zero indicates that no preferred CPU exists, either because Fast Path is disabled or the device is not a Fast Path capable device. The return argument serves as a CPU bit mask input argument to the $PROCESS_AFFINITY system service. The argument can be used to assign an application process to the optimal preferred CPU.
|-
| PREFERRED_CPU_BITMAP || style="text-align:center;" | String || A bitmap string of zeros and, at most, a single 1. The 1 in the bitmask represents the number of the CPU to which the device is affinitized. The length of the string determines by how many CPUs are on the system. If there is no 1 in the bitmap string, then either Fast Path is disabled systemwide, or the device is not Fast Path-capable.
|-
| PROT_SUBSYSTEM_ENABLED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is mounted with protected subsystems enabled.
|-
| RCK || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device has read checking enabled.
|-
| RCT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the disk contains RCT.
|-
| REC || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is record-oriented.
|-
| RECSIZ || style="text-align:center;" | Integer || Blocked record size.
|-
| REFCNT || style="text-align:center;" | Integer || Reference count of processes using the device.
|-
| REMOTE_DEVICE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a remote device.
|-
| RND || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device allows random access.
|-
| RTM || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a real-time device.
|-
| SERVED_DEVICE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a served device.
|-
| SHR || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is shareable.
|-
| STS || style="text-align:center;" | Integer || Status information.
|-
| SWL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is software write-locked.
|-
| UNIT || style="text-align:center;" | Integer || The unit number.
|-
| WCK || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device has write checking enabled.
|-
| XFC_DEPOSING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the XFC volume depose operation is in progress or not.
|-
|}

F$GETSYI()

2018-09-13T10:01:03Z

Maxim Megalinskiy: Removed a needless whitespace

'''F$GETSYU()''' is a [[Lexical function|lexical function]] that returns status and identification information about the local system (or about a node in the local mixed-architecture OpenVMS Cluster system, if your system is part of an OpenVMS Cluster).

=Format=

F$GETSYI (item [,node-name] [,cluster-id])

==item==

In addition to the items below, you can specify any [[System parameters|system parameter]].

{| class="wikitable"
|-
! Item !! Return Type !! Information Returned
|-
| AI || style="text-align:center;" | String || TRUE if after-image (AI) journaling is enabled; FALSE if disabled.
|-
| ALQ || style="text-align:center;" | Integer || Allocation quantity.
|-
| BDT || style="text-align:center;" | String || Backup date/time.
|-
| BI || style="text-align:center;" | String || TRUE if before-image (BI) journaling is enabled; FALSE if disabled.
|-
| BKS || style="text-align:center;" | Integer || Bucket size.
|-
| BLS || style="text-align:center;" | Integer || Block size.
|-
| CBT || style="text-align:center;" | String || TRUE if contiguous-best-try; otherwise FALSE.
|-
| CDT || style="text-align:center;" | String || Creation date/time.
|-
| CTG || style="text-align:center;" | String || TRUE if contiguous; otherwise FALSE.
|-
| DEQ || style="text-align:center;" | Integer || Default extension quantity.
|-
| DID || style="text-align:center;" | String || Directory ID string.
|-
| DIRECTORY || style="text-align:center;" | String || Returns TRUE or FALSE. Returns TRUE if it is a directory.
|-
| DVI || style="text-align:center;" | String || Device name string.
|-
| EDT || style="text-align:center;" | String || Expiration date/time.
|-
| EOF || style="text-align:center;" | Integer || Number of blocks used.
|-
| ERASE || style="text-align:center;" | String || TRUE if a file's contents are erased before a file is deleted; otherwise FALSE.
|-
| FFB || style="text-align:center;" | Integer || First free byte.
|-
| FID || style="text-align:center;" | String || File ID string.
|-
| FILE_LENGTH_HINT || style="text-align:center;" | String || Record count and data byte count in the form (
|-
| FSZ || style="text-align:center;" | Integer || Fixed control area size.
|-
| GBC || style="text-align:center;" | Integer || Global buffer count.
|-
| GBC32 || style="text-align:center;" | Integer || Enhanced longword version of global buffer count with a per-file maximum size of about 2.1 billion for indexed files.
|-
| GBCFLAGS || style="text-align:center;" | 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 || style="text-align:center;" | Integer || Owner group number.
|-
| JOURNAL_FILE || style="text-align:center;" | String || TRUE if the file is a 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).
|-
| LOCKED || style="text-align:center;" | String || TRUE if a file is deaccessed-locked; otherwise FALSE.
|-
| LRL || style="text-align:center;" | Integer || Longest record length.
|-
| MBM || style="text-align:center;" | Integer || Owner member number.
|-
| MOVE || style="text-align:center;" | String || TRUE if movefile operations are enabled; otherwise FALSE.
|-
| MRN || style="text-align:center;" | Integer || Maximum record number.
|-
| MRS || style="text-align:center;" | Integer || Maximum record size.
|-
| NOA || style="text-align:center;" | Integer || Number of areas.
|-
| NOBACKUP || style="text-align:center;" | String || FALSE if the file is marked for backup; TRUE if the file is marked NOBACKUP.
|-
| NOK || style="text-align:center;" | Integer || Number of keys.
|-
| ORG || style="text-align:center;" | String || File organization; returns SEQ, REL, IDX.
|-
| PRESHELVED (Alpha/Integrity servers only) || style="text-align:center;" | String || TRUE if the file is preshelved; otherwise FALSE.
|-
| PRO || style="text-align:center;" | String || File protection string.
|-
| PVN || style="text-align:center;" | Integer || Prolog version number.
|-
| RAT || style="text-align:center;" | String || Record attributes; returns CR, PRN, FTN, "".
|-
| RCK || style="text-align:center;" | String || TRUE if read check; otherwise FALSE.
|-
| RDT || style="text-align:center;" | String || Revision date/time.
|-
| RFM || style="text-align:center;" | String || Record format string; returns the values VAR, FIX, VFC, UDF, STM, STMLF, STMCR.
|-
| RU || style="text-align:center;" | String || TRUE if recovery unit (RU) journaling is enabled; returns TRUE or FALSE.
|-
| RVN || style="text-align:center;" | Integer || Revision number.
|-
| SHELVABLE || style="text-align:center;" | String || TRUE if the file is shelvable; otherwise FALSE.
|-
| SHELVED || style="text-align:center;" | String || TRUE if the file is shelved; otherwise FALSE.
|-
| STORED_SEMANTICS || style="text-align:center;" | String || ASCII string that represents stored semantics.
|-
| UIC || style="text-align:center;" | String || Owner user identification code (UIC) string.
|-
| VERLIMIT || style="text-align:center;" | Integer || Version limit number. The value 32767 indicates that no version limit was set.
|-
| WCK || style="text-align:center;" | String || TRUE if write check; otherwise FALSE.
|}

==node-name==

Specifies the node in your OpenVMS Cluster system for which information is to be returned. Specify the node as a character string expression. You cannot use the asterisk (*) and the percent sign (%) wildcard characters to specify the '''node-name''' argument.

==cluster-id==
Specifies the cluster node identification number for which the information is to be returned.
To get information for all the nodes in a cluster, use the F$CSID lexical function to obtain each cluster system identification number, and use the '''cluster-id''' argument of F$GETSYI to gather information about each node.

=Examples=
<pre>$ SYSID = F$GETSYI("SID")
$ SHOW SYMBOL SYSID
SYSID = 19923201 Hex = 01300101 Octal = 000401

$ MEM = F$GETSYI("CLUSTER_MEMBER", "LONDON")
$ SHOW SYMBOL MEM
MEM = "TRUE"

$ LIM = F$GETSYI("IJOBLIM")
$ SHOW SYMBOL LIM
LIM = 16 Hex = 00000010 Octal = 00000000020

$ DECNETVERS = F$GETSYI("DECNET_VERSION")
$ SHOW SYMBOL DECNETVERS
DECNETVERS = "00050D01"
$ DECNETPHASE = F$INTEGER(F$EXTRACT(2,2,DECNETVERS))
$ SHOW SYMBOL DECNETPHASE
DECNETPHASE = 5 Hex = 00000005 Octal = 00000000005

$ RADCPU = F$GETSYI("RAD_CPUS")
$ SHOW SYMBOL RADCPU
0,0,0,1,1,4,1,5
</pre>

F$GETSYI()

2018-09-13T09:55:44Z

Maxim Megalinskiy: Capitalized words in the head of the table

F$GETSYI()

2018-09-13T09:53:24Z

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

'''F$GETSYU()''' is a [[Lexical function|lexical function]] that returns status and identification information about the local system (or about a node in the local mixed-architecture OpenVMS Cluster system, if your system is part of an OpenVMS Cluster).

=Format=

F$GETSYI (item [,node-name] [,cluster-id])

==item==

In addition to the items below, you can specify any [[System parameters|system parameter]].

{| class="wikitable"
|-
! Item !! Return type !! Information returned
|-
| AI || style="text-align:center;" | String || TRUE if after-image (AI) journaling is enabled; FALSE if disabled.
|-
| ALQ || style="text-align:center;" | Integer || Allocation quantity.
|-
| BDT || style="text-align:center;" | String || Backup date/time.
|-
| BI || style="text-align:center;" | String || TRUE if before-image (BI) journaling is enabled; FALSE if disabled.
|-
| BKS || style="text-align:center;" | Integer || Bucket size.
|-
| BLS || style="text-align:center;" | Integer || Block size.
|-
| CBT || style="text-align:center;" | String || TRUE if contiguous-best-try; otherwise FALSE.
|-
| CDT || style="text-align:center;" | String || Creation date/time.
|-
| CTG || style="text-align:center;" | String || TRUE if contiguous; otherwise FALSE.
|-
| DEQ || style="text-align:center;" | Integer || Default extension quantity.
|-
| DID || style="text-align:center;" | String || Directory ID string.
|-
| DIRECTORY || style="text-align:center;" | String || Returns TRUE or FALSE. Returns TRUE if it is a directory.
|-
| DVI || style="text-align:center;" | String || Device name string.
|-
| EDT || style="text-align:center;" | String || Expiration date/time.
|-
| EOF || style="text-align:center;" | Integer || Number of blocks used.
|-
| ERASE || style="text-align:center;" | String || TRUE if a file's contents are erased before a file is deleted; otherwise FALSE.
|-
| FFB || style="text-align:center;" | Integer || First free byte.
|-
| FID || style="text-align:center;" | String || File ID string.
|-
| FILE_LENGTH_HINT || style="text-align:center;" | String || Record count and data byte count in the form (
|-
| FSZ || style="text-align:center;" | Integer || Fixed control area size.
|-
| GBC || style="text-align:center;" | Integer || Global buffer count.
|-
| GBC32 || style="text-align:center;" | Integer || Enhanced longword version of global buffer count with a per-file maximum size of about 2.1 billion for indexed files.
|-
| GBCFLAGS || style="text-align:center;" | 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 || style="text-align:center;" | Integer || Owner group number.
|-
| JOURNAL_FILE || style="text-align:center;" | String || TRUE if the file is a 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).
|-
| LOCKED || style="text-align:center;" | String || TRUE if a file is deaccessed-locked; otherwise FALSE.
|-
| LRL || style="text-align:center;" | Integer || Longest record length.
|-
| MBM || style="text-align:center;" | Integer || Owner member number.
|-
| MOVE || style="text-align:center;" | String || TRUE if movefile operations are enabled; otherwise FALSE.
|-
| MRN || style="text-align:center;" | Integer || Maximum record number.
|-
| MRS || style="text-align:center;" | Integer || Maximum record size.
|-
| NOA || style="text-align:center;" | Integer || Number of areas.
|-
| NOBACKUP || style="text-align:center;" | String || FALSE if the file is marked for backup; TRUE if the file is marked NOBACKUP.
|-
| NOK || style="text-align:center;" | Integer || Number of keys.
|-
| ORG || style="text-align:center;" | String || File organization; returns SEQ, REL, IDX.
|-
| PRESHELVED (Alpha/Integrity servers only) || style="text-align:center;" | String || TRUE if the file is preshelved; otherwise FALSE.
|-
| PRO || style="text-align:center;" | String || File protection string.
|-
| PVN || style="text-align:center;" | Integer || Prolog version number.
|-
| RAT || style="text-align:center;" | String || Record attributes; returns CR, PRN, FTN, "".
|-
| RCK || style="text-align:center;" | String || TRUE if read check; otherwise FALSE.
|-
| RDT || style="text-align:center;" | String || Revision date/time.
|-
| RFM || style="text-align:center;" | String || Record format string; returns the values VAR, FIX, VFC, UDF, STM, STMLF, STMCR.
|-
| RU || style="text-align:center;" | String || TRUE if recovery unit (RU) journaling is enabled; returns TRUE or FALSE.
|-
| RVN || style="text-align:center;" | Integer || Revision number.
|-
| SHELVABLE || style="text-align:center;" | String || TRUE if the file is shelvable; otherwise FALSE.
|-
| SHELVED || style="text-align:center;" | String || TRUE if the file is shelved; otherwise FALSE.
|-
| STORED_SEMANTICS || style="text-align:center;" | String || ASCII string that represents stored semantics.
|-
| UIC || style="text-align:center;" | String || Owner user identification code (UIC) string.
|-
| VERLIMIT || style="text-align:center;" | Integer || Version limit number. The value 32767 indicates that no version limit was set.
|-
| WCK || style="text-align:center;" | String || TRUE if write check; otherwise FALSE.
|}

==node-name==

Specifies the node in your OpenVMS Cluster system for which information is to be returned. Specify the node as a character string expression. You cannot use the asterisk (*) and the percent sign (%) wildcard characters to specify the '''node-name''' argument.

==cluster-id==
Specifies the cluster node identification number for which the information is to be returned.
To get information for all the nodes in a cluster, use the F$CSID lexical function to obtain each cluster system identification number, and use the '''cluster-id''' argument of F$GETSYI to gather information about each node.

=Examples=
<pre>$ SYSID = F$GETSYI("SID")
$ SHOW SYMBOL SYSID
SYSID = 19923201 Hex = 01300101 Octal = 000401

$ MEM = F$GETSYI("CLUSTER_MEMBER", "LONDON")
$ SHOW SYMBOL MEM
MEM = "TRUE"

$ LIM = F$GETSYI("IJOBLIM")
$ SHOW SYMBOL LIM
LIM = 16 Hex = 00000010 Octal = 00000000020

$ DECNETVERS = F$GETSYI("DECNET_VERSION")
$ SHOW SYMBOL DECNETVERS
DECNETVERS = "00050D01"
$ DECNETPHASE = F$INTEGER(F$EXTRACT(2,2,DECNETVERS))
$ SHOW SYMBOL DECNETPHASE
DECNETPHASE = 5 Hex = 00000005 Octal = 00000000005

$ RADCPU = F$GETSYI("RAD_CPUS")
$ SHOW SYMBOL RADCPU
0,0,0,1,1,4,1,5
</pre>

F$FILE ATTRIBUTES()

2018-09-13T09:49:52Z

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

'''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 || style="text-align:center;" | String || TRUE if after-image (AI) journaling is enabled; FALSE if disabled.
|-
| ALQ || style="text-align:center;" | Integer || Allocation quantity.
|-
| BDT || style="text-align:center;" | String || [[Backup]] date/time.
|-
| BI || style="text-align:center;" | String || TRUE if before-image (BI) journaling is enabled; FALSE if disabled.
|-
| BKS || style="text-align:center;" | Integer || Bucket size.
|-
| BLS || style="text-align:center;" | Integer || Block size.
|-
| CBT || style="text-align:center;" | String || TRUE if contiguous-best-try; otherwise FALSE.
|-
| CDT || style="text-align:center;" | String || Creation date/time.
|-
| CTG || style="text-align:center;" | String || TRUE if contiguous; otherwise FALSE.
|-
| DEQ || style="text-align:center;" | Integer || Default extension quantity.
|-
| DID || style="text-align:center;" | String || Directory ID string.
|-
| DIRECTORY || style="text-align:center;" | String || Returns TRUE or FALSE. Returns TRUE if it is a directory.
|-
| DVI || style="text-align:center;" | String || [[Device name]] string.
|-
| EDT || style="text-align:center;" | String || Expiration date/time.
|-
| EOF || style="text-align:center;" | Integer || Number of blocks used.
|-
| ERASE || style="text-align:center;" | String || TRUE if a file's contents are erased before a file is deleted; otherwise FALSE.
|-
| FFB || style="text-align:center;" | Integer || First free byte.
|-
| FID || style="text-align:center;" | String || File ID string.
|-
| FILE_LENGTH_HINT || style="text-align:center;" | String || Record count and data byte count in the form (
|-
| FSZ || style="text-align:center;" | Integer || Fixed control area size.
|-
| GBC || style="text-align:center;" | Integer || Global buffer count.
|-
| GBC32 || style="text-align:center;" | Integer || Enhanced longword version of global buffer count with a per-file maximum size of about 2.1 billion for indexed files.
|-
| GBCFLAGS || style="text-align:center;" | 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 || style="text-align:center;" | Integer || Owner group number.
|-
| JOURNAL_FILE || style="text-align:center;" | String || TRUE if the file is a 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).
|-
| LOCKED || style="text-align:center;" | String || TRUE if a file is deaccessed-locked; otherwise FALSE.
|-
| LRL || style="text-align:center;" | Integer || Longest record length.
|-
| MBM || style="text-align:center;" | Integer || Owner [[UIC|member number]].
|-
| MOVE || style="text-align:center;" | String || TRUE if movefile operations are enabled; otherwise FALSE.
|-
| MRN || style="text-align:center;" | Integer || Maximum record number.
|-
| MRS || style="text-align:center;" | Integer || Maximum record size.
|-
| NOA || style="text-align:center;" | Integer || Number of areas.
|-
| NOBACKUP || style="text-align:center;" | String || FALSE if the file is marked for backup; TRUE if the file is marked NOBACKUP.
|-
| NOK || style="text-align:center;" | Integer || Number of keys.
|-
| ORG || style="text-align:center;" | String || [[File organization]]; returns SEQ, REL, IDX.
|-
| PRESHELVED || style="text-align:center;" | String || TRUE if the file is preshelved; otherwise FALSE.
|-
| PRO || style="text-align:center;" | String || File [[UIC protection|protection string]].
|-
| PVN || style="text-align:center;" | Integer || Prolog version number.
|-
| RAT || style="text-align:center;" | String || Record attributes; returns CR, PRN, FTN, "".
|-
| RCK || style="text-align:center;" | String || TRUE if read check; otherwise FALSE.
|-
| RDT || style="text-align:center;" | String || Revision date/time.
|-
| RFM || style="text-align:center;" | String || [[Record format]] string; returns the values VAR, FIX, VFC, UDF, STM, STMLF, STMCR.
|-
| RU || style="text-align:center;" | String || TRUE if recovery unit (RU) journaling is enabled; returns TRUE or FALSE.
|-
| RVN || style="text-align:center;" | Integer || Revision number.
|-
| SHELVABLE || style="text-align:center;" | String || TRUE if the file is shelvable; otherwise FALSE.
|-
| SHELVED || style="text-align:center;" | String || TRUE if the file is shelved; otherwise FALSE.
|-
| STORED_SEMANTICS || style="text-align:center;" | String || ASCII string that represents stored semantics.
|-
| UIC || style="text-align:center;" | String || Owner [[UIC|user identification code]] (UIC) string.
|-
| VERLIMIT || style="text-align:center;" | Integer || [[File version|Version]] limit number. The value 32767 indicates that no version limit was set.
|-
| WCK || style="text-align:center;" | 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>

$GETQUI output item codes

2018-09-13T09:44:32Z

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

{| class="wikitable"
|-
! Item !! Return Type !! Information Returned
|-
| ACCOUNT_NAME || style="text-align:center;" | String || The account name of the owner of the specified job.
|-
| AFTER_TIME || style="text-align:center;" | String || The system time at or after which the specified job can execute.
|-
| ASSIGNED_QUEUE_NAME || style="text-align:center;" | String || The name of the execution queue to which the logical queue specified in the call to F$GETQUI is assigned.
|-
| AUTOSTART_ON || style="text-align:center;" | String || A list of nodes or node device pairs indicating where the queue can start.
|-
| BASE_PRIORITY || style="text-align:center;" | Integer || The priority at which batch jobs are initiated from a batch execution queue or the priority of a symbiont process that controls output execution queues.
|-
| CHARACTERISTICS || style="text-align:center;" | String || The characteristics associated with the specified queue or job.
|-
| CHARACTERISTIC_NAME || style="text-align:center;" | String || The name of the specified characteristic.
|-
| CHARACTERISTIC_NUMBER || style="text-align:center;" | Integer || The number of the specified characteristic.
|-
| CHECKPOINT_DATA || style="text-align:center;" | String || The value of the DCL symbol BATCH$RESTART when the specified batch job is restarted.
|-
| CLI || style="text-align:center;" | String || The name of the command language interpreter (CLI) used to execute the specified batch job. The file specification returned assumes the device name SYS$SYSTEM and the file type EXE.
|-
| COMPLETED_BLOCKS || style="text-align:center;" | Integer || The number of blocks that the symbiont has processed for the specified print job. This item code is applicable only to print jobs.
|-
| CONDITION_VECTOR || style="text-align:center;" | Integer || The vector of three longwords. The first longword gives the completion status of the specified job. The second and third longwords give additional status about the print job.
|-
| CPU_DEFAULT || style="text-align:center;" | String || The default CPU time limit specified for the queue in delta time. This item code is applicable only to batch execution queues.
|-
| CPU_LIMIT || style="text-align:center;" | String || The maximum CPU time limit specified for the specified job or queue in delta time. This item code is applicable only to batch jobs and batch execution queues.
|-
| DEFAULT_FORM_NAME || style="text-align:center;" | String || The name of the default form associated with the specified output queue.
|-
| DEFAULT_FORM_STOCK || style="text-align:center;" | String || The name of the paper stock on which the specified default form is to be printed.
|-
| DEVICE_NAME || style="text-align:center;" | String || The node and device (or both) on which the specified execution queue is located. For output execution queues, only the device name is returned. The node name is used only in mixed-architecture OpenVMS Cluster systems. The node name is specified by the system parameter SCSNODE for the processor on which the queue executes.
|-
| ENTRY_NUMBER || style="text-align:center;" | Integer || The queue entry number of the specified job.
|-
| EXECUTING_JOB_COUNT || style="text-align:center;" | Integer || The number of jobs in the queue that are currently executing.
|-
| FILE_BURST || style="text-align:center;" | String || TRUE or FALSE to indicate whether burst and flag pages are to be printed preceding a file.
|-
| FILE_CHECKPOINTED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the specified file is checkpointed.
|-
| FILE_COPIES || style="text-align:center;" | Integer || The number of times the specified file is to be processed. This item code is applicable only to output execution queues.
|-
| FILE_COPIES_DONE || style="text-align:center;" | Integer || The number of times the specified file has been processed. This item code is applicable only to output execution queues.
|-
| FILE_COUNT || style="text-align:center;" | Integer || The number of files in a specified job.
|-
| FILE_DELETE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the specified file is to be deleted after execution of request.
|-
| FILE_DEVICE || style="text-align:center;" | String || The internal file-device value that uniquely identifies the selected file. This value specifies the following field in the RMS NAM block:
|-
| FILE_DID || style="text-align:center;" | String || The internal file-did value that uniquely identifies the selected file. This value specifies the following field in the RMS NAM block:
|-
| FILE_DOUBLE_SPACE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the symbiont formats the file with double spacing.
|-
| FILE_EXECUTING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the specified file is being processed.
|-
| FILE_FLAG || style="text-align:center;" | String || TRUE or FALSE to indicate whether a flag page is to be printed preceding a file.
|-
| FILE_FLAGS || style="text-align:center;" | Integer || The processing options that have been selected for the specified file. The integer represents a bit field. To find the settings of each bit in the field, use one of the following items in place of FILE_FLAGS:
|-
| FILE_IDENTIFICATION || style="text-align:center;" | String || The internal file-identification value that uniquely identifies the selected file. This value specifies the following file-identification field in the RMS NAM block:
|-
| FILE_PAGE_HEADER || style="text-align:center;" | String || TRUE or FALSE to indicate whether a page header is to be printed on each page of output.
|-
| FILE_PAGINATE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the symbiont paginates output by inserting a form feed whenever output reaches the bottom margin of the form.
|-
| FILE_PASSALL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the symbiont prints the file in PASSALL mode.
|-
| FILE_SETUP_MODULES || style="text-align:center;" | String || The names of the text modules that are to be extracted from the device control library and copied to the printer before the specified file is printed. This item code is meaningful only for output execution queues.
|-
| FILE_SPECIFICATION || style="text-align:center;" | String || The fully qualified RMS file specification of the file about which F$GETQUI is returning information.
|-
| FILE_STATUS || style="text-align:center;" | Integer || File status information. The integer represents a bit field. To find the settings of each bit in the field, use one of the following items in place of FILE_STATUS:
|-
| FILE_TRAILER || style="text-align:center;" | String || TRUE or FALSE to indicate whether a trailer page is to be printed following a file.
|-
| FIRST_PAGE || style="text-align:center;" | Integer || The page number at which the printing of the specified file is to begin. This item code is applicable only to output execution queues.
|-
| FORM_DESCRIPTION || style="text-align:center;" | String || The text string that describes the specified form to users and operators.
|-
| FORM_FLAGS || style="text-align:center;" | Integer || The processing options that have been selected for the specified form. The integer represents a bit field. To find the settings of each bit in the field, use one of the following items in place of FORM_FLAGS:
|-
| FORM_LENGTH || style="text-align:center;" | Integer || The physical length of the specified form in lines. This item code is applicable only to output execution queues.
|-
| FORM_MARGIN_BOTTOM || style="text-align:center;" | Integer || The bottom margin of the specified form in lines.
|-
| FORM_MARGIN_LEFT || style="text-align:center;" | Integer || The left margin of the specified form in characters.
|-
| FORM_MARGIN_RIGHT || style="text-align:center;" | Integer || The right margin of the specified form in characters.
|-
| FORM_MARGIN_TOP || style="text-align:center;" | Integer || The top margin of the specified form in lines.
|-
| FORM_NAME || style="text-align:center;" | String || The name of the specified form or the mounted form associated with the specified job or queue.
|-
| FORM_NUMBER || style="text-align:center;" | Integer || The number of the specified form.
|-
| FORM_SETUP_MODULES || style="text-align:center;" | String || The names of the text modules that are to be extracted from the device control library and copied to the printer before a file is printed on the specified form. This item code is meaningful only for output execution queues.
|-
| FORM_SHEET_FEED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the symbiont pauses at the end of each physical page so that another sheet of paper can be inserted.
|-
| FORM_STOCK || style="text-align:center;" | String || The name of the paper stock on which the specified form is to be printed.
|-
| FORM_TRUNCATE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the printer discards any characters that exceed the specified right margin.
|-
| FORM_WIDTH || style="text-align:center;" | Integer || The width of the specified form.
|-
| FORM_WRAP || style="text-align:center;" | String || TRUE or FALSE to indicate whether the printer prints any characters that exceed the specified right margin on the following line.
|-
| GENERIC_TARGET || style="text-align:center;" | String || The names of the execution queues that are enabled to accept work from the specified generic queue. This item code is meaningful only for generic queues.
|-
| HOLDING_JOB_COUNT || style="text-align:center;" | Integer || The number of jobs in the queue being held until explicitly released.
|-
| INTERVENING_BLOCKS || style="text-align:center;" | Integer || The number of blocks associated with pending jobs in the queue that were skipped during the current call to F$GETQUI. These jobs were not reported because they did not match the selection criterion in effect for the call to F$GETQUI.
|-
| INTERVENING_JOBS || style="text-align:center;" | Integer || The number of pending jobs in the queue that were skipped during the current call to F$GETQUI. These jobs were not reported because they did not match the selection criterion in effect for the call to F$GETQUI.
|-
| JOB_ABORTING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the system is attempting to abort the execution of a job.
|-
| JOB_COMPLETION_QUEUE || style="text-align:center;" | String || The name of the queue on which the specified job executed.
|-
| JOB_COMPLETION_TIME || style="text-align:center;" | String || The time at which the execution of the specified job completed.
|-
| JOB_COPIES || style="text-align:center;" | Integer || The number of times the specified print job is to be repeated.
|-
| JOB_COPIES_DONE || style="text-align:center;" | Integer || The number of times that the specified print job has been repeated.
|-
| JOB_CPU_LIMIT || style="text-align:center;" | String || TRUE or FALSE to indicate whether a CPU time limit is specified for the job.
|-
| JOB_ERROR_RETENTION || style="text-align:center;" | String || TRUE or FALSE to indicate whether the user requested that the specified job be retained in the queue if the job completes unsuccessfully.
|-
| JOB_EXECUTING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the specified job is executing or printing.
|-
| JOB_FILE_BURST || style="text-align:center;" | String || TRUE or FALSE to indicate whether a burst page option is explicitly specified for the job.
|-
| JOB_FILE_BURST_ONE || style="text-align:center;" | String || TRUE or FALSE to indicate whether burst and flag pages precede only the first copy of the first file in the job.
|-
| JOB_FILE_FLAG || style="text-align:center;" | String || TRUE or FALSE to indicate whether a flag page precedes each file in the job.
|-
| JOB_FILE_FLAG_ONE || style="text-align:center;" | String || TRUE or FALSE to indicate whether a flag page precedes only the first copy of the first file in the job.
|-
| JOB_FILE_PAGINATE || style="text-align:center;" | String || TRUE or FALSE to indicate whether a paginate option is explicitly specified for the job.
|-
| JOB_FILE_TRAILER || style="text-align:center;" | String || TRUE or FALSE to indicate whether a trailer page follows each file in the job.
|-
| JOB_FILE_TRAILER_ONE || style="text-align:center;" | String || TRUE or FALSE to indicate whether a trailer page follows only the last copy of the last file in the job.
|-
| JOB_FLAGS || style="text-align:center;" | Integer || The processing options selected for the specified job. The integer represents a bit field. To find the settings of each bit in the field, use one of the following items in place of JOB_FLAGS:
|-
| JOB_HOLDING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job will be held until it is explicitly released.
|-
| JOB_INACCESSIBLE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the caller does not have read access to the specific job and file information in the system queue file. When FALSE, the DISPLAY_JOB and DISPLAY_FILE operations can return information for only the following output value item codes:
|-
| JOB_LIMIT || style="text-align:center;" | Integer || The number of jobs that can execute simultaneously on the specified queue. This item code is applicable only to batch execution queues.
|-
| JOB_LOG_DELETE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the log file is deleted after it is printed.
|-
| JOB_LOG_NULL || style="text-align:center;" | String || TRUE or FALSE to indicate whether a log file is not created.
|-
| JOB_LOG_SPOOL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job log file is queued for printing when the job is complete.
|-
| JOB_LOWERCASE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job is to be printed on a printer that can print both uppercase and lowercase letters.
|-
| JOB_NAME || style="text-align:center;" | String || The name of the specified job.
|-
| JOB_NOTIFY || style="text-align:center;" | String || TRUE or FALSE to indicate whether a message is broadcast to a terminal when a job completes or aborts.
|-
| JOB_PENDING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job is pending.
|-
| JOB_PID || style="text-align:center;" | String || The process identification (PID) number of the executing batch job.
|-
| JOB_REFUSED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job was refused by the symbiont and is waiting for the symbiont to accept it for processing.
|-
| JOB_RESET_MODULES || style="text-align:center;" | String || The names of the text modules that are to be extracted from the device control library and copied to the printer before each job in the specified queue is printed. This item code is meaningful only for output execution queues.
|-
| JOB_RESTART || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job will restart after a system failure or can be requeued during execution.
|-
| JOB_RETAINED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job has completed but is being retained in the queue.
|-
| JOB_RETENTION || style="text-align:center;" | String || TRUE or FALSE to indicate whether the user requested that the job be retained indefinitely in the queue regardless of the job's completion status.
|-
| JOB_RETENTION_TIME || style="text-align:center;" | String || Returns the system time until which the user requested the job be retained in the queue. The system time may be expressed in either absolute or delta time format.
|-
| JOB_SIZE || style="text-align:center;" | Integer || The total number of blocks in the specified print job.
|-
| JOB_SIZE_MAXIMUM || style="text-align:center;" | Integer || The maximum number of blocks that a print job initiated from the specified queue can contain. This item code is applicable only to output execution queues.
|-
| JOB_SIZE_MINIMUM || style="text-align:center;" | Integer || The minimum number of blocks that a print job initiated from the specified queue can contain. This item code is applicable only to output execution queues.
|-
| JOB_STALLED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the specified job is stalled because the physical device on which the job is printing is stalled.
|-
| JOB_STARTING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job controller is starting to process the job and has begun communicating with an output symbiont or a job controller on another node.
|-
| JOB_STATUS || style="text-align:center;" | Integer || The specified job's status flags. The integer represents a bit field. To find the settings of each bit in the field, use one of the following items in place of JOB_STATUS:
|-
| JOB_SUSPENDED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job is suspended.
|-
| JOB_TIMED_RELEASE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job is waiting for a specified time to execute.
|-
| JOB_WSDEFAULT || style="text-align:center;" | String || TRUE or FALSE to indicate whether a default working set size is specified for the job.
|-
| JOB_WSEXTENT || style="text-align:center;" | String || TRUE or FALSE to indicate whether a working set extent is specified for the job.
|-
| JOB_WSQUOTA || style="text-align:center;" | String || TRUE or FALSE to indicate whether a working set quota is specified for the job.
|-
| LAST_PAGE || style="text-align:center;" | Integer || The page number at which the printing of the specified file should end. This item code is applicable only to output execution queues.
|-
| LIBRARY_SPECIFICATION || style="text-align:center;" | String || The name of the device control library for the specified queue. The library specification assumes the device and directory name SYS$LIBRARY and a file type of .TLB. This item code is meaningful only for output execution queues.
|-
| LOG_QUEUE || style="text-align:center;" | String || The name of the queue into which the log file produced for the specified batch job is to be entered for printing. This item code is applicable only to batch jobs.
|-
| LOG_SPECIFICATION || style="text-align:center;" | String || The name of the log file specified for a job. This item code is meaningful only for batch jobs that were submitted using the /LOG qualifier. If the batch job log was created by default, an empty string will be returned. Use the JOB_LOG_NULL item code to determine whether a log file will be produced.
|-
| MANAGER_NAME || style="text-align:center;" | String || The queue manager name.
|-
| MANAGER_NODES || style="text-align:center;" | String || The names of the nodes on which the queue manager may run.
|-
| MANAGER_STATUS || style="text-align:center;" | Integer || The specified queue manager's status flags. To find the settings of each bit in the field, use one of the following items in place of MANAGER_STATUS:
* MANAGER_FAILOVER
* MANAGER_RUNNING
* MANAGER_START_PENDING
* MANAGER_STARTING
* MANAGER_STOPPED
* MANAGER_STOPPING
|-
| NOTE || style="text-align:center;" | String || The note that is to be printed on the job flag and file flag pages of the specified job. This item code is meaningful only for output execution queues.
|-
| OPERATOR_REQUEST || style="text-align:center;" | String || The message that is to be sent to the queue operator before the specified job begins to execute. This item code is meaningful only for output execution queues.
|-
| OWNER_UIC || style="text-align:center;" | String || The owner user identification code (UIC) of the specified queue.
|-
| PAGE_SETUP_MODULES || style="text-align:center;" | String || The names of the text modules to be extracted from the device control library and copied to the printer before each page of the specified form is printed.
|-
| PARAMETER_1 to PARAMETER_8 || style="text-align:center;" | String || The value of the user-defined parameters that become the value of the DCL symbols P1 to P8 respectively.
|-
| PENDING_JOB_BLOCK_COUNT || style="text-align:center;" | Integer || The total number of blocks for all pending jobs in the queue (valid only for output execution queues).
|-
| PENDING_JOB_COUNT || style="text-align:center;" | Integer || The number of jobs in the queue in a pending state.
|-
| PENDING_JOB_REASON || style="text-align:center;" | Integer || The reason that the job is in a pending state. The integer represents a bit field. To find the settings of each bit in the field, use one of the following items in place of PENDING_JOB_REASON:
|-
| PEND_CHAR_MISMATCH || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job requires characteristics that are not available on the execution queue.
|-
| PEND_JOB_SIZE_MAX || style="text-align:center;" | String || TRUE or FALSE to indicate whether the block size of the job exceeds the upper block limit of the execution queue.
|-
| PEND_JOB_SIZE_MIN || style="text-align:center;" | String || TRUE or FALSE to indicate whether the block size of the job is less than the lower limit of the execution queue.
|-
| PEND_LOWERCASE_MISMATCH || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job requires a lowercase printer.
|-
| PEND_NO_ACCESS || style="text-align:center;" | String || TRUE or FALSE to indicate whether the owner of the job does not have access to the execution queue.
|-
| PEND_QUEUE_BUSY || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job is pending because the number of jobs currently executing on the queue equals the job limit for the queue.
|-
| PEND_QUEUE_STATE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the job is pending because the execution queue is not in a running open state.
|-
| PEND_STOCK_MISMATCH || style="text-align:center;" | String || TRUE or FALSE to indicate whether the stock type required by the job's form does not match the stock type of the form mounted on the execution queue.
|-
| PRIORITY || style="text-align:center;" | Integer || The scheduling priority of the specified job.
|-
| PROCESSOR || style="text-align:center;" | String || The name of the symbiont image that executes print jobs initiated from the specified queue.
|-
| PROTECTION || style="text-align:center;" | String || The specified queue's protection mask.
|-
| QUEUE_ACL_SPECIFIED || style="text-align:center;" | String || TRUE or FALSE to indicate whether an access control list has been specified for the queue.
|-
| QUEUE_ALIGNING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the queue is currently printing alignment pages. A queue prints alignment pages when it is restarted from a paused state by using the command START/QUEUE/ALIGN.
|-
| QUEUE_AUTOSTART || style="text-align:center;" | String || TRUE or FALSE if the specified queue has been designated as an AUTOSTART queue.
|-
| QUEUE_AUTOSTART_INACTIVE || style="text-align:center;" | String || TRUE or FALSE if the queue is an autostart queue that will not be automatically started. If TRUE, a START/QUEUE or INIT/QUEUE/START command must be issued to restart the queue.
|-
| QUEUE_AVAILABLE || style="text-align:center;" | String || TRUE or FALSE if the queue is processing one or more jobs but is capable of processing one or more additional jobs.
|-
| QUEUE_BATCH || style="text-align:center;" | String || TRUE or FALSE to indicate whether the queue is a batch queue or a generic batch queue.
|-
| QUEUE_BUSY || style="text-align:center;" | String || TRUE or FALSE if the number of jobs currently executing on the queue equals the job limit for the queue.
|-
| QUEUE_CLOSED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the queue is closed and will not accept new jobs until the queue is put in an open state.
|-
| QUEUE_CPU_DEFAULT || style="text-align:center;" | String || TRUE or FALSE to indicate whether a default CPU time limit has been specified for all jobs in the queue.
|-
| QUEUE_CPU_LIMIT || style="text-align:center;" | String || TRUE or FALSE to indicate whether a maximum CPU time limit has been specified for all jobs in the queue.
|-
| QUEUE_DESCRIPTION || style="text-align:center;" | String || The description of the queue that was defined by using the /DESCRIPTION qualifier with the INITIALIZE/QUEUE command.
|-
| QUEUE_DIRECTORY || style="text-align:center;" | String || The device and directory specification of the queue database directory for the queue manager.
|-
| QUEUE_FILE_BURST || style="text-align:center;" | String || TRUE or FALSE to indicate whether burst and flag pages precede each file in each job initiated from the queue.
|-
| QUEUE_FILE_BURST_ONE || style="text-align:center;" | String || TRUE or FALSE to indicate whether burst and flag pages precede only the first copy of the first file in each job initiated from the queue.
|-
| QUEUE_FILE_FLAG || style="text-align:center;" | String || TRUE or FALSE to indicate whether a flag page precedes each file in each job initiated from the queue.
|-
| QUEUE_FILE_FLAG_ONE || style="text-align:center;" | String || TRUE or FALSE to indicate whether a flag page precedes only the first copy of the first file in each job initiated from the queue.
|-
| QUEUE_FILE_PAGINATE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the output symbiont paginates output for each job initiated from this queue. The output symbiont paginates output by inserting a form feed whenever output reaches the bottom margin of the form.
|-
| QUEUE_FILE_TRAILER || style="text-align:center;" | String || TRUE or FALSE to indicate whether a trailer page follows each file in each job initiated from the queue.
|-
| QUEUE_FILE_TRAILER_ONE || style="text-align:center;" | String || TRUE or FALSE to indicate whether a trailer page follows only the last copy of the last file in each job initiated from the queue.
|-
| QUEUE_FLAGS || style="text-align:center;" | Integer || The processing options that have been selected for the specified queue. The integer represents a bit field. To find the settings of each bit in the field, use one of the following items in place of QUEUE_FLAGS:
|-
| QUEUE_GENERIC || style="text-align:center;" | String || TRUE or FALSE to indicate whether the queue is a generic queue.
|-
| QUEUE_GENERIC_SELECTION || style="text-align:center;" | String || TRUE or FALSE to indicate whether the queue is an execution queue that can accept work from a generic queue.
|-
| QUEUE_IDLE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the queue is not processing any jobs and is capable of doing so or whether the generic queue is capable of feeding executor queues.
|-
| QUEUE_JOB_BURST || style="text-align:center;" | String || TRUE or FALSE to indicate whether burst and flag pages precede each job initiated from the queue.
|-
| QUEUE_JOB_FLAG || style="text-align:center;" | String || TRUE or FALSE to indicate whether a flag page precedes each job initiated from the queue.
|-
| QUEUE_JOB_SIZE_SCHED || style="text-align:center;" | String || TRUE or FALSE to indicate whether jobs initiated from the queue are scheduled according to size with the smallest job of a given priority processed first. (Meaningful only for output queues.)
|-
| QUEUE_JOB_TRAILER || style="text-align:center;" | String || TRUE or FALSE to indicate whether a trailer page follows each job initiated from the queue.
|-
| QUEUE_LOWERCASE || style="text-align:center;" | String || TRUE or FALSE to indicate whether queue is associated with a printer that can print both uppercase and lowercase characters.
|-
| QUEUE_NAME || style="text-align:center;" | String || The name of the specified queue or the name of the queue that contains the specified job.
|-
| QUEUE_PAUSED || style="text-align:center;" | String || TRUE or FALSE to indicate whether execution of all current jobs in the queue is temporarily halted.
|-
| QUEUE_PAUSING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the queue is temporarily halting execution. Currently executing jobs are completing; temporarily, no new jobs can begin executing.
|-
| QUEUE_PRINTER || style="text-align:center;" | String || TRUE or FALSE to indicate whether the queue is a printer queue.
|-
| QUEUE_RECORD_BLOCKING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the symbiont is permitted to concatenate, or block together, the output records it sends to the output device.
|-
| QUEUE_REMOTE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the queue is assigned to a physical device that is not connected to the local node.
|-
| QUEUE_RESETTING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the queue is resetting and stopping.
|-
| QUEUE_RESUMING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the queue is restarting after pausing.
|-
| QUEUE_RETAIN_ALL || style="text-align:center;" | String || TRUE or FALSE to indicate whether all jobs initiated from the queue remain in the queue after they finish executing. Completed jobs are marked with a completion status.
|-
| QUEUE_RETAIN_ERROR || style="text-align:center;" | String || TRUE or FALSE to indicate whether only jobs that do not complete successfully are retained in the queue.
|-
| QUEUE_SERVER || style="text-align:center;" | String || TRUE or FALSE to indicate whether queue processing is directed to a server symbiont.
|-
| QUEUE_STALLED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the physical device to which the queue is assigned is stalled; that is, the device has not completed the last I/O request submitted to it.
|-
| QUEUE_STARTING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the queue is starting.
|-
| QUEUE_STATUS || style="text-align:center;" | Integer || The specified queue's status flags. The integer represents a bit field. To find the settings of each bit in the field, use one of the following items in place of QUEUE_STATUS:
|-
| QUEUE_STOP_PENDING || style="text-align:center;" | String || TRUE or FALSE if queue will be stopped when jobs currently in progress have completed.
|-
| QUEUE_STOPPED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the queue is stopped.
|-
| QUEUE_STOPPING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the queue is stopping.
|-
| QUEUE_SWAP || style="text-align:center;" | String || TRUE or FALSE to indicate whether jobs initiated from the queue can be swapped.
|-
| QUEUE_TERMINAL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the queue is a terminal queue.
|-
| QUEUE_UNAVAILABLE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the physical device to which queue is assigned is not available.
|-
| QUEUE_WSDEFAULT || style="text-align:center;" | String || TRUE or FALSE to indicate whether a default working set size is specified for each job initiated from the queue.
|-
| QUEUE_WSEXTENT || style="text-align:center;" | String || TRUE or FALSE to indicate whether a working set extent is specified for each job initiated from the queue.
|-
| QUEUE_WSQUOTA || style="text-align:center;" | String || TRUE or FALSE to indicate whether a working set quota is specified for each job initiated from the queue.
|-
| RAD || style="text-align:center;" | Integer || Value of the RAD. A value of "-1" indicates no RAD value is attributed to the queue. RAD is supported on AlphaServer GS series systems and starting from OpenVMS Version 8.4, support is extended to NUMA capable Integrity servers.
|-
| REQUEUE_QUEUE_NAME || style="text-align:center;" | String || The name of the queue to which the specified job is reassigned.
|-
| RESTART_QUEUE_NAME || style="text-align:center;" | String || The name of the queue in which the job will be placed if the job is restarted.
|-
| RETAINED_JOB_COUNT || style="text-align:center;" | Integer || The number of jobs in the queue retained after successful completion plus those retained on error.
|-
| SCSNODE_NAME || style="text-align:center;" | String || The 6-byte name of the VMS node on which jobs initiated from the specified queue execute. The node name matches the value of the system parameter SCSNODE for the target node.
|-
| SECURITY_INACCESSIBLE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the user has read access to the specified queue.
|-
| SUBMISSION_TIME || style="text-align:center;" | String || The time at which the specified job was submitted to the queue.
|-
| TIMED_RELEASE_JOB_COUNT || style="text-align:center;" | Integer || The number of jobs in the queue on hold until a specified time.
|-
| UIC || style="text-align:center;" | String || The user identification code (UIC) of the owner of the specified job.
|-
| USERNAME || style="text-align:center;" | String || The user name of the owner of the specified job.
|-
| WSDEFAULT || style="text-align:center;" | Integer || The default working set size specified for the specified job or queue. This value is meaningful only for batch jobs and execution and output queues.
|-
| WSEXTENT || style="text-align:center;" | Integer || The working set extent specified for the specified job or queue. This value is meaningful only for batch jobs and execution and output queues.
|-
| WSQUOTA || style="text-align:center;" | Integer || The working set quota for the specified job or queue. This value is meaningful only for batch jobs and execution and output queues.
|}

Files-11

2018-08-23T06:44:22Z

Maxim Megalinskiy: /* LInux interaction */

Files-11 or the On-Disk Structure was developed by the Digital Equipment Corporation for RSX-11 and later for OpenVMS. This family consists of the following file systems:
* ODS-1
* ODS-2
* ODS-3
* ODS-4
* ODS-5
=ODS-1=
ODS-1 is the oldest one that is supported by OpenVMS only for RSX compatibility
=ODS-2=
ODS-2 is the standard file system that has case-insensitive filenames maximum length of the file name is 39 characters, supports page file, swap file, parameter (.PAR) file and other system files and files shared across a cluster with any version of VMS. It is supported by all hardware architectures.
=ODS-3=
ODS-3 is designed to support ISO 9660.

=ODS-4=
ODS-4 is designed to support the High Sierra file system
=ODS-5=
ODS-5 is an extended version of ODS-2 used on Alpha and Integrity. It supports longer case-sensitive filenames with non-ASCII characters (ISO Latin-1 and Unicode). Page file, swap file, parameter file and other system files are not supported, but ODS-5 volumes can serve as system disks starting with VMS 7.3-1. ODS-5 disks can be mounted by computers running OpenVMS 7.2 or later. ODS-5 also offers more levels of directory structure.
=Looking up the file system=
To find out what file system is a particular device, use:
* SHOW DEVICE/FULL:

<pre>$ show dev dka0 /full

Disk SMAN01$DKA0:, device type RZ73, is online, mounted, file-oriented device,
shareable, available to cluster, error logging is enabled.

Error count 0 Operations completed 3983
Owner process "" Owner UIC [SYSTEM]
Owner process ID 00000000 Dev Prot S:RWPL,O:RWPL,G:R,W
Reference count 85 Default buffer size 512
Total blocks 3907911 Sectors per track 7
Total cylinders 2621 Tracks per cylinder 213
Logical Volume Size 3907911 Expansion Size Limit 4261348350

Volume label "ALPHASYS" Relative volume number 0
Cluster size 16 Transaction count 214
Free blocks 1874592 Maximum files allowed 16711679
Extend quantity 5 Mount count 1
Mount status System Cache name "_SMAN01$DKA0:XQPCACHE"
Extent cache size 64 Max blocks in extent cache 187459
File ID cache size 64 Blocks in extent cache 66496
Quota cache size 0 Maximum buffers in FCP cache 574
Volume owner UIC [1,1] Vol Prot S:RWCD,O:RWCD,G:RWCD,W:RWCD

Volume Status: ODS-2, subject to mount verification, protected subsystems
enabled, file high-water marking, write-through XFC caching enabled,
write-through XQP caching enabled.</pre>

* f$getdvi("dka0","ODS5")
Returns TRUE if the volume is ODS-5 and FALSE if it is not (which in reality almost always means that it's ODS-2).

==Linux interaction==
Files-11 are OpenVMS-specific file systems and there are differences between filenames in OpenVMS and other operating systems like Linux, which creates difficulties when accessing files via FTP and network-based file sharing utilities.
One of the problems is escaping unusual characters that have special meanings in the file specification or otherwise:
* period
* comma
* colon
* semicolon
* square brackets
* percent sign
* circumflex (up arrow)
* ampersand
The circumflex is an escape character used to make sure that the system parses the symbols above as part of the filename and not special character in the specification.
If you don’t use the circumflex, the system will try its best to determine if the character you used is a delimiter or part of the filename: for instance, if there are several periods, the last one will likely be interpreted as the version number if it is followed by numeric characters and/or minus signs.
If you are interested in studying this topic in more detail, refer to the OpenVMS Guide to extended file specifications.

Files-11

2018-08-23T06:43:37Z

Maxim Megalinskiy: /* ODS-3 */

Files-11 or the On-Disk Structure was developed by the Digital Equipment Corporation for RSX-11 and later for OpenVMS. This family consists of the following file systems:
* ODS-1
* ODS-2
* ODS-3
* ODS-4
* ODS-5
=ODS-1=
ODS-1 is the oldest one that is supported by OpenVMS only for RSX compatibility
=ODS-2=
ODS-2 is the standard file system that has case-insensitive filenames maximum length of the file name is 39 characters, supports page file, swap file, parameter (.PAR) file and other system files and files shared across a cluster with any version of VMS. It is supported by all hardware architectures.
=ODS-3=
ODS-3 is designed to support ISO 9660.

=ODS-4=
ODS-4 is designed to support the High Sierra file system
=ODS-5=
ODS-5 is an extended version of ODS-2 used on Alpha and Integrity. It supports longer case-sensitive filenames with non-ASCII characters (ISO Latin-1 and Unicode). Page file, swap file, parameter file and other system files are not supported, but ODS-5 volumes can serve as system disks starting with VMS 7.3-1. ODS-5 disks can be mounted by computers running OpenVMS 7.2 or later. ODS-5 also offers more levels of directory structure.
=Looking up the file system=
To find out what file system is a particular device, use:
* SHOW DEVICE/FULL:

<pre>$ show dev dka0 /full

Disk SMAN01$DKA0:, device type RZ73, is online, mounted, file-oriented device,
shareable, available to cluster, error logging is enabled.

Error count 0 Operations completed 3983
Owner process "" Owner UIC [SYSTEM]
Owner process ID 00000000 Dev Prot S:RWPL,O:RWPL,G:R,W
Reference count 85 Default buffer size 512
Total blocks 3907911 Sectors per track 7
Total cylinders 2621 Tracks per cylinder 213
Logical Volume Size 3907911 Expansion Size Limit 4261348350

Volume label "ALPHASYS" Relative volume number 0
Cluster size 16 Transaction count 214
Free blocks 1874592 Maximum files allowed 16711679
Extend quantity 5 Mount count 1
Mount status System Cache name "_SMAN01$DKA0:XQPCACHE"
Extent cache size 64 Max blocks in extent cache 187459
File ID cache size 64 Blocks in extent cache 66496
Quota cache size 0 Maximum buffers in FCP cache 574
Volume owner UIC [1,1] Vol Prot S:RWCD,O:RWCD,G:RWCD,W:RWCD

Volume Status: ODS-2, subject to mount verification, protected subsystems
enabled, file high-water marking, write-through XFC caching enabled,
write-through XQP caching enabled.</pre>

* f$getdvi("dka0","ODS5")
Returns TRUE if the volume is ODS-5 and FALSE if it is not (which in reality almost always means that it's ODS-2).

==LInux interaction==
Files-11 are OpenVMS-specific file systems and there are differences between filenames in OpenVMS and other operating systems like Linux, which creates difficulties when accessing files via FTP and network-based file sharing utilities.
One of the problems is escaping unusual characters that have special meanings in the file specification or otherwise:
* period
* comma
* colon
* semicolon
* square brackets
* percent sign
* circumflex (up arrow)
* ampersand
The circumflex is an escape character used to make sure that the system parses the symbols above as part of the filename and not special character in the specification.
If you don’t use the circumflex, the system will try its best to determine if the character you used is a delimiter or part of the filename: for instance, if there are several periods, the last one will likely be interpreted as the version number if it is followed by numeric characters and/or minus signs.
If you are interested in studying this topic in more detail, refer to the OpenVMS Guide to extended file specifications.