Compsee Apex III, Technical Reference Manual

Page: 111 / 168

Apex PDT Technical Reference Manual 7 Apex Programming Resource
COAM30002 Rev. 2.00 8/13/02
7-3
Get Text
apifGetText
Syntax:
rslt = apifGetText(Enabled, Row, Col, Data$, MaxLen,
MinLen, PromptLen, DataType, AutoEnter, Scan/Key,
PadChr$, PWChr$, Justify, Mask$, FrstChr$, LastKey)
Input:
Enabled = %YES or %NO. If enabled in %NO the data
entry capability is turned off and the function reads like
apisPaintText .
Row = Row to start the data entry.
Col = Column to start the data entry.
Data$ = Can be set to NULL or can contain data. If Data$
contains information, then the data is displayed and the user
must backspace to clear the field.
MaxLen = The maximum length of the data allowed in this
field.
MinLen = The minimum length of the data allowed in this
field.
PromptLen = The size of the display prompt. If MaxLen is
greater than PromptLen , then the data will scroll within the
defined display field.
DataType = %NUMERIC, %ALPHA, or %BOTH.
AutoEnter = %YES or %NO. Automatically accepts the data
once the MaxLen is reached.
Scan/Key = %SCANDATA, %KEYDATA,
or %KEYANDSCAN.
PadChr$ = The character used to pad data to the MaxLen . If
“”, then a space is automatically used.
PWChr$ = If unequal to “”, then PWChr$ is displayed
instead of data.
Justify = %Ljustify, %Rjustify, or %None. If %None, then
padding is turned off.
Mask$ = Allows the user to mask the input field. [# (0-9), @
(Aa-Zz and space), ^ (0-9, Aa-Zz, and space), ~ ($%&() etc.),
or the user can enter a specific character. If the user puts a
space in the mask, then the routine uses
DataType% for that
character.
FrstChr$ = Allows the user to specify the first character.
e.g. An “A”
⇒
first character must be an A, “ABCDE”
⇒
first character must be ABCD or E.
LastKey = Returns the value of the last key pressed.