F$GETQUI() - Revision history

Jane.doe at 15:35, 26 November 2019

2019-11-26T15:35:21Z

@@ Line 56: / Line 56: @@
 ==flags==
-Specifies a list of keywords, separated by commas, that corresponds to the flags defined for the $GETQUI system service [[QUI$_SEARCH_FLAGS input item codes|QUI$_SEARCH_FLAGS input item code]]. (These flags are used to define the scope of the object search specified in the call to the $GETQUI system service.) Note that the keywords can be used only with certain function codes.
+Specifies a list of keywords, separated by commas, that corresponds to the flags defined for the $GETQUI system service (see the table below). These flags are used to define the scope of the object search specified in the call to the $GETQUI system service. Note that the keywords can be used only with certain function codes; see the function pages for details.
 =See also=

Jane.doe at 14:21, 26 November 2019

2019-11-26T14:21:43Z

← Older revision		Revision as of 14:21, 26 November 2019
Line 21:		Line 21:
	\| [[DISPLAY_CHARACTERISTIC]] \|\| Returns information about a specific characteristic definition or the next characteristic definition in a wildcard operation.		\| [[DISPLAY_CHARACTERISTIC]] \|\| Returns information about a specific characteristic definition or the next characteristic definition in a wildcard operation.
	\|-		\|-
	\| [[DISPLAY_ENTRY]] \|\| Returns information about a specific job entry or the next job entry that matches the selection criteria in a wildcard operation. The DISPLAY_ENTRY function code is similar to the DISPLAY_JOB function code in that both return job information. DISPLAY_JOB, however, requires that a call be made to establish [[~~Queue~~ Context\|queue context]]; DISPLAY_ENTRY does not require that [[~~Queue~~ Context\|queue context]] be established. Only those entries that match the user-name of the current process will be processed.		\| [[DISPLAY_ENTRY]] \|\| Returns information about a specific job entry or the next job entry that matches the selection criteria in a wildcard operation. The DISPLAY_ENTRY function code is similar to the DISPLAY_JOB function code in that both return job information. DISPLAY_JOB, however, requires that a call be made to establish [[F$GETQUI Context\|queue context]]; DISPLAY_ENTRY does not require that [[F$GETQUI Context\|queue context]] be established. Only those entries that match the user-name of the current process will be processed.
	\|-		\|-
	\| [[DISPLAY_FILE]] \|\| Returns information about the next file defined for the current job context. Before you make a call to F$GETQUI to request file information, you must make a call to display queue and job information (with the DISPLAY_QUEUE and DISPLAY_JOB function codes) or to display entry information (with the DISPLAY_ENTRY function code).		\| [[DISPLAY_FILE]] \|\| Returns information about the next file defined for the current job context. Before you make a call to F$GETQUI to request file information, you must make a call to display queue and job information (with the DISPLAY_QUEUE and DISPLAY_JOB function codes) or to display entry information (with the DISPLAY_ENTRY function code).
Line 27:		Line 27:
	\| [[DISPLAY_FORM]] \|\| Returns information about a specific form definition or the next form definition in a wildcard operation.		\| [[DISPLAY_FORM]] \|\| Returns information about a specific form definition or the next form definition in a wildcard operation.
	\|-		\|-
	\| [[DISPLAY_JOB]] \|\| Returns information about the next job defined for the current [[~~Queue~~ Context\|queue context]]. Before you make a call to F$GETQUI to request job information, you must make a call to display queue information (with the DISPLAY_QUEUE function code). The DISPLAY_JOB function code is similar to the DISPLAY_ENTRY function code in that both return job information. DISPLAY_JOB, however, requires that a call be made to establish [[~~Queue~~ Context\|queue context]]; DISPLAY_ENTRY does not require that [[~~Queue~~ Context\|queue context]] be established.		\| [[DISPLAY_JOB]] \|\| Returns information about the next job defined for the current [[F$GETQUI Context\|queue context]]. Before you make a call to F$GETQUI to request job information, you must make a call to display queue information (with the DISPLAY_QUEUE function code). The DISPLAY_JOB function code is similar to the DISPLAY_ENTRY function code in that both return job information. DISPLAY_JOB, however, requires that a call be made to establish [[F$GETQUI Context\|queue context]]; DISPLAY_ENTRY does not require that [[F$GETQUI Context\|queue context]] be established.
	\|-		\|-
	\| [[DISPLAY_MANAGER]] \|\| Returns information about a specific [[Queue manager\|queue manager]] or the next queue manager in a wildcard operation.		\| [[DISPLAY_MANAGER]] \|\| Returns information about a specific [[Queue manager\|queue manager]] or the next queue manager in a wildcard operation.

Jane.doe at 14:21, 26 November 2019

2019-11-26T14:21:04Z

← Older revision		Revision as of 14:21, 26 November 2019
Line 21:		Line 21:
	\| [[DISPLAY_CHARACTERISTIC]] \|\| Returns information about a specific characteristic definition or the next characteristic definition in a wildcard operation.		\| [[DISPLAY_CHARACTERISTIC]] \|\| Returns information about a specific characteristic definition or the next characteristic definition in a wildcard operation.
	\|-		\|-
	\| [[DISPLAY_ENTRY]] \|\| Returns information about a specific job entry or the next job entry that matches the selection criteria in a wildcard operation. The DISPLAY_ENTRY function code is similar to the DISPLAY_JOB function code in that both return job information. DISPLAY_JOB, however, requires that a call be made to establish queue context; DISPLAY_ENTRY does not require that queue context be established. Only those entries that match the user-name of the current process will be processed.		\| [[DISPLAY_ENTRY]] \|\| Returns information about a specific job entry or the next job entry that matches the selection criteria in a wildcard operation. The DISPLAY_ENTRY function code is similar to the DISPLAY_JOB function code in that both return job information. DISPLAY_JOB, however, requires that a call be made to establish [[Queue Context\|queue context]]; DISPLAY_ENTRY does not require that [[Queue Context\|queue context]] be established. Only those entries that match the user-name of the current process will be processed.
	\|-		\|-
	\| [[DISPLAY_FILE]] \|\| Returns information about the next file defined for the current job context. Before you make a call to F$GETQUI to request file information, you must make a call to display queue and job information (with the DISPLAY_QUEUE and DISPLAY_JOB function codes) or to display entry information (with the DISPLAY_ENTRY function code).		\| [[DISPLAY_FILE]] \|\| Returns information about the next file defined for the current job context. Before you make a call to F$GETQUI to request file information, you must make a call to display queue and job information (with the DISPLAY_QUEUE and DISPLAY_JOB function codes) or to display entry information (with the DISPLAY_ENTRY function code).
Line 27:		Line 27:
	\| [[DISPLAY_FORM]] \|\| Returns information about a specific form definition or the next form definition in a wildcard operation.		\| [[DISPLAY_FORM]] \|\| Returns information about a specific form definition or the next form definition in a wildcard operation.
	\|-		\|-
	\| [[DISPLAY_JOB]] \|\| Returns information about the next job defined for the current queue context. Before you make a call to F$GETQUI to request job information, you must make a call to display queue information (with the DISPLAY_QUEUE function code). The DISPLAY_JOB function code is similar to the DISPLAY_ENTRY function code in that both return job information. DISPLAY_JOB, however, requires that a call be made to establish queue context; DISPLAY_ENTRY does not require that queue context be established.		\| [[DISPLAY_JOB]] \|\| Returns information about the next job defined for the current [[Queue Context\|queue context]]. Before you make a call to F$GETQUI to request job information, you must make a call to display queue information (with the DISPLAY_QUEUE function code). The DISPLAY_JOB function code is similar to the DISPLAY_ENTRY function code in that both return job information. DISPLAY_JOB, however, requires that a call be made to establish [[Queue Context\|queue context]]; DISPLAY_ENTRY does not require that [[Queue Context\|queue context]] be established.
	\|-		\|-
	\| [[DISPLAY_MANAGER]] \|\| Returns information about a specific [[Queue manager\|queue manager]] or the next queue manager in a wildcard operation.		\| [[DISPLAY_MANAGER]] \|\| Returns information about a specific [[Queue manager\|queue manager]] or the next queue manager in a wildcard operation.

Jane.doe: /* object-id */

2019-11-26T14:09:50Z

object-id

← Older revision		Revision as of 14:09, 26 November 2019
Line 44:		Line 44:
	==object-id==		==object-id==

	~~Corresponds to the $GETQUI system service QUI$SEARCH_NAME, QUI$_SEARCH_NUMBER, and QUI$_SEARCH_JOB_NAME input item codes.~~ The object-id argument specifies either the name or the number of an object (for example, a specific queue name, job name, or form number) about which F$GETQUI is to return information. ~~The asterisk~~ (*) and ~~the~~ percent ~~sign~~ (%) ~~wildcard characters~~ are allowed ~~for~~ the following functions:		The object-id argument specifies either the name or the number of an object (for example, a specific queue name, job name, or form number) about which F$GETQUI is to return information or in some cases the wildcard characters. Wildcards (asterisks (*) and percent signs (%)) are allowed with the following functions:

	DISPLAY_CHARACTERISTIC		* DISPLAY_CHARACTERISTIC
	DISPLAY_ENTRY		* DISPLAY_ENTRY
	DISPLAY_FORM		* DISPLAY_FORM
	DISPLAY_MANAGER		* DISPLAY_MANAGER
	DISPLAY_QUEUE		* DISPLAY_QUEUE

	~~By specifying an asterisk (*) or percent sign (%)~~ wildcard ~~character as the~~ object~~-id argument on successive calls~~, ~~you can get status information about one or more jobs in a specific queue or about files within jobs in a specific queue~~. When a name is used with wildcard characters, each call returns information for the next object (queue, form, and so on) in the list. A null string ("") is returned when the end of the list is reached~~. A wildcard can represent only object names, not object numbers~~.		A wildcard can represent only object names, not object numbers. When a name is used with wildcard characters, each call returns information for the next object (queue, form, and so on) in the list. A null string ("") is returned when the end of the list is reached.

	==flags==		==flags==

Jane.doe: /* function */

2019-11-26T14:08:03Z

function

@@ Line 36: / Line 36: @@
 |}
-Some function arguments cannot be specified with the item-code, the object-id, or the flags argument. The following table lists each function argument and corresponding format line to show whether the item-code, object-id, and flags arguments are required, optional, or not applicable for that specific function. In the following format lines, brackets ([ ]) denote an optional argument. An omitted argument means the argument is not applicable for that function. Note that two commas (,,) must be used as placeholders to denote an omitted (whether optional or not applicable) argument.
+Some function arguments cannot be specified with the item-code, the object-id, or the flags argument. See the function pages for the exact syntax.
 ==item==

Jane.doe: /* Format */

2019-11-26T08:19:40Z

Format

← Older revision		Revision as of 08:19, 26 November 2019
Line 3:		Line 3:
	=Format=		=Format=

	F$GETQUI (function,[[F$GETQUI()#item\|[item]]],[[F$GETQUI()#object-id\|[object-id]]],[[F$GETQUI()#flags\|[flags]]])		F$GETQUI ([[F$GETQUI()#function\|function]],[[F$GETQUI()#item\|[item]]],[[F$GETQUI()#object-id\|[object-id]]],[[F$GETQUI()#flags\|[flags]]])

	Brackets ([]) denote an optional argument. Some function arguments cannot be specified with the item-code, the object-id, or the flags argument; visit the [[F$GETQUI()#function\|function section]] below for more information.		Brackets ([]) denote an optional argument. Some function arguments cannot be specified with the item-code, the object-id, or the flags argument; visit the [[F$GETQUI()#function\|function section]] below for more information.

Jane.doe at 08:18, 26 November 2019

2019-11-26T08:18:43Z

← Older revision		Revision as of 08:18, 26 November 2019
Line 82:		Line 82:

	=See also=		=See also=
	* [[http://www.migrationspecialties.com/pdf/VTJ_F$GETQUI.pdf\| F$GETQUI to the Rescue]], Bruce Claremont's article for OpenVMS Technical Journal V11		* [http://www.migrationspecialties.com/pdf/VTJ_F$GETQUI.pdf\| F$GETQUI to the Rescue, Bruce Claremont's article for OpenVMS Technical Journal V11]

	[[Category: Lexical Functions]]		[[Category: Lexical Functions]]

Darya.zelenina at 05:47, 15 January 2019

2019-01-15T05:47:39Z

← Older revision		Revision as of 05:47, 15 January 2019
Line 83:		Line 83:
	=See also=		=See also=
	* [[http://www.migrationspecialties.com/pdf/VTJ_F$GETQUI.pdf\| F$GETQUI to the Rescue]], Bruce Claremont's article for OpenVMS Technical Journal V11		* [[http://www.migrationspecialties.com/pdf/VTJ_F$GETQUI.pdf\| F$GETQUI to the Rescue]], Bruce Claremont's article for OpenVMS Technical Journal V11

			[[Category: Lexical Functions]]

Darya.zelenina at 11:37, 22 August 2018

2018-08-22T11:37:31Z

← Older revision		Revision as of 11:37, 22 August 2018
Line 4:		Line 4:

	F$GETQUI (function,[[F$GETQUI()#item\|[item]]],[[F$GETQUI()#object-id\|[object-id]]],[[F$GETQUI()#flags\|[flags]]])		F$GETQUI (function,[[F$GETQUI()#item\|[item]]],[[F$GETQUI()#object-id\|[object-id]]],[[F$GETQUI()#flags\|[flags]]])



	Brackets ([]) denote an optional argument. Some function arguments cannot be specified with the item-code, the object-id, or the flags argument; visit the [[F$GETQUI()#function\|function section]] below for more information.		Brackets ([]) denote an optional argument. Some function arguments cannot be specified with the item-code, the object-id, or the flags argument; visit the [[F$GETQUI()#function\|function section]] below for more information.
Line 31:		Line 29:
	\| [[DISPLAY_JOB]] \|\| Returns information about the next job defined for the current queue context. Before you make a call to F$GETQUI to request job information, you must make a call to display queue information (with the DISPLAY_QUEUE function code). The DISPLAY_JOB function code is similar to the DISPLAY_ENTRY function code in that both return job information. DISPLAY_JOB, however, requires that a call be made to establish queue context; DISPLAY_ENTRY does not require that queue context be established.		\| [[DISPLAY_JOB]] \|\| Returns information about the next job defined for the current queue context. Before you make a call to F$GETQUI to request job information, you must make a call to display queue information (with the DISPLAY_QUEUE function code). The DISPLAY_JOB function code is similar to the DISPLAY_ENTRY function code in that both return job information. DISPLAY_JOB, however, requires that a call be made to establish queue context; DISPLAY_ENTRY does not require that queue context be established.
	\|-		\|-
	\| [[DISPLAY_MANAGER]] \|\| Returns information about a specific queue manager or the next queue manager in a wildcard operation.		\| [[DISPLAY_MANAGER]] \|\| Returns information about a specific [[Queue manager\|queue manager]] or the next queue manager in a wildcard operation.
	\|-		\|-
	\| [[DISPLAY_QUEUE]] \|\| Returns information about a specific queue definition or the next queue definition in a wildcard operation.		\| [[DISPLAY_QUEUE]] \|\| Returns information about a specific [[Queue\|queue]] definition or the next queue definition in a wildcard operation.
	\|-		\|-
	\| [[TRANSLATE_QUEUE]] \|\| Translates a logical name for a queue to the equivalence name for the queue.		\| [[TRANSLATE_QUEUE]] \|\| Translates a logical name for a queue to the equivalence name for the queue.

Darya.zelenina at 11:16, 22 August 2018

2018-08-22T11:16:45Z

← Older revision		Revision as of 11:16, 22 August 2018
Line 82:		Line 82:

	Specifies a list of keywords, separated by commas, that corresponds to the flags defined for the $GETQUI system service [[QUI$_SEARCH_FLAGS input item codes\|QUI$_SEARCH_FLAGS input item code]]. (These flags are used to define the scope of the object search specified in the call to the $GETQUI system service.) Note that the keywords can be used only with certain function codes.		Specifies a list of keywords, separated by commas, that corresponds to the flags defined for the $GETQUI system service [[QUI$_SEARCH_FLAGS input item codes\|QUI$_SEARCH_FLAGS input item code]]. (These flags are used to define the scope of the object search specified in the call to the $GETQUI system service.) Note that the keywords can be used only with certain function codes.

			=See also=
			* [[http://www.migrationspecialties.com/pdf/VTJ_F$GETQUI.pdf\| F$GETQUI to the Rescue]], Bruce Claremont's article for OpenVMS Technical Journal V11