BR Wiki - User contributions [en]

FnSnap

2013-10-11T00:20:36Z

Gtisdale:

:Project Leader: [[:User:Gtisdale|George Tisdale]].
:Language: [[Business Rules!]]
:License: ???

You can find the latest copy of '''fnSnap.dll''' in fnsnap.zip available at [ftp://ftp.brulescorp.com/Brg_pub/Zip/]

See also [[:Category:FnSnap]]

*[[Library Functions|Library Functions]]
*[[fnSnap: File|File]]
:*File Management
::*FNBLDSORT - build a sort control file and execute the sort
::*FNFIL - create a file number that will increment by 1 each time a batch is created
::*FNFILENAME$*80 - Provide a file name
::*FNFILEOK - Check version number
::*FNFILESIZE - count number of records in a file
::*FNGETFILE$ - Return the name and path of an existing file
::*FNGETFILENAME$*80 - Create a file name from a seed
::*FNINDEX - Build an Index file and check for duplicates
::*FNNEXTFIL$ - returns the file name of the next sequential file in a given location
::*FNPUTFILE$ - Return the name and path of an file to be created, replaced or appended
::*FNSIZE - Set or correct a file size
::*FNUPDATE_VERSION - Change a file version and reconfigure layout
:*Data management
::*FNSEQ - Return the next sequence for a key field
::*FNTYPE - Move the contents of one text file into another open file
:*Form statements
::*FNCFORM$ - Create a Condensed Compiled Form Statement
::*FNCF$ - Process a field specification string for use in FNCFORM$
*[[fnSnap: Screen Processing|Screen Processing]]
:*Buttons, messages and dialogs
::*FNBUTTON - Add button on the button bar
::*FNCHECK - in connection with a radio dot or check box returns a 1 if checked
::*FNCHECK$ - places or strips ^ from an element
::*FNCLRBUTTON - removes a button from the button bar
::*FNDIALOG$*40 - Display dialog box and return selected text
::*FNDLG - Display a dialog box from data in a file
::*FNHELP - open a tip box associated with a screen using a text file
::*FNHELPTIP - uses David Blankenship utility to display a help record
::*FNOK - Pop-up "OK" question
::* FNOPTIONS - creates a radio dot selection pop up
::* FNOPTIONS$ - creates a check box selection pop up
::* FNPFKEYLINE - Creates a hot field string of function key options
::* FNPFKEY - Prints a function key message
::* FNRADIOCHK$ - display a radio/checkbox with a set of options
::* FNRADNUM - Return the option selected in a radio dot list
::* FNTIMEOUT - Display timeout message
::* FNWINBUTTONS - print one or more buttons on a screen in a designated window
:*String Manipulation
::*FNDECRYPT$ - Decrypt FNENCRYPT$
::*FNENCRYPT$ - Simple encryption
::*FNFKEY - Converts an FKEY value greater than 1000
::*FNNUM$ - Convert number to string
::*FNPHONE$ - Convert number to (###) ###-####
::*FNPROPER$*60 - Convert to Proper Case
:*Other
::*FNAUTO - 1 if last field exit was automatic
::*FNCLKBUF - Clear keyboard buffer
::*FNERRTRAP - Trapped Error Processing
::*FNINIT - Initialize variables in FNSNAP Library
::*FNPRINTSCREEN - stuff the keyboard to generate a print screen
::*FNZERO - set to number if zero
:*Screen input and display
::*FNWAITWIN - displays a window with a message, optionally with buttons
::*FNWAITBAR - displays a progress bar in a window opened using FNWAITWIN
::*FNWAITMSG - displays a new message in a window opened by FNWAITWIN
::*FNMOD - returns the column number of a cell in a grid
::*FNPARSERES - returns screen resolution and BR window size for a session
::*FNPROGRESS - Progress bar
::*FNSCREEN - 24 x 80 screen display for screen painter
::*FNTEXTBOX - creates a text box with word wrap
::*FNWINSCRN - paints a screen in a window
::*FNWINROWCOL - in GUI mode returns rows and columns of a window
::*FNWINSIZE - in GUI mode creates arrays holding all window sizes

*[[fnSnap: Window Maintenance|Window Maintenance]]
:*List and Grid
::*FNLISTSPEC$*50 - Create a window for a list/grid box
:*Child windows
::*FNWINHEAD - Print the top bar to a window
::*FNWINDEV - Query FNSNAP for last window opened
*[[fnSnap: Printing and PCL|Printing and PCL]]
:*Font Management
::*FNFONT$*30 - Create a PCL font string
::*FNLOADFONT$*50 - Loads a PCL font to printer
:*Reprinting Reports
::*FNCLEANLOG - part of FNREPRINT used to remove out of date reports
::*FNOPEN - create a log file for saved reports
::*FNMENUACCESS - used in connection with FNREPRINT to determine user permission to reprint a report
::*FNPRINT - prints a saved report opened using FNOPEN
::*FNREPRINT - displays a list of available saved reports and prints selected report
:*PCL and NWP formatting
::*Bar Codes and addresses
:::*FNPOSTNET - prints a postal bar code from a zip code
:::*FNCODE3OF9
:::*FNCODEUPC

::*Forms and formatting
::*NWP Printing
:::*FNPRINTNWP - positions a string and aligns it right, center or decimal on a specified position
:*RTF Printing
::*FNRTFSTART - opens a source file to produce an RTF file using RTFLIB.dll
::*FNRTFEND - turns a source file built with FNRTFSTART into a finished document
:*FNREFERENCE - Prints a page reference on bottom right corner in PCL
:*FNPRINT_FILE - Prints a text file on Grey bar Paper
:*FNPRINTERS - Creates a printed list of printers and a printers.sys file

*[[fnSnap: Date and Time|Date and Time]]
:*Date formatting
::*FNCCYYMMDD_TO_DAYS - converts CYMD to DAYS
::*FNDATEFWD
::*FNDATEREV - converts MMDDYY to YYMMDD
::*FNDATE$ - Creates a formatted date from DAYS input
::*FNDAYS_TO_MMDDCCYY - Converts DAYS to MDCY
::*FNDAYS_TO_MMDDYY - Converts DAYS to MMDDYY
::*FNMDY2YMD - converts YYMMDD to MMDDYY with century option
::*FNMMDDCCYY_TO_DAYS - converts MDCY to DAYS
::*FNMMDDYY_TO_DAYS - Converts MDY to DAYS
::*FNTIMMILREG - 12 hour time from 24 hour time
::*FNYMD2MDY - converts MMDDYY to YYMMDD with century option
::*FNYYMMDD_TO_DAYS - convert YMD to DAYS
:*Relative and special dates
::*FNBUSINESSDAY - returns the next business day after or including a specified date
::*FNDAYOFYEAR - ordinal number of days from beginning of calendar year
::*FNNEXTMONTH - similar date in the following month
::*FNPRIOR BUSINESSDAY - returns the first business day prior to a given date including the given date
::*FNWEEKDAY$ - Returns the day of the week
::*FNWEEKOFMONTH - number of time a specified day of week has occur ed in the month specified
::*FNWEEKOFYEAR - number of times a specified day of week has occurred in a year up to a specified date

*[[fnSnap: Array Functions|Array Functions]]
:*Sorting arrays
::*FNSORTARRAY - sort an array with header and footer
::*FNSRTARY - sort an array with header and footer based on itself
::*FNSRTNARY -Sort a numeric array based on another array
:*Array arithmetic
::*FNCOLSUM - sums the elements of an array for a specified column
::*FNROWSUM - sums the elements of an array for a specified row
:*Searching arrays
::*FNCHRMAT$ - convert a numeric array to character
::*FNLISTSRCH - searches a character array based on a search string
::*FNLISTSRCHN - searches a numeric array based on a search string
::*FNSELECTION - selection process using two arrays
::*FNSRCHCRIT$*50 - search criteria for a list box
:*Other
::*FNDELROW - removes a specified row from an array and redimensions the array
::*FNDELROW$ - removes a specified row from an array and redimensions the array
::*FNADDROW - inserts a cell in the middle of a numeric array at a specified row
::*FNADDROW - inserts a cell in the middle of a character array at a specified row
::*FNPARMAT - split an array into sub-arrays

*[[fnSnap: Miscellaneous Functions|Miscellaneous Functions]]
:*Email
::*FNEMAIL - creates an email file for email monitor
::*FNEMAILFILE - inserts a text file into an email for email monitor
:*Formatting
::*FNLEADZERO$ - obsolete replace with CNVRT$("PIC(###)",x)
::*FNCHECKAMOUNT$ - returns English words for a dollar amount
:*Progress
::*FNPROG - displays a progress bar for a process
::*FNPROGRESS - displays a progress bar for a process
:*Other
::*FNCLKBUF - clears the keyboard buffer of extra key strokes
::*FNCURDRV$ - returns the current drive and directory
::*FNMSEXE$ - return the installed location of a Microsoft compliant program installation
::*FNX$ - returns X if true BLANK if false

*[[fnSnap: FNSNAP Obsolete functions|Obsolete functions]]
:*Window and screen processing
::*FNMGCLR - clears a message form the fnpick message line
::*FNSAVPART - legacy function to save a portion of the screen - obsolete in 4.17
::*FNRELPART - legacy function to clear a portion of the screen obsolete in 4.17
::*FNWIN - legacy function to open a window in numeric order
::*FNCLSWIN - legacy function to close a window opened by FNWIN
::*FNPM - legacy message box on the main window
:*Point and pick
::*FNKEYSEL - direct file look up function requires a fixed position font
::*FNPICK_EX - A point and shoot legacy using a single matrix requires a fixed position font
::*FNPICK - A point and shoot legacy using a single matrix requires a fixed position font
::*FNKEYSEL_EX - a legacy direct file access point and shoot requires a fixed sized font
::*FNPOPUP - legacy code for a pop-up choice box
:*Supporting functions
::*Data transfer between program and library
::*FNWINDEV - returns the number of the currentlyactive FNSNAP window using the old system
::*FNLEADZERO$
::*FNGETK$ - \fs20
::*FNSETALL - set all elements of an array
::*FNSETSEL - set all elements of an array
::*FNPRTPICKBAR - a function to position a colored pick bar in FNPICK
::*FNZLPAD$ - pads a number with zeros and converts to string
::*FNINIT - initializes the variable required by the original FNSNAP functions
::*FNNOKEY - chekc to see if CMDKEY or FKEY were pressed

FnSnap is also discussed in [[Library Facility]].

[[Category:FnSnap]]
[[Category:Utilities]]
[[Category:Utilities Third Party]]
[[Category:ftp.brulescorp.com]]

FnSnap

2013-10-11T00:18:30Z

Gtisdale:

:Project Leader: [[:User:Gtisdale|George Tisdale]].
:Language: [[Business Rules!]]
:License: ???

You can find the latest copy of '''fnSnap.dll''' in fnsnap.zip available at [ftp://ftp.brulescorp.com/Brg_pub/Zip/]

See also [[:Category:FnSnap]]

*[[Library Functions|Library Functions]]
*[[fnSnap: File|File]]
:*File Management
::*FNBLDSORT - build a sort control file and execute the sort
::*FNFIL - create a file number that will increment by 1 each time a batch is created
::*FNFILENAME$*80 - Provide a file name
::*FNFILEOK - Check version number
::*FNFILESIZE - count number of records in a file
::*FNGETFILE$ - Return the name and path of an existing file
::*FNGETFILENAME$*80 - Create a file name from a seed
::*FNINDEX - Build an Index file and check for duplicates
::*FNNEXTFIL$ - returns the file name of the next sequential file in a given location
::*FNPUTFILE$ - Return the name and path of an file to be created, replaced or appended
::*FNSIZE - Set or correct a file size
::*FNUPDATE_VERSION - Change a file version and reconfigure layout
:*Data management
::*FNSEQ - Return the next sequence for a key field
::*FNTYPE - Move the contents of one text file into another open file
:*Form statements
::*FNCFORM$ - Create a Condensed Compiled Form Statement
::*FNCF$ - Process a field specification string for use in FNCFORM$
*[[fnSnap: Screen Processing|Screen Processing]]
:*Buttons, messages and dialogs
::*FNBUTTON - Add button on the button bar
::*FNCHECK - in connection with a radio dot or check box returns a 1 if checked
::*FNCHECK$ - places or strips ^ from an element
::*FNCLRBUTTON - removes a button from the button bar
::*FNDIALOG$*40 - Display dialog box and return selected text
::*FNDLG - Display a dialog box from data in a file
::*FNHELP - open a tip box associated with a screen using a text file
::*FNHELPTIP - uses David Blankenship utility to display a help record
::*FNOK - Pop-up "OK" question
::* FNOPTIONS - creates a radio dot selection pop up
::* FNOPTIONS$ - creates a check box selection pop up
::* FNPFKEYLINE - Creates a hot field string of function key options
::* FNPFKEY - Prints a function key message
::* FNRADIOCHK$ - display a radio/checkbox with a set of options
::* FNRADNUM - Return the option selected in a radio dot list
::* FNTIMEOUT - Display timeout message
::* FNWINBUTTONS - print one or more buttons on a screen in a designated window
:*String Manipulation
::*FNDECRYPT$ - Decrypt FNENCRYPT$
::*FNENCRYPT$ - Simple encryption
::*FNFKEY - Converts an FKEY value greater than 1000
::*FNNUM$ - Convert number to string
::*FNPHONE$ - Convert number to (###) ###-####
::*FNPROPER$*60 - Convert to Proper Case
:*Other
::*FNAUTO - 1 if last field exit was automatic
::*FNCLKBUF - Clear keyboard buffer
::*FNERRTRAP - Trapped Error Processing
::*FNINIT - Initialize variables in FNSNAP Library
::*FNPRINTSCREEN - stuff the keyboard to generate a print screen
::*FNZERO - set to number if zero
:*Screen input and display
::*FNWAITWIN - displays a window with a message
::*FNWAITBAR - displays a progress bar in a window opened using FNWAITWIN
::*FNWAITMSG - displays a new message in a window opened by FNWAITWIN
::*FNMOD - returns the column number of a cell in a grid
::*FNPARSERES - returns screen resolution and BR window size for a session
::*FNPROGRESS - Progress bar
::*FNSCREEN - 24 x 80 screen display for screen painter
::*FNTEXTBOX - creates a text box with word wrap
::*FNWINSCRN - paints a screen in a window
::*FNWINROWCOL - in GUI mode returns rows and columns of a window
::*FNWINSIZE - in GUI mode creates arrays holding all window sizes

*[[fnSnap: Window Maintenance|Window Maintenance]]
:*List and Grid
::*FNLISTSPEC$*50 - Create a window for a list/grid box
:*Child windows
::*FNWINHEAD - Print the top bar to a window
::*FNWINDEV - Query FNSNAP for last window opened
*[[fnSnap: Printing and PCL|Printing and PCL]]
:*Font Management
::*FNFONT$*30 - Create a PCL font string
::*FNLOADFONT$*50 - Loads a PCL font to printer
:*Reprinting Reports
::*FNCLEANLOG - part of FNREPRINT used to remove out of date reports
::*FNOPEN - create a log file for saved reports
::*FNMENUACCESS - used in connection with FNREPRINT to determine user permission to reprint a report
::*FNPRINT - prints a saved report opened using FNOPEN
::*FNREPRINT - displays a list of available saved reports and prints selected report
:*PCL and NWP formatting
::*Bar Codes and addresses
:::*FNPOSTNET - prints a postal bar code from a zip code
:::*FNCODE3OF9
:::*FNCODEUPC

::*Forms and formatting
::*NWP Printing
:::*FNPRINTNWP - positions a string and aligns it right, center or decimal on a specified position
:*RTF Printing
::*FNRTFSTART - opens a source file to produce an RTF file using RTFLIB.dll
::*FNRTFEND - turns a source file built with FNRTFSTART into a finished document
:*FNREFERENCE - Prints a page reference on bottom right corner in PCL
:*FNPRINT_FILE - Prints a text file on Grey bar Paper
:*FNPRINTERS - Creates a printed list of printers and a printers.sys file

*[[fnSnap: Date and Time|Date and Time]]
:*Date formatting
::*FNCCYYMMDD_TO_DAYS - converts CYMD to DAYS
::*FNDATEFWD
::*FNDATEREV - converts MMDDYY to YYMMDD
::*FNDATE$ - Creates a formatted date from DAYS input
::*FNDAYS_TO_MMDDCCYY - Converts DAYS to MDCY
::*FNDAYS_TO_MMDDYY - Converts DAYS to MMDDYY
::*FNMDY2YMD - converts YYMMDD to MMDDYY with century option
::*FNMMDDCCYY_TO_DAYS - converts MDCY to DAYS
::*FNMMDDYY_TO_DAYS - Converts MDY to DAYS
::*FNTIMMILREG - 12 hour time from 24 hour time
::*FNYMD2MDY - converts MMDDYY to YYMMDD with century option
::*FNYYMMDD_TO_DAYS - convert YMD to DAYS
:*Relative and special dates
::*FNBUSINESSDAY - returns the next business day after or including a specified date
::*FNDAYOFYEAR - ordinal number of days from beginning of calendar year
::*FNNEXTMONTH - similar date in the following month
::*FNPRIOR BUSINESSDAY - returns the first business day prior to a given date including the given date
::*FNWEEKDAY$ - Returns the day of the week
::*FNWEEKOFMONTH - number of time a specified day of week has occur ed in the month specified
::*FNWEEKOFYEAR - number of times a specified day of week has occurred in a year up to a specified date

*[[fnSnap: Array Functions|Array Functions]]
:*Sorting arrays
::*FNSORTARRAY - sort an array with header and footer
::*FNSRTARY - sort an array with header and footer based on itself
::*FNSRTNARY -Sort a numeric array based on another array
:*Array arithmetic
::*FNCOLSUM - sums the elements of an array for a specified column
::*FNROWSUM - sums the elements of an array for a specified row
:*Searching arrays
::*FNCHRMAT$ - convert a numeric array to character
::*FNLISTSRCH - searches a character array based on a search string
::*FNLISTSRCHN - searches a numeric array based on a search string
::*FNSELECTION - selection process using two arrays
::*FNSRCHCRIT$*50 - search criteria for a list box
:*Other
::*FNDELROW - removes a specified row from an array and redimensions the array
::*FNDELROW$ - removes a specified row from an array and redimensions the array
::*FNADDROW - inserts a cell in the middle of a numeric array at a specified row
::*FNADDROW - inserts a cell in the middle of a character array at a specified row
::*FNPARMAT - split an array into sub-arrays

*[[fnSnap: Miscellaneous Functions|Miscellaneous Functions]]
:*Email
::*FNEMAIL - creates an email file for email monitor
::*FNEMAILFILE - inserts a text file into an email for email monitor
:*Formatting
::*FNLEADZERO$ - obsolete replace with CNVRT$("PIC(###)",x)
::*FNCHECKAMOUNT$ - returns English words for a dollar amount
:*Progress
::*FNPROG - displays a progress bar for a process
::*FNPROGRESS - displays a progress bar for a process
:*Other
::*FNCLKBUF - clears the keyboard buffer of extra key strokes
::*FNCURDRV$ - returns the current drive and directory
::*FNMSEXE$ - return the installed location of a Microsoft compliant program installation
::*FNX$ - returns X if true BLANK if false

*[[fnSnap: FNSNAP Obsolete functions|Obsolete functions]]
:*Window and screen processing
::*FNMGCLR - clears a message form the fnpick message line
::*FNSAVPART - legacy function to save a portion of the screen - obsolete in 4.17
::*FNRELPART - legacy function to clear a portion of the screen obsolete in 4.17
::*FNWIN - legacy function to open a window in numeric order
::*FNCLSWIN - legacy function to close a window opened by FNWIN
::*FNPM - legacy message box on the main window
:*Point and pick
::*FNKEYSEL - direct file look up function requires a fixed position font
::*FNPICK_EX - A point and shoot legacy using a single matrix requires a fixed position font
::*FNPICK - A point and shoot legacy using a single matrix requires a fixed position font
::*FNKEYSEL_EX - a legacy direct file access point and shoot requires a fixed sized font
::*FNPOPUP - legacy code for a pop-up choice box
:*Supporting functions
::*Data transfer between program and library
::*FNWINDEV - returns the number of the currentlyactive FNSNAP window using the old system
::*FNLEADZERO$
::*FNGETK$ - \fs20
::*FNSETALL - set all elements of an array
::*FNSETSEL - set all elements of an array
::*FNPRTPICKBAR - a function to position a colored pick bar in FNPICK
::*FNZLPAD$ - pads a number with zeros and converts to string
::*FNINIT - initializes the variable required by the original FNSNAP functions
::*FNNOKEY - chekc to see if CMDKEY or FKEY were pressed

FnSnap is also discussed in [[Library Facility]].

[[Category:FnSnap]]
[[Category:Utilities]]
[[Category:Utilities Third Party]]
[[Category:ftp.brulescorp.com]]

FnSnap: Screen Processing

2011-05-10T00:40:20Z

Gtisdale: /* FNDIALOG$*40 - Display dialog box and return selected text */

==Buttons, messages and dialogs==
===FNBUTTON - Add button on the button bar===

Creates a button on the button bar. Buttons are created left to right and can be removed with FNCLRBUTTON

FNBUTTON(BUTTON_TEXT$,FK;BTN)

;Functions used:

;Variables:
{|
|-valign="top"
|width="10%"|'''BUTTON_TEXT$'''||Text to display on button. Must be less than 10 characters
|-valign="top"
|width="10%"|'''FK'''||Function key value to return when the button is pressed
|-valign="top"
|width="10%"|'''BTN'''||Button number if an existing button is to be changed. If this parameter is omitted the next button position will be used.
|-valign="top"
|width="10%"|'''
|-valign="top"
|}
 
;Comments:

===FNCHECK - in connection with a radio dot or check box returns a 1 if checked===

Used to process the elements of a radio dot list or check box is to determine wether the element has been checked (true) or not (false)

FNCHECK(L$*100)

;Functions used:

;Variables:
{|
|-valign="top"
|width="10%"|'''L$ '''||The label description being processed for an element of a radio list or check b ox list
|-valign="top"
|}
 
;Comments: 
This function is intended to be used by other functions see for example FNOPTIONS and FNOPTIONS$

===FNCHECK$ - places or strips ^ from an element===

Based on the results of FNCHECK or a default parameter this function will add or remove the ^ from a description that indicates if it has been checked

Returns the label modified to either contain or be free of a leading ^.
FNCHECK$*100(L$*100,L)

;Functions used:

;Variables:
{|
|-valign="top"
|width="10%"|'''L$ '''||The label description to be modified if L is true
|-valign="top"
|width="10%"|'''L '''||A flag indicating whether the ^ is to be appended to the front of a label, or stripped from it
|-valign="top"
|}
 
;Comments: 
Used as a part of FNOPTIONS and FNOPTIONS$

===FNCLRBUTTON - removes a button from the button bar===

Removes a button from the button bar if it was created using FNBUTTON

FNCLRBUTTON(;BTN)

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''BTN'''||The number of the button to be cleared. If blank the last, highest number, button will be cleared. If equal to 99 all buttons will be cleared.
|-valign="top"
|}
 
;Comments: 
Use in connection with FNBUTTON to display and remove buttons left to right on the button bar.

===FNDIALOG$*40 - Display dialog box and return selected text===

Displays a dialog box with up to three options and specifiable text. See also FNDLG

FNDIALOG$*40(SROW$,SCOL$,DBWIDTH,TXTSTR$*900,OPT1$*40,OPT2$*40,OPT3$*40,REMOVE,DFLTOPT,DISPANYKEY,KEYWAIT) !:

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''
|-valign="top"
|}
 
;Comments:

Text does not align very well in the box when using proportional fonts. This function can be called from FNDLG that uses an unformatted BR file to supply text and button labels. Both functions have been updated to utilize the external utility from David Blankenship.

See also FNWAITWIN for a very useful alternative.

===FNDLG - Display a dialog box from data in a file===

Creates a dialog box from a DAT file prepared by DIALOGMN.BR

FNDLG(DIALOG_DAT,DLNR;DISPANYKEY,KEYWAIT,SUFFIX$*300)

Functions used
{|
|-valign="top"
|width="10%"|'''FNDIALOG
|-valign="top"
|}
 
;Variables:
{|
|-valign="top"
|width="10%"|'''DIALOG_DAT'''||
|-valign="top"
|width="10%"|'''DLNR'''||
|-valign="top"
|width="10%"|'''DISPANYKEY'''||
|-valign="top"
|width="10%"|'''KEYWAIT'''||
|-valign="top"
|width="10%"|'''SUFFIX$'''||
|-valign="top"
|}
 
;Comments:

This is a carry over from earlier versions and does not align proportional text very well. If possible use MSGBOX instead.

The function has been updated to use the message box utility from David Blankenship if RADIOCHK.exe is in the VOL002 directory

With version 4.2 the function FNWAITWIN and rel;ated functions FNWAITMSG and FNWAITBAR are much more flexible and provde a Windows look message box with custom buttons, a progress bar and optionsl message flashing across the wait window as processing progresses.

===FNHELP - open a tip box associated with a screen using a text file===

Searches a specified text file for an anchor point, then displays a record after that point specified by HFLD. Used for displaying pop up help windows based on the input field where the cursor is located

[PICT(PICS\SNAP0007.ptf)]

FNHELP(HPATH$*60,HFILE$*20,HBASE$,HFLD,HROW,HCOL;HTITLE$*80)

;Functions used:

;Variables:
{|
|-valign="top"
|width="10%"|'''HPATH$ '''||Path where the help file is located
|-valign="top"
|width="10%"|'''HFILE$ '''||File name within HPATH$ for the help file
|-valign="top"
|width="10%"|'''HFLD '''||Field number, usually set by CURFLD except in GRIDs it should be set by CURCOL.
|-valign="top"
|width="10%"|'''HROW '''||Current row position of cursor, used to help in the positioning of the help window. Usually set by CURROW
|-valign="top"
|width="10%"|'''HCOL '''||Current column of cursor, used to help in the positioning of the help window. Usually set by CURCOL
|-valign="top"
|width="10%"|'''HTITLE$ '''||An optional title to appear in the bar at the top of the help window.
|-valign="top"
|}
 
;Comments: 
Very flexible and easy to implement help system. I uses David Blankenship's HELPTIPS.exe utility.

===FNHELPTIP - uses David Blankenship utility to display a help record===

Displays a record from a text file in a pop up window. Used in the BR system by the ERRORS routine to display the description of an error number.

FNHELPTIP(PROGPATH$*100,TEXTFILE$*50,TITLE$*50,RECORD,HROW,HCOL;NO_WAIT)

;Functions used:

;Variables:
{|
|-valign="top"
|width="10%"|'''PROGPATH$ '''||Path where text file is located.
|-valign="top"
|width="10%"|'''TEXTFILE$ '''||Name of text file within the specified path
|-valign="top"
|width="10%"|'''TITLE$ '''||Name to be displayed at the top of the pop up window
|-valign="top"
|width="10%"|'''RECORD '''||The record number within the text file to display as the text of the message.
|-valign="top"
|width="10%"|'''HROW '''||A positioning variable generally set by CURROW
|-valign="top"
|width="10%"|'''HCOL '''||A positioning variable generally set by CURCOL
|-valign="top"
|width="10%"|'''NO_WAIT '''||Ignored
|-valign="top"
|}
 
;Comments: 
If HROW and HCOL are zero then the window id positioned in the center of the screen.

===FNOK - Pop-up "OK" question===

FNOK

Description| 
Displays a dialog box with OK yes or NO. If yes is returned FNOK is true else it is false

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''
|-valign="top"
|}
 
;Comments: 
MSGBOX is probably a better option with current programs

===FNOPTIONS - creates a radio dot selection pop up===

Displays a pop up radio dot selection window. If David Blankenship's utility RADIOCHEK.exe is present that will be used. If not present then a BR generated selection window will be generated.

[PICT(PICS\SNAP0005.ptf)]
FNOPTIONS(MAT O$;DEFAULT,TITLE$*100,MESSAGE$*1000,WAITTIME,SROW,SCOL)

;Functions used: 
FNRADIOCHK

;Variables:
{|
|-valign="top"
|width="10%"|'''Mat O$ '''||Matrix containing the descriptions for each line in the list
|-valign="top"
|width="10%"|'''DEFAULT '''||A number indicating which radio dot item should carry the dot when the box is displayed
|-valign="top"
|width="10%"|'''TITLE$ '''||A title to appear across the top of the list box.
|-valign="top"
|width="10%"|'''MESSAGE$ '''||A message to appear in a separate part of the dialog box explaining the choices if appropriate.
|-valign="top"
|width="10%"|'''WAITTIME '''||Number of seconds that the list should be displayed before accepting whatever is checked and continuing.
|-valign="top"
|width="10%"|'''SROW '''||Positioning parameter generally set by CURROW
|-valign="top"
|width="10%"|'''SCOL '''||Positioning parameter generally set by CURCOL
|-valign="top"
|}
 
;Comments:

===FNOPTIONS$ - creates a check box selection pop up===

Similar to FNOPTIONS, but this function displays the information in the form of a multiple selection check box list.

[PICT(PICS\SNAP0006.ptf)]

FNOPTIONS$*100(MAT O$;DEFAULT$*100,TITLE$*100,MESSAGE$*1000,WAITTIME,NONE)

;Functions used: 
FNRADIOCHK

;Variables:
{|
|-valign="top"
|width="10%"|'''DEFAULT '''||A number indicating which radio dot item should carry the dot when the box is displayed
|-valign="top"
|width="10%"|'''TITLE$ '''||A title to appear across the top of the list box.
|-valign="top"
|width="10%"|'''MESSAGE$ '''||A message to appear in a separate part of the dialog box explaining the choices if appropriate.
|-valign="top"
|width="10%"|'''WAITTIME '''||Number of seconds that the list should be displayed before accepting whatever is checked and continuing.
|-valign="top"
|width="10%"|'''NONE '''||A flag that will allow no items to be selected, otherwise the check list may not be exited without at least one selection being made.Positioning parameter generally set by CURROW
|-valign="top"
|}
 
;Comments:

===FNPFKEYLINE - Creates a hot field string of function key options===

See also FNWINBUTTONS for 4.17+

Prints a function key message line in an open window or child window at the row specified. Function keys displayed are hot and return the Fkey value. Fkey references can be hot text or optionally buttons.

[PICT(PICS\SNAP0009.ptf)]

FNPFKEYLINE(ROW,TXT$*80;FKWIN)

Functions used

;Variables:
{|
|-valign="top"
|width="10%"|'''ROW'''||The row number of the window on which the line should be displayed. Negative number indicate that many rows UP from the bottom of the window. Zero "0" indicates the very bottom of the window. All messages will be right justified within the window.
|-valign="top"
|width="10%"|'''TXT$'''||Text to be displayed. Function keys should be designated with a leading carat ^ and trailing double space such as "^Esc End"
|-valign="top"
|width="10%"|'''FKWIN'''||Window number in which the line should be displayed
|-valign="top"
|}
 
;Comments: 
Valid function keys are numbers beginning with "^F" such a ^F9, or abbreviations for keys including ^PgUp ^PgDn ^Esc and ^Enter. These are not case sensitive.
See also FNWINBUTTONS for a GUI based alternative.

===FNPFKEY - Prints a function key message===

FNPFKEY(R,C,F$,TXT$*78) !:

Description| 
Prints a function key message on window zero

Functions used

;Variables:
{|
|-valign="top"
|width="10%"|'''R'''||Row number
|-valign="top"
|width="10%"|'''C'''||Column number
|-valign="top"
|width="10%"|'''F$'''||Function key to be displayed
|-valign="top"
|width="10%"|'''TXT$'''||Message to be displayed next to the function key
|-valign="top"
|}
 
;Comments: 
Displays only one function key message at the row and column of window #0 specified. FNPFKEYLINE is more flexible and recommended.

Effective with GUI mode and release 4.17 FNWINBUTTONS and FNPICBUTTONS are much better options.

===FNRADIOCHK$ - display a radio/checkbox with a set of options===

Used by FNOPTONS and FNOPTIONS$ and FNDLG to display radio dot list, check box list, or a dialog box. Makes use of David Blankenship's RADIOCHK.exe utility.

FNRADIOCHK$*100(CAPTION$*80,INFILE$*60,LEFT,TOP,ALLOW,DEFAULT$*100,TYPE$,LOCATE,NOCOLS,COLWIDTH,WAITTIME;TEXTSTRING$*2400)

;Functions used:

;Variables:
{|
|-valign="top"
|width="10%"|'''CAPTION$ '''||Title for the top bar
|-valign="top"
|width="10%"|'''INFILE$ '''||File name to be processed
|-valign="top"
|width="10%"|'''LEFT '''||Position form left of screen to display in pixels
|-valign="top"
|width="10%"|'''TOP '''||Position from the top of the screen in pixels
|-valign="top"
|width="10%"|'''ALLOW '''||allows no responses if true, requires at least one if false
|-valign="top"
|width="10%"|'''DEFAULT$ '''||A string of 0 and 1 where 0 is not checked and 1 is checked
|-valign="top"
|width="10%"|'''TYPE$ '''||R for Radio C for Check box
|-valign="top"
|width="10%"|'''LOCATE '''||Record number in file to use as data for a dialog box
|-valign="top"
|width="10%"|'''NOCOLS '''||Number of columns to display
|-valign="top"
|width="10%"|'''COLWIDTH '''||Width of columns or buttons. If not provided the spacing will be automatic based on the length of text provided
|-valign="top"
|width="10%"|'''WAITTIME$ '''||Number of seconds to wait before returning the default answer.
|-valign="top"
|width="10%"|'''TEXTSTRING$ '''||Text to display in a dialog box if not using text from a file.
|-valign="top"
|}
 
;Comments:

===FNRADNUM - Return the option selected in a radio dot list===

FNRADNUM(MAT V$)

Description| 
Function determines which in a group of radio buttons was selected and returns the element number

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''
|-valign="top"
|}
 
;Comments:

===FNTIMEOUT - Display timeout message===

FNTIMEOUT(;SECONDS)

Description| 
Displays a message that input has timed out and waits for a keystroke to reactivate the program.

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''
|-valign="top"
|}
 
;Comments:

===FNWINBUTTONS - print one or more buttons on a screen in a designated window===

Similar to and a replacement of FNPFKEYLINE. Prints one or more buttons, right justified in a designated window either BROWs down from the top of the window if BROPW is positive of BROWS up from the bottom of the window if BROW is zero or negative.

[PICT(PICS\SNAP0002.ptf)]

DEF LIBRARY FNWINBUTTONS(BROW,BTEXT$*100;BWIN,CENTER,FONT$)

;Functions used: 
FNWINROWCOL 
;Variables:
{|
|-valign="top"
|width="10%"|'''BROW '''||The row number within a window on which to place the buttons. If 0 or negative the row is up from the bottom of the window, positive is down from the top.
|-valign="top"
|width="10%"|'''BTEXT$ '''||The text to display within the buttons. Each button is designated with a ^followed by FX: where X is the fkey value to be returned when the button is pushed. FX can also be PGUP, PGDN or ESC. The^FX: is followed by the text to appear within each button. Al buttons are dimensioned to the longest string provided for any button.
|-valign="top"
|width="10%"|'''BWIN '''||The window number of the window within which the buttons should appear.
|-valign="top"
|width="10%"|'''CENTER '''||The default is zero (0) which right aligns the buttons on the right hand border of the window. To center the buttons horizontally in the window enter one (1) in this element.
|-valign="top"
|width="10%"|'''FONT$ '''||If this element is blank the default BUTTONS font will be used for the WINBUTTONS. Entering an alternative font can allow wingdings or directional arrows if the font allows it. An example would be specifying TERMINAL on a Windows machine and then usinrt chr$(16) and chr$(17) next to the word Right or Left.
|-valign="top"
|}
 
;Comments: 
Can only be used in GUI ON mode

==String Manipulation==
===FNDECRYPT$ - Decrypt FNENCRYPT$===

Undoes what FNENCRYPT$ does

FNDECRYPT$(PW$)

Functions used

;Variables:
{|
|-valign="top"
|width="10%"|'''PW$'''||The encrypted password from FNENCRYPT$. This is usually a stored value to be compared with an entered value
|-valign="top"
|}
 
;Comments: 
This is a simple encryption routine only meant to hide a value from a casual observer, not a dedicated hacker. A more robust encryption routine is available with George Tisdale's WORKMENU.br menuing system.

===FNENCRYPT$ - Simple encryption===

FNENCRYPT$(PW$) !:

Description| 
Simple encryption routine to ward off SNOOPS, NOT serious hackers

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''
|-valign="top"
|}
 
;Comments: 
This is a simple encryption routine only meant to hide a value from a casual observer, not a dedicated hacker.

===FNFKEY - Converts an FKEY value greater than 1000===

Returns a function key value. If the value would be greater than 1000 then only the right tree places are used to determine the number. Useful in converting button FKEYs to hot text fkeys

FNFKEY(AKEY)

Functions used

;Variables:
{|
|-valign="top"
|width="10%"|'''AKEY'''||An FKEY value to be reduced by 1000 and returned as the value of FKEY. If AKEY is less than 1000 the value of AKEY will be returned
|-valign="top"
|}
 
;Comments:

Use in conjunction with FNPFKEYLINE

===FNNUM$ - Convert number to string===

FNNUM$(NAMT,DCML,LNGTH) !:

Description| 
Converts a number to a character string with fixed decimal places. CNVRT$ is a better option.

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''
|-valign="top"
|}
 
;Comments:

===FNPHONE$ - Convert number to (###) ###-####===

Formats a 10 digit number into a telephone number formatted string

FNPHONE$(X)

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''X'''||Numeric telephone number including a leading "1"
|-valign="top"
|}
 
;Comments:

===FNPROPER$*60 - Convert to Proper Case===

Converts a string into an initial capital title or name case

FNPROPER$*60(A_IN$*60) !:

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''A_IN$'''||String that is to be converted to initial capitals
|-valign="top"
|}
 
;Comments: 
The function uses a lot of SREP$ statements, consequently the string passed should be short enough to not cause a string overflow. About 500 characters is a reasonable limit.

==Other==
===FNAUTO - 1 if last field exit was automatic===

Returns a 1 (true) if the last field was exited with an automatic exit Attribute E or X LASTFIELD is the field # that was current

FNAUTO(LASTFLD) !:

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''NONE
|-valign="top"
|}
 
;Comments:

===FNCLKBUF - Clear keyboard buffer===

Clears the keyboard buffer

FNCLKBUF ! Clear the keyboard buffer

;Functions used: 
None

;Variables:
{|
|-valign="top"
|width="10%"|'''None
|-valign="top"
|}
 
;Comments:

===FNERRTRAP - Trapped Error Processing===

Red Screen error trapping routine. Displays error, program line and number to call. Also logs the error to a log file by workstation and creates an email message

FNERRTRAP(EPROG$*50,ELINE,EERR,ECOUNT,EVARIABLE$,&ECURFLD,EMENU$)

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''EPROG$'''||Program name where the error was generated
|-valign="top"
|width="10%"|'''ELINE'''||Line number where the error occurred
|-valign="top"
|width="10%"|'''EERR'''||Error number that occurred
|-valign="top"
|width="10%"|'''ECOUNT'''||Variable count if appropriate to the error
|-valign="top"
|width="10%"|'''EVARIABLE$'''||Name of the variable, if appropriate where the error occurred
|-valign="top"
|width="10%"|'''ECURFLD'''||Current field where the error occurred if in full screen processing
|-valign="top"
|width="10%"|'''EMENU$ '''||The menu to which the program should return if the error can not be resolved
|-valign="top"
|width="10%"|'''EMENUSEQ$ '''||The menu Sequence to which the program should return if the error can not be resolved.
|-valign="top"
|}
 
;Comments:

Requires FNEMAILFILE and EmailBlaster or EmailMonitor

===FNINIT - Initialize variables in FNSNAP Library===

Initiates the variables for the FNSNAP library. Be careful not to use more than once in a program

FNINIT(;SYSDIR$,SYS$)

Functions used

;Variables:
{|
|-valign="top"
|width="10%"|'''NONE
|-valign="top"
|}
 
;Comments: 
Initializes variables for the older FNSNAP tools. If run in the middle of a program the variables will be reset to the initial values and may cause problems. Most new functions being written should NOT use this function.

===FNPRINTSCREEN - stuff the keyboard to generate a print screen===

Programmatically controls the keyboard to do the equivalent of Ctrl-P to issue a print screen

FNPRINTSCREEN

;Functions used:

;Variables:
{|
|-valign="top"
|width="10%"|'''None
|-valign="top"
|}
 
;Comments:

===FNZERO - set to number if zero===

FNZERO(V,DV) ! SET Variable equal to the Default Variable if zero !:

Description|

==Screen input and display==
===FNMOD - returns the column number of a cell in a grid===

Replaced by CURCOL in 4.17. Returns the column number of the current cell

FNMOD(CEL,COLS)

;Functions used:

;Variables:
{|
|-valign="top"
|width="10%"|'''CEL '''||The cell number where the cursor is located
|-valign="top"
|width="10%"|'''COLS '''||The number of columns in the grid
|-valign="top"
|}
 
;Comments:

===FNPARSERES - returns screen resolution and BR window size for a session===

Converts

FNPARSERES(W$,MAT SCRNRES,MAT WINRES,MAT CONRES)

;Functions used:

;Variables:
{|
|-valign="top"
|width="10%"|'''W$ '''||The workstation ID being queried
|-valign="top"
|width="10%"|'''MAT SCRNRES '''||Two element array of current terminal rows and columns in pixels
|-valign="top"
|width="10%"|'''MAT WINRES '''||Five element matrix 1 0 is maximized ("M-") 1 is windowed ("A-")2 rows in pixels of window 3 columns in pixels of window 4 row position of upper left corner in pixels of window 5 columns position of upper left corner in pixels of window
|-valign="top"
|width="10%"|'''MAT CONRES '''||Five element matrix 1 0 is maximized ("M-") 1 is windowed ("A-")2 rows in pixels of window3 columns in pixels of window 4 row position of upper left corner in pixels of window5 columns position of upper left corner in pixels of window
|-valign="top"
|}
 
;Comments: 
Uses Steve Koger's RESOLUTION.exe utility

===FNPROGRESS - Progress bar===

FNPROGRESS(&PCT_WINDEV,PCT_TOTAL,PCT_DONE;SR$,CAPTION$*55)

Description| 
Displays a progress bar that expands based on numbers passed to the function

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''
|-valign="top"
|}
 
;Comments:

===FNSCREEN - 24 x 80 screen display for screen painter===

FNSCREEN(SCRNO;SCREENFILE,MAT SCRATR$,MAT SCREEN$,MAT INWRK$,MAT INFLDA$,MAT INWRKH$,NOPAINT) ! Retrieve and display screen

Description| 
Displays a generated screen in the full screen window 0. Screen was created using SCREENMN in a 23x80 format.

This function has been significantly changed by NEWSCREEN.dll

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''
|-valign="top"
|}
 
;Comments:

===FNTEXTBOX - creates a text box with word wrap===

Displays and allows input from a windows text box with text

FNTEXTBOX$*4000(&TEXTWIN,SROW,SCOL,ROWS,COLS,TLEN,PARENT,TEXT$*4000;BORDER,TKEY$)

;Functions used:

;Variables:
{|
|-valign="top"
|width="10%"|'''TEXTWIN '''||
|-valign="top"
|width="10%"|'''SROW '''||Starting row within the parent window where the upper left corner should appear
|-valign="top"
|width="10%"|'''SCOL '''||Starting column number within the parent window where the upper left corner should appear
|-valign="top"
|width="10%"|'''ROWS '''||Number of rows the text box should cover
|-valign="top"
|width="10%"|'''COLS '''||Number of Columns the text box should cover
|-valign="top"
|width="10%"|'''TLEN '''||Allowable length of the text
|-valign="top"
|width="10%"|'''PARENT '''||Parent window number
|-valign="top"
|width="10%"|'''TEXT$ '''||Text to display. Modified text will be returned as the value of the function
|-valign="top"
|width="10%"|'''BORDER '''||Zero for no border or any other number to create a single line border
|-valign="top"
|width="10%"|'''TKEY$ '''||Function key to return if the window is to be marked as hot
|-valign="top"
|}
 
;Comments:

===FNWINSCRN - paints a screen in a window===

FNWINSCRN(SFIL,SCRNO,WINNO,WINLIN,WINLEN,MAT SINFLDA$,MATSHELP$;DISPLAY) !:

Description| 
Displays a generated screen in an open child window of specified size. The generated screen was created using SCREENMN

This function has been significantly changed by NEWSCRN.DLL

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''
|-valign="top"
|}
 
;Comments:

===FNWINROWCOL - in GUI mode returns rows and columns of a window===

Must be in GUI ON mode to use this function. Returns the number of rows and number of columns in the specified window. the values returned are actually one shorter than the actual size of the window.

FNWINROWCOL(WINNO,&WROWS,&WCOLS)

;Functions used: 
FNWINSIZE

;Variables:
{|
|-valign="top"
|width="10%"|'''WINNO '''||Window number for which information is requested
|-valign="top"
|width="10%"|'''WROWS '''||Number of rows less one of the requested window
|-valign="top"
|width="10%"|'''WCOLS '''||Number of columns less on of the requested window
|-valign="top"
|}
 
;Comments:

===FNWINSIZE - in GUI mode creates arrays holding all window sizes===

Returns arrays carrying dimensions for all open windows

FNWINSIZE(MAT S_WINNO,MAT S_SROW,MAT S_SCOL,MAT S_EROW,MAT S_ECOL,MAT S_ROWS,MAT S_COLS,MAT S_PARENT)

;Functions used:

;Variables:
{|
|-valign="top"
|width="10%"|'''MAT S_WINNO '''||Array is dynamically populated with window number information
|-valign="top"
|width="10%"|'''MAT S_SROW '''||Array is dynamically populated with starting row number
|-valign="top"
|width="10%"|'''MAT S_SCOL '''||Array is dynamically populated with starting column number
|-valign="top"
|width="10%"|'''MAT S_EROW '''||Array is dynamically populated with ending row number
|-valign="top"
|width="10%"|'''MAT S_ECOL '''||Array is dynamically populated with ending column number
|-valign="top"
|width="10%"|'''MAT S_ROWS '''||Array is dynamically populated with the number of rows in the window
|-valign="top"
|width="10%"|'''MAT S_COLS '''||Array is dynamically populated with the number of columns in the window
|-valign="top"
|width="10%"|'''MAT S_PARENT '''||Array is dynamically populated with the number of the parent window
|-valign="top"
|}
 
;Comments: 
this is the working function for FNWINROWCOL

[[Category:FnSnap]]

FnSnap: Array Functions

2010-03-23T01:11:23Z

Gtisdale: /* FNPARMAT - split an array into sub-arrays */

==Sorting arrays==
===FNSORTARRAY - sort an array with header and footer===
Sorts an array either ascending or descending and optionally excludes elements at the top and bottom to allow headers and footers to remain in place - sort is based on positions within the array, not the start of the string

FNSORTARRAY(MAT L$,START,LENGTH;DESENDING,HEADER,FOOTER)!:

Functions used |None

;Variables:
{|
|-valign="top"
|width="10%"|'''Mat L$'''||matrix to be sorted
|-valign="top"
|width="10%"|'''START'''||Starting position for the character string on which to sort
|-valign="top"
|width="10%"|'''LENGTH'''||length of the character sub string on which to sort
|-valign="top"
|width="10%"|'''DESCENDING'''|| if true sorts descending order else sorts ascending
|-valign="top"
|width="10%"|'''HEADER number of rows at the top of the matrix to omit from the sort
|-valign="top"
|width="10%"|'''FOOTER number of rows at the bottom of the matrix to omit from the sort
|-valign="top"
|}
 
;Comments:

Sort an array on any character sub-set allowing for header rows at the top and footer/total rows at the bottom.

===FNSRTARY - sort an array with header and footer based on itself===

Similar to FNSORTARRAY but uses the entire string to sort rather than a sub string

FNSRTARY(MAT L$;MAT M$,DESENDING,HEADER,FOOTER)

Functions used |None

;Variables:
{|
|-valign="top"
|width="10%"|'''Mat L$'''||matrix to be sorted
|-valign="top"
|width="10%"|'''DESCENDING'''|| if true sorts descending order else sorts ascending
|-valign="top"
|width="10%"|'''HEADER'''|| number of rows at the top of the matrix to omit from the sort
|-valign="top"
|width="10%"|'''FOOTER'''|| number of rows at the bottom of the matrix to omit from the sort
|-valign="top"
|}
 
;Comments:

===FNSRTNARY -Sort a numeric array based on another array===

Similar to FNSRTARY but for a numeric matrix

FNSRTNARY(MAT L;MAT M$,DESENDING,HEADER,FOOTER) !:

Functions used |None

;Variables:
{|
|-valign="top"
|width="10%"|'''Mat L$'''||matrix to be sorted
|-valign="top"
|width="10%"|'''DESCENDING'''||if true sorts descending order else sorts ascending
|-valign="top"
|width="10%"|'''HEADER'''||number of rows at the top of the matrix to omit from the sort
|-valign="top"
|width="10%"|'''FOOTER'''|| number of rows at the bottom of the matrix to omit from the sort
|-valign="top"
|}
 
;Comments:

==Array arithmetic==
===FNCOLSUM - sums the elements of an array for a specified column===

Provides the sum of a single column of a multi column array.

FNCOLSUM(MAT L,C)

;Functions used:

;Variables:
{|
|-valign="top"
|width="10%"|'''MAT L '''||Matrix containing multiple columns
|-valign="top"
|width="10%"|'''C '''||Column number to be summed
|-valign="top"
|}
;Comments:

===FNROWSUM - sums the elements of an array for a specified row===

Returns the sum of a row of a multi row and multi column array

FNROWSUM(MAT L,R)

;Functions used:

;Variables:
{|
|-valign="top"
|width="10%"|'''Mat L '''||Numeric array containing the row to be totaled
|-valign="top"
|width="10%"|'''R '''||Row number to be totaled
|-valign="top"
|}
 
;Comments:

==Searching arrays==
===FNCHRMAT$ - convert a numeric array to character===

Convert a numeric matrix into a formatted character matrix

FNCHRMAT$(CHRMAT$,NUMMAT,FORMAT$;BLANKS)

Functions used |None

;Variables:
{|
|-valign="top"
|width="10%"|'''Mat CHRMAT$'''||matrix that will be output
|-valign="top"
|width="10%"|'''Mat NUMMAT'''||numeric matrix being converted
|-valign="top"
|width="10%"|'''FORMAT$'''||format used to convert each line to a string
|-valign="top"
|width="10%"|'''BLANKS'''||if true replaces a zero value with blanks
|-valign="top"
|}
 
;Comments:

===FNLISTSRCH - searches a character array based on a search string===

FNLISTSRCH(MAT L$,SRCHSTR$,MAT SELECT;STRT)

Description| 
Performs a search on a matrix and modifies the matrix select with elements in the searched matrix that match SRCHSTR$

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''Mat L$ '''||The array to be searched. The search is case insensitive and will match any matching combination regardless of position within each element.
|-valign="top"
|width="10%"|'''SRCHSTR$ '''||The string that is being matched to each element, case insensitive
|-valign="top"
|width="10%"|'''MAT SELECT '''||A numeric array that holds the row numbers of matching elements. Any newly found elements are added to the array.
|-valign="top"
|width="10%"|'''STRT '''||Optional positioning number. matches will only occur if the match is AFTER this position in the row string
|-valign="top"
|}
 
;Comments: 
Used in lists and grids following FNLISTSPEC to allow for a search of the arrays used in a list or grid and a positioning of the cursor on elements matching the criteria

===FNLISTSRCHN - searches a numeric array based on a search string===

FNLISTSRCHN(MAT L,SRCHSTR$,MAT SELECT;STRT,SMASK$)

Description| 
Same as FNLISTSRCH except for a numeric matrix

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''Mat L '''||The array to be searched. Each element is turned into a string before being searched. The search is case insensitive and will match any matching combination regardless of position within each element.
|-valign="top"
|width="10%"|'''SRCHSTR$ '''||The string that is being matched to each element, case insensitive
|-valign="top"
|width="10%"|'''MAT SELECT '''||A numeric array that holds the row numbers of matching elements. Any newly found elements are added to the array.
|-valign="top"
|width="10%"|'''STRT '''||Optional positioning number. matches will only occur if the match is AFTER this position in the row string
|-valign="top"
|width="10%"|'''
|-valign="top"
|}
 
;Comments: 
Used in lists and grids following FNLISTSPEC to allow for a search of the arrays used in a list or grid and a positioning of the cursor on elements matching the criteria

===FNSELECTION - selection process using two arrays===

FNSELECTION(SELECTION,MAT SEL$,MAT SEL;MANY)

Description| 
Maintains two matrices, one SEL is true if an item is selected. The other SEL$ contains the selection sequence number if MANY is greater than one or the word SELECTED if MANY equals one. If many=0 only one item is allowed as a selection.

Functions used |None

;Variables:
{|
|-valign="top"
|width="10%"|'''SELECTION the element number selected or deselected MAT SEL$ selection number or word MAT SEL true if element is selected MANY 0 for a single selection 1 for any or all and a number for a limited number of elements
|-valign="top"
|}
 
;Comments:

===FNSRCHCRIT$*50 - search criteria for a list box===

FNSRCHCRIT$*50(SR$,SC$,LROWS,LCOLS,PARENT;MESSAGE$)

Description| 
Opens a window within a listbox window and asks for a search string

Functions used |

;Variables:
{|
|-valign="top"
|width="10%"|'''
|-valign="top"
|}
 
;Comments:

==Other==
===FNDELROW - removes a row from an array and redimensions the array===

Removes a row form an array and redimensions the array to be one row shorter

FNDELROW$(MAT DEL,DELROW)

;Functions used:

;Variables:
{|
|-valign="top"
|width="10%"|'''MAT DEL '''||The numeric array that needs to be updated
|-valign="top"
|width="10%"|'''DELROW '''||The row number to delete
|-valign="top"
|}
 
;Comments:

===FNDELROW$ - removes a row from an array and redimensions the array===

Removes a row form an array and redimensions the array to be one row shorter

FNDELROW$(MAT DEL$,DELROW)

;Functions used:

;Variables:
{|
|-valign="top"
|width="10%"|'''MAT DEL$ '''||The character array that needs to be updated
|-valign="top"
|width="10%"|'''DELROW '''||The row number to delete
|-valign="top"
|}
 
;Comments:

===FNPARMAT - split an array into sub-arrays===

Parses an array into a multi-dimensional array based on splitting at a predefined character

FNPARMAT(MAT M$,SUB$;NOREF)

Functions used |None

;Variables:

{|
|-valign="top"
|width="10%"|'''MAT M$'''||matrix to be parsed
|-valign="top"
|width="10%"|'''SUB$'''||character that will be treated as a boundary or field separator NOREF if true prevents a single line matrix from being reformatted to a one dimensional matrix
|-valign="top"
|}
 
;Comments:
[[Category:FnSnap]]