VioQuerySetIds: Difference between revisions

Latest revision as of 02:31, 2 January 2020

Gets information about VIO local identifiers.

Syntax

VioQuerySetIds (lcids, Names, Types, count, hvps)

Parameters

lcids (PULONG) - output: Array of local identifiers.
Names (PSTR8) - output: An array of 8 character names associated with the lcids.
Types (PULONG) - output: An array of types associated with each lcids.
count (PULONG) - input: Number of objects to be queried.; The maximum value in use is 3.
hvps (HVIO) - input: VIO presentation-space handle.; This is either 0 to indicate the default VIO session, or a value returned by VioCreatePS.

Return Code

rc (APIRET) - returns: VioQuerySetIds returns one of the following values:

0 NO_ERROR
421 ERROR_VIO_INVALID_PARMS
436 ERROR_VIO_INVALID_HANDLE

Remarks

In OS/2 2.x, hvps cannot be 0.

@@ Line 1: / Line 1: @@
-==Description==
 Gets information about VIO local identifiers.
 ==Syntax==
-<PRE>
+  VioQuerySetIds (lcids, Names, Types, count, hvps)
-#define INCL_VIO
-#include <os2.h>
-PULONG    lcids;  /*  Array of local identifiers. */
-PSTR8     Names;
-PULONG    Types;
-PULONG    count;  /*  Number of objects to be queried. */
-HVIO      hvps;   /*  VIO presentation-space handle. */
-APIRET    rc;     /*  Return code. */
-rc = VioQuerySetIds(lcids, Names, Types, count, hvps);
-</PRE>
 ==Parameters==
-;  lcids (PULONG) - output : Array of local identifiers.
+;lcids (PULONG) - output: Array of local identifiers.
+;Names (PSTR8) - output: An array of 8 character names associated with the lcids.
-; Names (PSTR8) - output :  An array of 8 character names associated with the lcids.
+;Types (PULONG) - output: An array of types associated with each lcids.
+;count (PULONG) - input: Number of objects to be queried.
-; Types (PULONG) - output : An array of types associated with each lcids.
+:The maximum value in use is 3.
+;hvps (HVIO) - input: VIO presentation-space handle.
-; count (PULONG) - input : Number of objects to be queried.
+:This is either 0 to indicate the default VIO session, or a value returned by [[VioCreatePS]].
-The maximum value in use is 3.
-; hvps (HVIO) - input :  VIO presentation-space handle.
-This is either 0 to indicate the default VIO session, or a value returned by VioCreatePS.
 ==Return Code==
- rc (APIRET) - returns
+;rc (APIRET) - returns:VioQuerySetIds returns one of the following values:
+*0 NO_ERROR
+*421 ERROR_VIO_INVALID_PARMS
+*436 ERROR_VIO_INVALID_HANDLE
-VioQuerySetIds returns one of the following values:
-* 0         NO_ERROR
-* 421        ERROR_VIO_INVALID_PARMS
-* 436        ERROR_VIO_INVALID_HANDLE
 ==Remarks==
 In OS/2 2.x, hvps cannot be 0.
-==Example Code==
-<PRE>
-</PRE>
-==Related Functions==
-* [[OS2 API:CPI:
-[[Category:The OS/2 API Project]]
+[[Category:Vio]]