home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD1.mdf / mumps / appendix.doc next >
Text File  |  1986-08-22  |  10KB  |  231 lines
  1.                 APPENDIX A
  2.  
  3.             FileMan Computed Functions V.17.07
  4.  
  5. ABS        Returns the absolute value of the argument.
  6.  
  7. BETWEEN        A three-argument function which returns either a '0' or a '1'.
  8.         The value equals '1' if the first argument lies between the 
  9.         second and the third; otherwise the returned value equals '0'.
  10.  
  11. BLANK        Causes FileMan to skip 'argument' number of lines.
  12.     
  13. BREAKABLE    If the argument is zero, the output device may not be
  14.         interrupted by the user (usually with a CTRL C).  During 
  15.                 normal FileMan output, the user is allowed to interrupt the 
  16.         output.
  17.  
  18. CENTER        The function's argument will be centered in the page for 
  19.         output.  The SETTAB and TAB functions allow centering of text
  20.         and they should be the functions used with word-processing 
  21.         fields.
  22.  
  23. CLOSE        FileMan invokes this function to 'CLOSE' the output device.
  24.  
  25. COUNT        Takes a multiple valued field (or File Name) as its argument
  26.         and returns the nunber of entries in that multiple field or 
  27.         file.  If the argument is a word-processing field, it returns 
  28.         the number of lines in the text.
  29.  
  30. DATE        Extracts the date from a Date/Time field.
  31.  
  32. DAYOFWEEK    Returns the day of week (MONDAY, TUESDAY etc.) for a given 
  33.         date.  Returns a null value if the date is imprecise.
  34.  
  35. DOUBLE-SPACE    Double spaces output of a word-processing field.  This 
  36.         function is normally used within word-processing "|" windows
  37.         without an argument.  It may also be used as an argumented 
  38.         function in response to the 'PRINT FIELD;' prompt with a 
  39.         word-processing type field as its argument.
  40.  
  41. DUP        Duplicates the first argument into a string 'n' characters
  42.         long, where 'n' is the second argument.
  43.  
  44. INDENT        Indent the following text 'argument' number of spaces from the
  45.         left margin.
  46.  
  47. INTERNAL    Returns the internally stored value of a SET, DATE or POINTER
  48.         valued field.
  49.  
  50. IOM        Returns the number of column positions on the page or screen.
  51.  
  52. LAST        Takes a multiple-valued field name as argument and returns the
  53.         value of the last entry in the multiple.
  54.  
  55. LOWERCASE    Changes alphabetic characters to lowercase except the first 
  56.         character and all characters that occur after a punctuation.
  57.         Note that a space is considered a punctuation; thus the first
  58.          character of each word will remain uppercase.
  59.  
  60. MAX        Returns the greater of its two arguments.
  61.  
  62. MAXIMUM        Takes a multiple-valued field as its argument and returns the 
  63.         maximum value of all the entries in the multiple.
  64.  
  65. MIN        Returns the lesser of its two arguments.
  66.  
  67. MINIMUM        Takes a multiple-valued field as its argument and returns the 
  68.         minimum value of all the entries in the multiple.
  69.  
  70. MINUTES        Difference between two date/times in minutes.  Returns a 
  71.         negative value if the first argument is earlier than the 
  72.         second.  The function assumes midnight if an argument does 
  73.         not contain a time.
  74.  
  75. MODULO        First argument MODULO the second.  This is FileMan's
  76.         implementation of the MUMPS '#' operator because the '#'
  77.         character has special meaning to FileMan.
  78.  
  79. MONTH        Returns the month and year from a date-valued field.
  80.  
  81. MONTHNAME    Turns "1" into "JANUARY", "2" into "FEBRUARY", etc.  With
  82.         date-valued fields, use this function in conjunction with the 
  83.         NUMMONTH function.
  84.  
  85. NEXT        Takes a field name as its argument and returns the value that 
  86.         the field has in the next entry or sub-entry.  See PREVIOUS.
  87.  
  88. NOBLANKLINE    Suppresses the printing of a single all-blank line if a 
  89.         computed expression within word-processing "|" windows 
  90.         evaluates to null.
  91.  
  92. NOW        Returns the current date and time.
  93.  
  94. NOWRAP        Displays a word-processing field line-for-line as originally 
  95.         entered by the user.  Disables 'wrap-around' if the WRAP
  96.         function was used earlier in the text.
  97.  
  98. NUMDATE        Returns a date-valued field in 'MM/DD/YY' format.
  99.  
  100. NUMDAY        Returns the day number (0-31) for a date-valued field.
  101.  
  102. NUMMONTH    Returns the month number (0-12) for a date-valued field.
  103.  
  104. NUMYEAR        Returns the year number (00-12) for a date-valued field.
  105.  
  106. PADRIGHT    A two-argument function that returns the first argument with
  107.         spaces added to generate a string 'argument2' characters long.
  108.  
  109. PAGE        Returns the page number of output.
  110.  
  111. PAGEFEED    Start a new page whenever fewer than 'argument' number of 
  112.         lines remain on the current page.
  113.  
  114. PAGESTART    Start output text on line # 'argument' of the page.
  115.  
  116. PARAM        Returns the value of the parameter named by the argument.
  117.         Used together with the SETPARAM function.
  118.  
  119. PREVIOUS    Takes a field name as its argument and returns the value that 
  120.         the field has in the previous entry or sub-entry.  See NEXT.
  121.  
  122. RANGEDATE    A four-argument function where the arguments are taken as two
  123.         pairs of date ranges.  It returns the number of days by which 
  124.         the two date ranges overlap.  If the overlap is indefinite, 
  125.         the function returns a zero.
  126.  
  127. REPLACE        Replaces the first argument, with all occurrences of the 
  128.         second argument replaced by the third.  See TRANSLATE.
  129.  
  130. REVERSE        Returns the argument in reverse (right to left) order.
  131.  
  132. RIGHT-JUSTIFY    The text will be padded with spaces between words so that the
  133.         output will be right-justified.  This function is normally 
  134.         used without arguments within the "|" windows in a 
  135.         word-processing field.  It can also be used as an argumented 
  136.         function in response to the 'PRINT BY:' prompt if the argument
  137.         is a word-processing type field.
  138.  
  139. SET        Takes the value of first argument, but also puts it into the 
  140.         variable named by the second argument.  The variable name used
  141.         for the second argument must follow the namespacing 
  142.         conventions set forth by FileMan and must be at least three 
  143.         characters long.  This function can be used only by a 
  144.         programmer user.  The SETPARAM and PARAM functions supercede 
  145.         the use of this function.
  146.  
  147. SETPAGE        Resets page numbering so that the following page number will 
  148.         be 'argument'+1.
  149.  
  150. SETPARAM    This two-argument function returns nothing but it allows 
  151.         taking any field or computed expression as the first argument
  152.         and setting its value equal to an arbitrarily named parameter
  153.         (the second argument).  The PARAM function can then be used 
  154.         to refer to the value of this parameter.
  155.  
  156. SETTAB        A multiple argument function that sets the tab stops at the 
  157.         columns named by the arguments.  In subsequent lines, the 
  158.         first "TAB" encountered will cause indentation to column 
  159.         positions 'argument1' characters from the left margin the
  160.         second "TAB" will cause indentation to column position
  161.         'argument2', and so on.  In the absence of the SETTAB 
  162.         function, the default tab settings are 5,10,15,20,... column
  163.         positions from the left margin.
  164.  
  165.         If any SETTAB argument is negative, it means that any text
  166.         following the corresponding "TAB" will be right-justified so
  167.         that the rightmost column of that text will fall in the column
  168.         number that is the absolute value of the SETTAB argument.  If
  169.         a SETTAB argument is the literal "C", the text following the 
  170.         corresponding "TAB" will be centered on the page.
  171.  
  172.         The "TAB 'n'" function overrides any SETTAB specification and
  173.         causes tabbing to the 'n'th column over from the left margin.
  174.  
  175. SINGLE-SPACE    Output the text single-spaced.  Turns off double-spacing if 
  176.         the DOUBLE-SPACE function has been used previously.
  177.  
  178. SITENUMBER    Returns the number identifying your site (from initialization)
  179.  
  180. SQUAREROOT    Returns the squareroot of a numeric-valued argument. Returns a
  181.         null value if the argument is negative or zero.
  182.  
  183. STRIPBLANKS    Deletes leading and trailing spaces from the argument.
  184.  
  185. TAB        This function causes the text to start printing at the 
  186.         predetermined tab settings much like what the 'TAB' key in a
  187.         typewriter does. The default tab settings are 5,10,15,20... or
  188.         they may be reset using the SETTAB function.  A 'TAB' is 
  189.         inserted within the text by typing the special 'TAB' key on 
  190.         the keyboard, 'CTRL I' if the keyboard does not have a 'TAB' 
  191.         key or by simply entering the characters "TAB" enclosed by a 
  192.         pair of "|" characters.  Note that when you use tha 'TAB' key 
  193.         or 'CTRL I' what actually gets inserted in the text are the
  194.         characters "TAB" framed by the literal "C".
  195.  
  196. TIME        Takes the time from a date.time valued field and converts it 
  197.         to a twelve-hour time format with 'AM' or 'PM'.
  198.  
  199. TODAY        Returns the current date.
  200.  
  201. TOP        Issues a form feed to the output device.
  202.  
  203. TOTAL        Takes a multiple-valued field as its argument and returns the 
  204.         total of all the multiples for which there are values.
  205.  
  206. TRANSLATE    Replaces, in the first argument, each occurrence of a 
  207.         character in the second argument with the corresponding 
  208.         character in the third argument.  This is FileMan's equivalent
  209.         of the new MUMPS $TRANSLATE function. See REPLACE.
  210.  
  211. UNDERLINE    Underline 'argument' if output is to a printer.  The word-
  212.         processing text formatter allows underlining using the 
  213.         underscore character within "|" windows ("|_|").  It will
  214.         underline the following text until another "|_|" is 
  215.         encountered.
  216.  
  217. UPPERCASE    Changes all alphabetic characters to uppercase.
  218.  
  219. WIDTH        Specifies that the following text will always be printed out 
  220.         in a column 'argument' characters wide.  'Argument', in other
  221.         words, is the difference between the left margin position and
  222.         the right margin position, plus 1.  In the absence of a 
  223.         'WIDTH' specification, the output column width is determined
  224.         by the user (or defaulted by the system) at "Print" time.
  225.  
  226. WRAP        Causes the text to be printed in 'wrap-around' mode.  Returns
  227.         to 'wrap-around' output if a NOWRAP function was previously
  228.         used.
  229.  
  230. YEAR        Extracts the year from a date-valued field.
  231.