Differences

This shows you the differences between two versions of the page.

--- en:docs:fapi:vioreadcharstr [2018/09/01 03:51] – created prokushev
+++ en:docs:fapi:vioreadcharstr [2021/09/19 02:24] (current) – prokushev
@@ Line 1: / Line 1: @@
+{{page>en:templates:fapiint}}
+====== VioReadCharStr ======
 This call reads a string of characters from the display starting at the specified location.
-==Syntax==
+===== Syntax =====
- VioReadCharStr (CharStr, Length, Row, Column, VioHandle)
+<code c>
+VioReadCharStr (CharStr, Length, Row, Column, VioHandle)
+</code>
+===== Parameters =====
-==Parameters==
+  * CharStr ([[PCH]]) - output : Address of the buffer where the character string is returned.
-;CharStr (PCH) - output : Address of the buffer where the character string is returned.
+  * Length ([[PUSHORT]]) - input/output : Address of the buffer length in bytes.
-;Length (PUSHORT) - input/output : Address of the buffer length in bytes.
+  * Row ([[USHORT]]) - input : Starting row of the field to read, 0 is the top row.
-;Row (USHORT) - input : Starting row of the field to read, 0 is the top row.
+  * Column ([[USHORT]]) - input : Starting column of the field to read, 0 is the leftmost column.
-;Column (USHORT) - input : Starting column of the field to read, 0 is the leftmost column.
+  * VioHandle ([[HVIO]]) - input : This must be zero unless the caller is a Presentation Manager application, in which case it must be the value returned by VioGetPs.
-;VioHandle (HVIO) - input : This must be zero unless the caller is a Presentation Manager application, in which case it must be the value returned by VioGetPs.
+===== Return Code =====
+rc ([[USHORT]]) - return
-==Return Code==
- rc (USHORT) - return
 Return code descriptions are:
-* 0          NO_ERROR
-* 355        ERROR_VIO_MODE
-* 358        ERROR_VIO_ROW
-* 359        ERROR_VIO_COL
-* 436        ERROR_VIO_INVALID_HANDLE
-* 465        ERROR_VIO_DETACHED
-==Remarks==
+  * 0          NO_ERROR
+  * 355        ERROR_VIO_MODE
+  * 358        ERROR_VIO_ROW
+  * 359        ERROR_VIO_COL
+  * 436        ERROR_VIO_INVALID_HANDLE
+  * 465        ERROR_VIO_DETACHED
+===== Remarks =====
 If a string read comes to the end of the line and is not complete, then the string read continues at the beginning of the next line. If the read comes to the end of the screen and is not complete, the read terminates and the length is set to the number of characters read.
-===PM Considerations===
+==== PM Considerations ====
 VioReadCharStr reads a character string from the Advanced VIO presentation space starting at the specified location.
-==Example Code==
+===== Bindings =====
-===C Binding===
-<PRE>
+====C Binding====
+<code c>
 #define INCL_VIO
@@ Line 42: / Line 53: @@
 USHORT           rc;            /* return code */
-</PRE>
+</code>
-===MASM Binding===
+====MASM Binding====
-<PRE>
+<code asm>
 EXTRN  VioReadCharStr:FAR
 INCL_VIO            EQU 1
@@ Line 57: / Line 68: @@
 Returns WORD
-</PRE>
+</code>
-====== Note ======
+===== Note =====
 Text based on [[http://www.edm2.com/index.php/VioReadCharStr_(FAPI)]]