VioSetDeviceCellSize: Difference between revisions

Latest revision as of 02:34, 2 January 2020

Sets the size of the current character cell in pels.

Syntax

VioSetDeviceCellSize (Height, Width, hvps)

Parameters

Height (ULONG) - input: The height of the character cell in pels.
Width (ULONG) - input: The width of the character cell in pels.
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: VioSetDeviceCellSize returns one of the following values:

0 NO_ERROR
421 ERROR_VIO_INVALID_PARMS
436 ERROR_VIO_INVALID_HANDLE

Remarks

If the device does not support the specified cell size, the cell size closest to the specified size is used. VioGetDeviceCellSize can be used to find the actual size selected. In OS/2 2.x, hvps cannot be 0.

@@ Line 1: / Line 1: @@
-==Description==
 Sets the size of the current character cell in pels.
 ==Syntax==
-<PRE>
+ VioSetDeviceCellSize (Height, Width, hvps)
-#define INCL_VIO
-#include <os2.h>
-ULONG     Height;  /*  The height of the character cell in pels. */
-ULONG     Width;   /*  The width of the character cell in pels. */
-HVIO      hvps;    /*  VIO presentation-space handle. */
-APIRET    rc;      /*  Return code. */
-rc = VioSetDeviceCellSize(Height, Width, hvps);
-</PRE>
 ==Parameters==
-;  Height (ULONG) - input : The height of the character cell in pels.
+;Height (ULONG) - input: The height of the character cell in pels.
+;Width (ULONG) - input: The width of the character cell in pels.
+;hvps (HVIO) - input: VIO presentation-space handle.
+:This is either 0 to indicate the default VIO session or a value returned by [[VioCreatePS]].
-; Width (ULONG) - input : The width of the character cell in pels.
-; hvps (HVIO) - input : VIO presentation-space handle.
-This is either 0 to indicate the default VIO session or a value returned by apiref refid='viocrps' form='textonly'..
 ==Return Code==
+;rc (APIRET) - returns:VioSetDeviceCellSize returns one of the following values:
+*0 NO_ERROR
+*421 ERROR_VIO_INVALID_PARMS
+*436 ERROR_VIO_INVALID_HANDLE
- rc (APIRET) - returns
-VioSetDeviceCellSize returns one of the following values:
-* 0          NO_ERROR
-* 421        ERROR_VIO_INVALID_PARMS
-* 436        ERROR_VIO_INVALID_HANDLE
 ==Remarks==
-If the device does not support the specified cell size, the cell size closest to the specified size is used. VioGetDeviceCellSize can be used to find the actual size selected. In OS/2 2.x, hvps cannot be 0.
+If the device does not support the specified cell size, the cell size closest to the specified size is used. [[VioGetDeviceCellSize]] can be used to find the actual size selected. In OS/2 2.x, hvps cannot be 0.
-==Example Code==
-<PRE>
-</PRE>
-==Related Functions==
-[[Category:The OS/2 API Project]]
+[[Category:Vio]]