Differences

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

--- mpl_functions [2016/07/18 08:09] – [Function INPUT (Field: Byte, Max: Byte, Mode: Byte, Default: string) : String] gryphon
+++ mpl_functions [2016/07/18 08:38] (current) – [Function DATEJ2G (LI : LongInt) : String] gryphon
@@ Line 65: / Line 65: @@
 This function takes a julian date format and converts it to a gregorian format (MMDDYY).
+==== Procedure GOTOXY (X: Byte, Y:Byte) ====
+This procedure will move the cursor to a specified X and Y position on the screen.  This only works for users who have ANSI graphics.
+Example:
+<code>
+CLRSCR
+GotoXY (1, 10)
+WriteLn ('Hello')
+</code>
+The above example will clear the screen then goto the first column of the tenth line and output the text "Hello" to the screen.
+==== Procedure HALT ====
+This procedure will exit the program and return the user back to the BBS immediately.
+Example:
+<code>
+If Graphics = 0 Do
+Begin
+  WriteLn ('Sorry, you do not have ANSI graphics.')
+  Halt
+End
+</code>
+The above example will check to see if the user has ANSI graphics and if not, display "Sorry, you do not have ANSI" and exit the program immediately by using the HALT command.
+==== Function INITIALS (String) : String ====
+This function takes a user name and attempts to return one or two character initials.
+<code>
+ S := Initials('Jack Phlash'); // should return "JP"
+</code>
 ==== Function INPUT (Field: Byte, Max: Byte, Mode: Byte, Default: string) : String ====
@@ Line 75: / Line 108: @@
 The Mode parameter is the type of input that will be accepted, and can be any one of the following input types:
-<code>
+^Mode^Description^Coments^
- : Standard input.  All characters allowed.
+|1|Standard input.|All characters allowed.|
- : Upper case input.  Allows all characters, but will convert
+|2|Upper case input.|Allows all characters, but will convert any lower case letters into upper case.|
-    any lower case letters into upper case.
+|3|Proper input.|Allows all characters, but will convert the first letter in each word to an upper case letter.|
- : Proper input.  Allows all characters, but will convert
+|4|Phone input.|Allows only numbers and will pre-format them using the USA-style phone numbers.  IE: XXX-XXX-XXXX. Note that the length of this input should always be 12, as that is the length of the USA phone number format.|
-    the first letter in each word to an upper case letter.
+|5|Date input.|Allows only numbers and will pre-format them using the date format (ie XX/XX/XX) that is currently selected by the user.  NOTE: The date input will always return the date in the MM/DD/YY format, regardless of what format the user has selected.  For example, if the user has selected the DD/MM/YY format, Input will expect the   user to enter the date in that format, but will then convert it to MM/DD/YY when it returns the date back to the MPE program.|
- : Phone input.  Allows only numbers and will pre-format them
+|6|Password input.|Allows all characters, but will convert any lower case letters into upper case.  The character that is typed is NOT echoed to the screen.  Instead, it is replaced by the * character so that what they have entered will not be shown on the screen.|
-    using the USA-style phone numbers.  IE: XXX-XXX-XXXX.
+|7|Lower case input.|Allows all characters, but will convert any lower case letters into upper case.|
-    Note that the length of this input should always be 12,
+|8|User Defined.|User name format from sys config|
-    as that is the length of the USA phone number format.
+|9|Standard Input w/o CRLF|Will not append CRLF to input|
- : Date input.  Allows only numbers and will pre-format them
+|10|Numeric Input.|Will only accept number 0-9 and . , + -|
-    using the date format (ie XX/XX/XX) that is currently
-    selected by the user.  NOTE: The date input will always
-    return the date in the MM/DD/YY format, regardless of what
-    format the user has selected.  For example, if the user
-    has selected the DD/MM/YY format, Input will expect the
-    user to enter the date in that format, but will then
-    convert it to MM/DD/YY when it returns the date back to
-    the MPE program.
- : Password input.  Allows all characters, but will convert
-    any lower case letters into upper case.  The character
-    that is typed is NOT echoed to the screen.  Instead, it
-    is replaced by the * character so that what they have
-    entered will not be shown on the screen.
-</code>
 NOTE: If any of the above input values are increased by 10, Input will create an input field using the foreground/background color that has been defined for that language.  For example, input type 11 will function the same as input type 1, but will fill an input field to the maximum field length.
-The Default parameter can be used to force a default text into the input field.  If you do not wish to have any default text in the buffer, supply a blank string parameter (ie '').
+The Default parameter can be used to force a default text into the input field.  If you do not wish to have any default text in the buffer, supply a blank string parameter (ie ’’).
 Example:
@@ Line 111: / Line 131: @@
  Str := Input (30, 30, 1, '')
 </code>
+The above example will print the text "Enter something: " to the screen and the allow input of up to 30 characters  in length, using input type 1 (allows all characters).  No default text has been supplied so the input field will be empty by default.
+<code>
+ Var Str : String
+ Write ('Enter something: ')
+ Str := Input (30, 30, 11, 'Default')
+</code>
+The above example will function just like the first example, except it will create an input field background and stuff the text of "Default" into the input field.