Lexical functions - Revision history

Snadow: Corrected minor error. "Note that you must use the brackets..." changed to "Note that you must use the parentheses..."

2020-01-07T17:24:50Z

Corrected minor error. "Note that you must use the brackets..." changed to "Note that you must use the parentheses..."

← Older revision		Revision as of 17:24, 7 January 2020
Line 5:		Line 5:
	F$function-name([args,...])		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.		Note that you must use the parentheses 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 by topic=

Jane.doe: /* Privileges */

2019-11-26T15:24:55Z

Privileges

← Older revision		Revision as of 15:24, 26 November 2019
Line 110:		Line 110:

	===Privileges===		===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$SETPRV()]] sets the specified [[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.		* [[F$PRIVILEGE()]] returns a value of TRUE or FALSE depending on whether your current process privileges match the privileges listed in the argument.

	==Licenses==		==Licenses==
	* [[F$LICENSE()]] checks whether the specified [[Licensing\|license]] is loaded on the system.		* [[F$LICENSE()]] checks whether the specified [[Licensing\|license]] is loaded on the system.

Jane.doe: /* Conversion and data types */

2019-11-26T15:05:14Z

Conversion and data types

← Older revision		Revision as of 15:05, 26 November 2019
Line 13:		Line 13:
	==Conversion and data types==		==Conversion and data types==
	* [[F$STRING()]] returns the string equivalent of the result of the specified expression.		* [[F$STRING()]] returns the string equivalent of the result of the specified expression.
	<~~pre~~>$ ~~write sys~~$~~output f$string~~(5)		<nowiki>
	5</~~pre~~>		$ A = F$STRING(5)
			$ SHOW SYM A
			A = "5"
			</nowiki>
	* [[F$INTEGER()]] returns the integer equivalent of the result of the specified expression.		* [[F$INTEGER()]] returns the integer equivalent of the result of the specified expression.
	<pre>$ write sys$output f$integer("y")		<pre>$ write sys$output f$integer("y")

Darya.zelenina: fixed a link

2019-06-04T06:21:16Z

fixed a link

← Older revision		Revision as of 06:21, 4 June 2019
Line 94:		Line 94:

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

	==User environment==		==User environment==

Darya.zelenina: moved F$MATCH_WILD operations and renamed Miscellaneous to Licensing thereby eliminating the Miscellaneous category of lexical functions

2019-04-05T10:12:08Z

moved F$MATCH_WILD operations and renamed Miscellaneous to Licensing thereby eliminating the Miscellaneous category of lexical functions

← Older revision		Revision as of 10:12, 5 April 2019
Line 62:		Line 62:
	<pre>$ WRITE SYS$OUTPUT F$EDIT(" HELLO ","COLLAPSE,LOWERCASE")		<pre>$ WRITE SYS$OUTPUT F$EDIT(" HELLO ","COLLAPSE,LOWERCASE")
	hello</pre>		hello</pre>

			* [[F$MATCH_WILD()]] performs a wildcard matching between a candidate and a pattern string.

	==Files==		==Files==
Line 103:		Line 105:
	* [[F$ENVIRONMENT()]] obtains information about the DCL command environment.		* [[F$ENVIRONMENT()]] obtains information about the DCL command environment.
	* [[F$DIRECTORY()]] returns the current [[Default directory\|default]] directory name string.		* [[F$DIRECTORY()]] returns the current [[Default directory\|default]] directory name string.

	===Privileges===		===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$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.		* [[F$PRIVILEGE()]] returns a value of TRUE or FALSE depending on whether your current process privileges match the privileges listed in the argument.

	==~~Miscellaneous~~==		==Licenses==
	* [[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.
	* [[f$LICENSE()]] checks whether the specified [[Licensing\|license]] is loaded on the system.

Maxim Megalinskiy: /* String operations */

2018-10-19T12:32:45Z

String operations

← Older revision		Revision as of 12:32, 19 October 2018
Line 50:		Line 50:
	* [[F$EXTRACT()]] extracts a substring from a character string expression.		* [[F$EXTRACT()]] extracts a substring from a character string expression.

	<pre>$ WRITE SYS$OUTPUT F$EXTRACT("1,2,"HELLO")		<pre>$ WRITE SYS$OUTPUT F$EXTRACT("1",2,"HELLO")
	EL		EL
	</pre>		</pre>
Line 62:		Line 62:
	<pre>$ WRITE SYS$OUTPUT F$EDIT(" HELLO ","COLLAPSE,LOWERCASE")		<pre>$ WRITE SYS$OUTPUT F$EDIT(" HELLO ","COLLAPSE,LOWERCASE")
	hello</pre>		hello</pre>


	==Files==		==Files==

Darya.zelenina at 11:33, 24 August 2018

2018-08-24T11:33:28Z

← Older revision		Revision as of 11:33, 24 August 2018
Line 93:		Line 93:

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

	==User environment==		==User environment==

Darya.zelenina at 10:38, 23 August 2018

2018-08-23T10:38:15Z

← Older revision		Revision as of 10:38, 23 August 2018
Line 108:		Line 108:
	* [[F$PRIVILEGE()]] returns a value of TRUE or FALSE depending on whether your current process privileges match the privileges listed in the argument.		* [[F$PRIVILEGE()]] returns a value of TRUE or FALSE depending on whether your current process privileges match the privileges listed in the argument.

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

Darya.zelenina: /* See also */

2018-08-23T10:38:00Z

Darya.zelenina at 12:18, 22 August 2018

2018-08-22T12:18:26Z

← Older revision		Revision as of 10:38, 23 August 2018
Line 111:		Line 111:
	* [[F$MATCH_WILD()]] performs a wildcard matching between a candidate and a pattern string.		* [[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.		* [[f$LICENSE()]] checks whether the specified [[Licensing\|license]] is loaded on the system.

	~~=See also=~~

	~~[[Alphabetic list of lexical functions]]~~

← Older revision		Revision as of 12:18, 22 August 2018
Line 68:		Line 68:
	* [[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$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$FILE_ATTRIBUTES()]] returns attribute information for a specified file.
	* [[F$FID_TO_NAME()]] translates a file identification to a file specification.		* [[F$FID_TO_NAME()]] translates a file identification to a [[File specification\|file specification]].

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

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

	==Time==		==Time==
Line 96:		Line 96:

	==User environment==		==User environment==
	* [[F$USER()]] returns the current user's UIC		* [[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$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$PROCESS()]] returns the current process name string.
	* [[F$MODE()]] shows the mode in which a process is executing.		* [[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$MESSAGE()]] returns the message text associated with a specified system status code value.
	* [[F$~~GETWNV~~()]] returns the value of the specified console environment variable.		* [[F$GETENV()]] returns the value of the specified console environment variable.
	* [[F$ENVIRONMENT()]] obtains information about the DCL command environment.		* [[F$ENVIRONMENT()]] obtains information about the DCL command environment.
	* [[F$DIRECTORY()]] returns the current default directory name string.		* [[F$DIRECTORY()]] returns the current [[Default directory\|default]] directory name string.
	===Privileges===		===Privileges===
	* [[F$SETPRV()]] sets the specified privileges and returns a list of keywords indicating the previous state of these privileges for the current process.		* [[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.		* [[F$PRIVILEGE()]] returns a value of TRUE or FALSE depending on whether your current process privileges match the privileges listed in the argument.

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

	=See also=		=See also=

	[[Alphabetic list of lexical functions]]		[[Alphabetic list of lexical functions]]