home *** CD-ROM | disk | FTP | other *** search
/ PC World 1999 December / PCWorld_1999-12_cd.bin / Software / Servis / UrthMDB / Codegen / mdbUmcgTest.ht_ / mdbUmcgTest.ht
Text File  |  1999-10-03  |  32KB  |  594 lines
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type"
  4. content="text/html; charset=iso-8859-1">
  5. <meta name="GENERATOR" content="Urthman's MDB Code Generator v 1.x">
  6. <title>Documentation for mdbUmcgTest.bas</title>
  7. </head>
  8.  
  9. <body bgcolor="#FFFFFF">
  10.  
  11. <p align="center"><font size="5" face="Arial">Documentation for Database<br>
  12. <strong>mdbUmcgTest.bas</strong></font></p><hr>
  13. <blockquote>
  14.     <p align="left"><font face="Arial">
  15.     Except where noted, all of the routines and variables listed
  16.     here are Public. Any function that
  17.     requires access to a table will initialize the database and
  18.     subsequently open only the specific table being accessed. Any
  19.     function that requires the database be closed will close all
  20.     open tables, the database and the workspace.</font></p>
  21. </blockquote><hr>
  22. <div align="center"><center>
  23.  
  24. <table border="0" cellpadding="1" cellspacing="2">
  25.     <tr>
  26.         <td align="center" valign="top"><a name="<hr>General Variables:<hr>"><font
  27.         color="#000080" face="Arial"><strong><hr>General Variables:<hr></strong></font></a></td>
  28.         <td><hr><br><hr>
  29.     <tr>
  30.         <td align="center" valign="top"><a name="MdbFileName"><font
  31.         color="#000080" face="Arial"><strong>MdbFileName</strong></font></a></td>
  32.         <td valign="top"><p><font face="Arial">(As String)
  33.         The string variable that must contain the full path and
  34.         and filename of the database before these routines can be
  35.         used.</p></font><p><font
  36.         face="Arial">Example:</font></p>
  37.         <p><font face="Arial"><strong>mdbUmcgTest.MdbFileName = </strong>(Path\Filename.mdb)</font></p><hr>
  38.     <tr>
  39.         <td align="center" valign="top"><a name="<hr>Table Variables:<hr>"><font
  40.         color="#008000" face="Arial"><strong><hr>Table Variables:<hr></strong></font></a></td>
  41.         <td><hr><br><hr>
  42.     <tr>
  43.         <td align="center" valign="top"><a name="MultiKeyERR"><font
  44.         color="#008000" face="Arial"><strong>MultiKeyERR</strong></font></a></td>
  45.         <td valign="top"><font face="Arial">(As Boolean)
  46.         Set to "True" if a failure occurs while working with the table MultiKey.
  47.         Typically, if the end or beginning of a table is encountered,
  48.         there is no data in the table, or a search routine fails, this
  49.         will be set true.  Under all other conditions it will be false.</font></p><hr>
  50.     <tr>
  51.         <td align="center" valign="top"><a name="MultiKeySiz"><font
  52.         color="#008000" face="Arial"><strong>MultiKeySiz</strong></font></a></td>
  53.         <td valign="top"><font face="Arial">(As Long)
  54.         Reports the number of records in table MultiKey.</font></p><hr>
  55.     <tr>
  56.         <td align="center" valign="top"><a name="NoIndexesERR"><font
  57.         color="#008000" face="Arial"><strong>NoIndexesERR</strong></font></a></td>
  58.         <td valign="top"><font face="Arial">(As Boolean)
  59.         Set to "True" if a failure occurs while working with the table NoIndexes.
  60.         Typically, if the end or beginning of a table is encountered,
  61.         there is no data in the table, or a search routine fails, this
  62.         will be set true.  Under all other conditions it will be false.</font></p><hr>
  63.     <tr>
  64.         <td align="center" valign="top"><a name="NoIndexesSiz"><font
  65.         color="#008000" face="Arial"><strong>NoIndexesSiz</strong></font></a></td>
  66.         <td valign="top"><font face="Arial">(As Long)
  67.         Reports the number of records in table NoIndexes.</font></p><hr>
  68.     <tr>
  69.         <td align="center" valign="top"><a name="PrimeKeyERR"><font
  70.         color="#008000" face="Arial"><strong>PrimeKeyERR</strong></font></a></td>
  71.         <td valign="top"><font face="Arial">(As Boolean)
  72.         Set to "True" if a failure occurs while working with the table PrimeKey.
  73.         Typically, if the end or beginning of a table is encountered,
  74.         there is no data in the table, or a search routine fails, this
  75.         will be set true.  Under all other conditions it will be false.</font></p><hr>
  76.     <tr>
  77.         <td align="center" valign="top"><a name="PrimeKeySiz"><font
  78.         color="#008000" face="Arial"><strong>PrimeKeySiz</strong></font></a></td>
  79.         <td valign="top"><font face="Arial">(As Long)
  80.         Reports the number of records in table PrimeKey.</font></p><hr>
  81.     <tr>
  82.         <td align="center" valign="top"><a name="<hr>Database Routines:<hr>"><font
  83.         color="#008080" face="Arial"><strong><hr>Database Routines:<hr></strong></font></a></td>
  84.         <td><hr><br><hr>
  85.     <tr>
  86.         <td align="center" valign="top"><a name="CloseUmcgTest"><font
  87.         color="#008080" face="Arial"><strong>CloseUmcgTest</strong></font></a></td>
  88.         <td valign="top"><font face="Arial">Closes the 
  89.         database mdbUmcgTest</font><p><font
  90.         face="Arial">Example:</font></p>
  91.         <p><font face="Arial"><strong>Call mdbUmcgTest.CloseUmcgTest</strong></font></p><hr>
  92.         </td>
  93.     </tr>
  94.     <tr>
  95.         <td align="center" valign="top"><a name="<hr>Table: MultiKey<hr>"><font
  96.         color="#800080" face="Arial"><strong><hr>Table: MultiKey<hr></strong></font></a></td>
  97.         <td><hr><br><hr>
  98.     <tr>
  99.         <td align="center" valign="top"><a name="MultiKeyClear"><font
  100.         color="#800000" face="Arial"><strong>MultiKeyClear</strong></font></a></td>
  101.         <td valign="top"><font face="Arial">Clears (or neutralizes) the 
  102.         field variables associated with the table MultiKey.
  103.         If there are default values assigned to these fields, these
  104.         default values are used.</font><p><font
  105.         face="Arial">Example:</font></p>
  106.         <p><font face="Arial"><strong>Call mdbUmcgTest.MultiKeyClear</strong></font></p><hr>
  107.         </td>
  108.     </tr>
  109.     <tr>
  110.         <td align="center" valign="top"><a name="MultiKeyFind"><font
  111.         color="#800000" face="Arial"><strong>MultiKeyFind</strong></font></a></td>
  112.         <td valign="top"><font face="Arial">Will attempt
  113.         to find the specified record in the table MultiKey.
  114.         The search is based on the PrimaryKey index variables passed
  115.         to the routine when it was called.
  116.         If the requested record is not found, the field variables
  117.         are filled with either default values from the initial table
  118.         definition, or are filled with neutral (or null) values.
  119.         The index field variables passed in the command line are
  120.         also left in the field variables for use with the FindNX
  121.         and FindPV find-entensions.
  122.         </font>
  123.         <p><font face="Arial">Example:</font></p>
  124.         <p><font face="Arial"><strong>Call mdbUmcgTest.MultiKeyFind(</strong>PrimaryKey Parameters<strong>)<br>
  125.         If mdbUmcgTest.MultiKeyERR Then</strong> (Record Not Found)</font></p><hr>
  126.         </td>
  127.     </tr>
  128.     <tr>
  129.         <td align="center" valign="top"><a name="MultiKeyBySecondary"><font
  130.         color="#800000" face="Arial"><strong>MultiKeyBySecondary</strong></font></a></td>
  131.         <td valign="top"><font face="Arial">Will attempt
  132.         to find the specified record in the table MultiKey.
  133.         The search is based on the Secondary index variables passed
  134.         to the routine when it was called.
  135.         If the requested record is not found, the field variables
  136.         are filled with either default values from the initial table
  137.         definition, or are filled with neutral (or null) values.
  138.         The index field variables passed in the command line are
  139.         also left in the field variables for use with the FindNX
  140.         and FindPV find-entensions.
  141.         </font>
  142.         <p><font face="Arial">Example:</font></p>
  143.         <p><font face="Arial"><strong>Call mdbUmcgTest.MultiKeyBySecondary(</strong>Secondary Parameters<strong>)<br>
  144.         If mdbUmcgTest.MultiKeyERR Then</strong> (Record Not Found)</font></p><hr>
  145.         </td>
  146.     </tr>
  147.     <tr>
  148.         <td align="center" valign="top"><a name="MultiKeyByTiertiary"><font
  149.         color="#800000" face="Arial"><strong>MultiKeyByTiertiary</strong></font></a></td>
  150.         <td valign="top"><font face="Arial">Will attempt
  151.         to find the specified record in the table MultiKey.
  152.         The search is based on the Tiertiary index variables passed
  153.         to the routine when it was called.
  154.         If the requested record is not found, the field variables
  155.         are filled with either default values from the initial table
  156.         definition, or are filled with neutral (or null) values.
  157.         The index field variables passed in the command line are
  158.         also left in the field variables for use with the FindNX
  159.         and FindPV find-entensions.
  160.         </font>
  161.         <p><font face="Arial">Example:</font></p>
  162.         <p><font face="Arial"><strong>Call mdbUmcgTest.MultiKeyByTiertiary(</strong>Tiertiary Parameters<strong>)<br>
  163.         If mdbUmcgTest.MultiKeyERR Then</strong> (Record Not Found)</font></p><hr>
  164.         </td>
  165.     </tr>
  166.     <tr>
  167.         <td align="center" valign="top"><a name="MultiKeyFindNX"><font
  168.         color="#800000" face="Arial"><strong>MultiKeyFindNX</strong></font></a></td>
  169.         <td valign="top"><font face="Arial">
  170.         Designed to follow a failure to find a specific record, this routine
  171.         will attempt to find the next record in the table
  172.         MultiKey following the one specified.
  173.         The search is based on the current index variables set
  174.         in the field variable data when the routine was called.
  175.         If the end of the table is encountered, the field variables
  176.         are filled with either default values from the initial table
  177.         definition, or are filled with neutral (or null) values.</font>
  178.         <p><font face="Arial">Example:</font></p>
  179.         <p><font face="Arial">(Will need the current index
  180.         field variable data first, either from manual assignment or
  181.         from whatever data is current.)</p><p><strong>Call mdbUmcgTest.MultiKeyFindNX<br>
  182.         If mdbUmcgTest.MultiKeyERR Then</strong> (End of Table)</font></p><hr>
  183.         </td>
  184.     </tr>
  185.     <tr>
  186.         <td align="center" valign="top"><a name="MultiKeyFindPV"><font
  187.         color="#800000" face="Arial"><strong>MultiKeyFindPV</strong></font></a></td>
  188.         <td valign="top"><font face="Arial">
  189.         Designed to follow a failure to find a specific record, this routine
  190.         will attempt to find the previous record in the table
  191.         MultiKey before the one specified.
  192.         The search is based on the current index variables set
  193.         in the field variable data when the routine was called.
  194.         If the beginning of the table is encountered, the field variables
  195.         are filled with either default values from the initial table
  196.         definition, or are filled with neutral (or null) values.</font>
  197.         <p><font face="Arial">Example:</font></p>
  198.         <p><font face="Arial">(Will need the current index
  199.         field variable data first, either from manual assignment or
  200.         from whatever data is current.)</p><p><strong>Call mdbUmcgTest.MultiKeyFindPV<br>
  201.         If mdbUmcgTest.MultiKeyERR Then</strong> (Beginning of Table)</font></p><hr>
  202.         </td>
  203.     </tr>
  204.     <tr>
  205.         <td align="center" valign="top"><a name="MultiKeyFirst"><font
  206.         color="#800000" face="Arial"><strong>MultiKeyFirst</strong></font></a></td>
  207.         <td valign="top"><font face="Arial">Moves the 
  208.         table MultiKey to the first record based on the current index and, on success,
  209.         populates the field variables associated with the table MultiKey
  210.         with the record data. If there are no records in this
  211.         table, the field variables are filled with either
  212.         default values from the initial table definition, or are
  213.         filled with neutral (or null) values.</font><p><font
  214.         face="Arial">Example:</font></p>
  215.         <p><font face="Arial"><strong>Call mdbUmcgTest.MultiKeyFirst<br>
  216.         If mdbUmcgTest.MultiKeyERR Then </strong>(no data present)</font></p><hr>
  217.         </td>
  218.     </tr>
  219.     <tr>
  220.         <td align="center" valign="top"><a name="MultiKeyIsKey"><font
  221.         color="#800000" face="Arial"><strong>MultiKeyIsKey</strong></font></a></td>
  222.         <td valign="top"><font face="Arial"><strong>Function:</strong> Returns 
  223.         True if the current index for MultiKey is the Primary Key
  224.         otherwise returns False.
  225.         </font><p><font face="Arial">Example:</font></p>
  226.         <p><font face="Arial"><strong>
  227.         If mdbUmcgTest.MultiKeyIsKey Then </strong>(Current key is Primary)</font></p><hr>
  228.         </td>
  229.     </tr>
  230.     <tr>
  231.         <td align="center" valign="top"><a name="MultiKeyKill"><font
  232.         color="#800000" face="Arial"><strong>MultiKeyKill</strong></font></a></td>
  233.         <td valign="top"><font face="Arial">Deletes the 
  234.         record from the table MultiKey that includes
  235.         the PrimaryKey elements passed to the routine in the
  236.         parameter list.
  237.         If the table is currently using an index other than
  238.         the PrimaryKey, then the original index being used
  239.         is restored before the routine exits back to your program.
  240.         </font><p><font
  241.         face="Arial">Example:</font></p>
  242.         <p><font face="Arial">
  243.         <strong>Call mdbUmcgTest.MultiKeyKill(</strong>PrimaryKey Parameters<strong>)
  244.         </strong></font></p><hr>
  245.         </td>
  246.     </tr>
  247.     <tr>
  248.         <td align="center" valign="top"><a name="MultiKeyLast"><font
  249.         color="#800000" face="Arial"><strong>MultiKeyLast</strong></font></a></td>
  250.         <td valign="top"><font face="Arial">Moves the 
  251.         table MultiKey to the last record based on the current index and, on success,
  252.         populates the field variables associated with the table MultiKey
  253.         with the record data. If there are no records in this
  254.         table, the field variables are filled with either
  255.         default values from the initial table definition, or are
  256.         filled with neutral (or null) values.</font><p><font
  257.         face="Arial">Example:</font></p>
  258.         <p><font face="Arial"><strong>Call mdbUmcgTest.MultiKeyLast<br>
  259.         If mdbUmcgTest.MultiKeyERR Then </strong>(no data present)</font></p><hr>
  260.         </td>
  261.     </tr>
  262.     <tr>
  263.         <td align="center" valign="top"><a name="MultiKeyNext"><font
  264.         color="#800000" face="Arial"><strong>MultiKeyNext</strong></font></a></td>
  265.         <td valign="top"><font face="Arial">Moves the 
  266.         table MultiKey to the next record based on the current index and, on success,
  267.         populates the field variables associated with the table MultiKey
  268.         with the record data. If the end of the table is encountered,
  269.         the field variables are filled with either
  270.         default values from the initial table definition, or are
  271.         filled with neutral (or null) values.</font><p><font
  272.         face="Arial">Example:</font></p>
  273.         <p><font face="Arial"><strong>Call mdbUmcgTest.MultiKeyNext<br>
  274.         If mdbUmcgTest.MultiKeyERR Then</strong> (End of table)</font></p><hr>
  275.         </td>
  276.     </tr>
  277.     <tr>
  278.         <td align="center" valign="top"><a name="MultiKeyPrevious"><font
  279.         color="#800000" face="Arial"><strong>MultiKeyPrevious</strong></font></a></td>
  280.         <td valign="top"><font face="Arial">Moves the 
  281.         table MultiKey to the previous record based on the current index and, on success,
  282.         populates the field variables associated with the table MultiKey
  283.         with the record data. If the beginning of the table is
  284.         encountered, the field variables are filled with either
  285.         default values from the initial table definition, or are
  286.         filled with neutral (or null) values.</font><p><font
  287.         face="Arial">Example:</font></p>
  288.         <p><font face="Arial"><strong>Call mdbUmcgTest.MultiKeyPrevious<br>
  289.         If mdbUmcgTest.MultiKeyERR Then</strong> (Beginning of table)</font></p><hr>
  290.         </td>
  291.     </tr>
  292.     <tr>
  293.         <td align="center" valign="top"><a name="MultiKeySave"><font
  294.         color="#800000" face="Arial"><strong>MultiKeySave</strong></font></a></td>
  295.         <td valign="top"><font face="Arial">Saves (new) or 
  296. updates (existing) the current record of the table MultiKey.
  297.         If the table is currently using an index other than
  298.         the PrimaryKey, then the original index being used
  299.         is restored before the routine exits back to your program.
  300.         </font><p><font face="Arial">Example:</font></p>
  301.         <p><font face="Arial"><strong>Call mdbUmcgTest.MultiKeySave</strong></font></p><hr>
  302.         </td>
  303.     </tr>
  304.     <tr>
  305.         <td align="center" valign="top"><a name="MultiKeyPurge"><font
  306.         color="#800000" face="Arial"><strong>MultiKeyPurge</strong></font></a></td>
  307.         <td valign="top"><font face="Arial">Deletes all 
  308.         of the records in the table MultiKey.
  309.         </font><p><font face="Arial">Example:</font></p>
  310.         <p><font face="Arial"><strong>Call mdbUmcgTest.MultiKeyPurge</strong></font></p><hr>
  311.         </td>
  312.     </tr>
  313.     <tr>
  314.         <td align="center" valign="top"><a name="<hr>Table: NoIndexes<hr>"><font
  315.         color="#800080" face="Arial"><strong><hr>Table: NoIndexes<hr></strong></font></a></td>
  316.         <td><hr><br><hr>
  317.     <tr>
  318.         <td align="center" valign="top"><a name="NoIndexesClear"><font
  319.         color="#800000" face="Arial"><strong>NoIndexesClear</strong></font></a></td>
  320.         <td valign="top"><font face="Arial">Clears (or neutralizes) the 
  321.         field variables associated with the table NoIndexes.
  322.         If there are default values assigned to these fields, these
  323.         default values are used.</font><p><font
  324.         face="Arial">Example:</font></p>
  325.         <p><font face="Arial"><strong>Call mdbUmcgTest.NoIndexesClear</strong></font></p><hr>
  326.         </td>
  327.     </tr>
  328.     <tr>
  329.         <td align="center" valign="top"><a name="NoIndexesFirst"><font
  330.         color="#800000" face="Arial"><strong>NoIndexesFirst</strong></font></a></td>
  331.         <td valign="top"><font face="Arial">Moves the 
  332.         table NoIndexes to the first record and, on success,
  333.         populates the field variables associated with the table NoIndexes
  334.         with the record data. If there are no records in this
  335.         table, the field variables are filled with either
  336.         default values from the initial table definition, or are
  337.         filled with neutral (or null) values.</font><p><font
  338.         face="Arial">Example:</font></p>
  339.         <p><font face="Arial"><strong>Call mdbUmcgTest.NoIndexesFirst<br>
  340.         If mdbUmcgTest.NoIndexesERR Then </strong>(no data present)</font></p><hr>
  341.         </td>
  342.     </tr>
  343.     <tr>
  344.         <td align="center" valign="top"><a name="NoIndexesKill"><font
  345.         color="#800000" face="Arial"><strong>NoIndexesKill</strong></font></a></td>
  346.         <td valign="top"><font face="Arial">Deletes the 
  347.         current record from the table NoIndexes.
  348.         </font><p><font
  349.         face="Arial">Example:</font></p>
  350.         <p><font face="Arial">
  351.         (A current record MUST be present.)</p><p>
  352.         <strong>Call mdbUmcgTest.NoIndexesKill
  353.         </strong></font></p><hr>
  354.         </td>
  355.     </tr>
  356.     <tr>
  357.         <td align="center" valign="top"><a name="NoIndexesLast"><font
  358.         color="#800000" face="Arial"><strong>NoIndexesLast</strong></font></a></td>
  359.         <td valign="top"><font face="Arial">Moves the 
  360.         table NoIndexes to the last record and, on success,
  361.         populates the field variables associated with the table NoIndexes
  362.         with the record data. If there are no records in this
  363.         table, the field variables are filled with either
  364.         default values from the initial table definition, or are
  365.         filled with neutral (or null) values.</font><p><font
  366.         face="Arial">Example:</font></p>
  367.         <p><font face="Arial"><strong>Call mdbUmcgTest.NoIndexesLast<br>
  368.         If mdbUmcgTest.NoIndexesERR Then </strong>(no data present)</font></p><hr>
  369.         </td>
  370.     </tr>
  371.     <tr>
  372.         <td align="center" valign="top"><a name="NoIndexesNext"><font
  373.         color="#800000" face="Arial"><strong>NoIndexesNext</strong></font></a></td>
  374.         <td valign="top"><font face="Arial">Moves the 
  375.         table NoIndexes to the next record and, on success,
  376.         populates the field variables associated with the table NoIndexes
  377.         with the record data. If the end of the table is encountered,
  378.         the field variables are filled with either
  379.         default values from the initial table definition, or are
  380.         filled with neutral (or null) values.</font><p><font
  381.         face="Arial">Example:</font></p>
  382.         <p><font face="Arial"><strong>Call mdbUmcgTest.NoIndexesNext<br>
  383.         If mdbUmcgTest.NoIndexesERR Then</strong> (End of table)</font></p><hr>
  384.         </td>
  385.     </tr>
  386.     <tr>
  387.         <td align="center" valign="top"><a name="NoIndexesPrevious"><font
  388.         color="#800000" face="Arial"><strong>NoIndexesPrevious</strong></font></a></td>
  389.         <td valign="top"><font face="Arial">Moves the 
  390.         table NoIndexes to the previous record and, on success,
  391.         populates the field variables associated with the table NoIndexes
  392.         with the record data. If the beginning of the table is
  393.         encountered, the field variables are filled with either
  394.         default values from the initial table definition, or are
  395.         filled with neutral (or null) values.</font><p><font
  396.         face="Arial">Example:</font></p>
  397.         <p><font face="Arial"><strong>Call mdbUmcgTest.NoIndexesPrevious<br>
  398.         If mdbUmcgTest.NoIndexesERR Then</strong> (Beginning of table)</font></p><hr>
  399.         </td>
  400.     </tr>
  401.     <tr>
  402.         <td align="center" valign="top"><a name="NoIndexesSave"><font
  403.         color="#800000" face="Arial"><strong>NoIndexesSave</strong></font></a></td>
  404.         <td valign="top"><font face="Arial">Adds
  405. the current record to the table NoIndexes.
  406.         </font><p><font face="Arial">Example:</font></p>
  407.         <p><font face="Arial"><strong>Call mdbUmcgTest.NoIndexesSave</strong></font></p><hr>
  408.         </td>
  409.     </tr>
  410.     <tr>
  411.         <td align="center" valign="top"><a name="NoIndexesPurge"><font
  412.         color="#800000" face="Arial"><strong>NoIndexesPurge</strong></font></a></td>
  413.         <td valign="top"><font face="Arial">Deletes all 
  414.         of the records in the table NoIndexes.
  415.         </font><p><font face="Arial">Example:</font></p>
  416.         <p><font face="Arial"><strong>Call mdbUmcgTest.NoIndexesPurge</strong></font></p><hr>
  417.         </td>
  418.     </tr>
  419.     <tr>
  420.         <td align="center" valign="top"><a name="<hr>Table: PrimeKey<hr>"><font
  421.         color="#800080" face="Arial"><strong><hr>Table: PrimeKey<hr></strong></font></a></td>
  422.         <td><hr><br><hr>
  423.     <tr>
  424.         <td align="center" valign="top"><a name="PrimeKeyClear"><font
  425.         color="#800000" face="Arial"><strong>PrimeKeyClear</strong></font></a></td>
  426.         <td valign="top"><font face="Arial">Clears (or neutralizes) the 
  427.         field variables associated with the table PrimeKey.
  428.         If there are default values assigned to these fields, these
  429.         default values are used.</font><p><font
  430.         face="Arial">Example:</font></p>
  431.         <p><font face="Arial"><strong>Call mdbUmcgTest.PrimeKeyClear</strong></font></p><hr>
  432.         </td>
  433.     </tr>
  434.     <tr>
  435.         <td align="center" valign="top"><a name="PrimeKeyFind"><font
  436.         color="#800000" face="Arial"><strong>PrimeKeyFind</strong></font></a></td>
  437.         <td valign="top"><font face="Arial">Will attempt
  438.         to find the specified record in the table PrimeKey.
  439.         The search is based on the PrimaryKey index variables passed
  440.         to the routine when it was called.
  441.         If the requested record is not found, the field variables
  442.         are filled with either default values from the initial table
  443.         definition, or are filled with neutral (or null) values.
  444.         The index field variables passed in the command line are
  445.         also left in the field variables for use with the FindNX
  446.         and FindPV find-entensions.
  447.         </font>
  448.         <p><font face="Arial">Example:</font></p>
  449.         <p><font face="Arial"><strong>Call mdbUmcgTest.PrimeKeyFind(</strong>PrimaryKey Parameters<strong>)<br>
  450.         If mdbUmcgTest.PrimeKeyERR Then</strong> (Record Not Found)</font></p><hr>
  451.         </td>
  452.     </tr>
  453.     <tr>
  454.         <td align="center" valign="top"><a name="PrimeKeyFindNX"><font
  455.         color="#800000" face="Arial"><strong>PrimeKeyFindNX</strong></font></a></td>
  456.         <td valign="top"><font face="Arial">
  457.         Designed to follow a failure to find a specific record, this routine
  458.         will attempt to find the next record in the table
  459.         PrimeKey following the one specified.
  460.         The search is based on the PrimaryKey index variables set
  461.         in the field variable data when the routine was called.
  462.         If the end of the table is encountered, the field variables
  463.         are filled with either default values from the initial table
  464.         definition, or are filled with neutral (or null) values.</font>
  465.         <p><font face="Arial">Example:</font></p>
  466.         <p><font face="Arial">(Will need PrimaryKey
  467.         field variable data first, either from manual assignment or
  468.         from whatever data is current.)</p><p><strong>Call mdbUmcgTest.PrimeKeyFindNX<br>
  469.         If mdbUmcgTest.PrimeKeyERR Then</strong> (End of Table)</font></p><hr>
  470.         </td>
  471.     </tr>
  472.     <tr>
  473.         <td align="center" valign="top"><a name="PrimeKeyFindPV"><font
  474.         color="#800000" face="Arial"><strong>PrimeKeyFindPV</strong></font></a></td>
  475.         <td valign="top"><font face="Arial">
  476.         Designed to follow a failure to find a specific record, this routine
  477.         will attempt to find the previous record in the table
  478.         PrimeKey before the one specified.
  479.         The search is based on the PrimaryKey index variables set
  480.         in the field variable data when the routine was called.
  481.         If the beginning of the table is encountered, the field variables
  482.         are filled with either default values from the initial table
  483.         definition, or are filled with neutral (or null) values.</font>
  484.         <p><font face="Arial">Example:</font></p>
  485.         <p><font face="Arial">(Will need PrimaryKey
  486.         field variable data first, either from manual assignment or
  487.         from whatever data is current.)</p><p><strong>Call mdbUmcgTest.PrimeKeyFindPV<br>
  488.         If mdbUmcgTest.PrimeKeyERR Then</strong> (Beginning of Table)</font></p><hr>
  489.         </td>
  490.     </tr>
  491.     <tr>
  492.         <td align="center" valign="top"><a name="PrimeKeyFirst"><font
  493.         color="#800000" face="Arial"><strong>PrimeKeyFirst</strong></font></a></td>
  494.         <td valign="top"><font face="Arial">Moves the 
  495.         table PrimeKey to the first record based on the PrimaryKey and, on success,
  496.         populates the field variables associated with the table PrimeKey
  497.         with the record data. If there are no records in this
  498.         table, the field variables are filled with either
  499.         default values from the initial table definition, or are
  500.         filled with neutral (or null) values.</font><p><font
  501.         face="Arial">Example:</font></p>
  502.         <p><font face="Arial"><strong>Call mdbUmcgTest.PrimeKeyFirst<br>
  503.         If mdbUmcgTest.PrimeKeyERR Then </strong>(no data present)</font></p><hr>
  504.         </td>
  505.     </tr>
  506.     <tr>
  507.         <td align="center" valign="top"><a name="PrimeKeyKill"><font
  508.         color="#800000" face="Arial"><strong>PrimeKeyKill</strong></font></a></td>
  509.         <td valign="top"><font face="Arial">Deletes the 
  510.         record from the table PrimeKey that includes
  511.         the PrimaryKey elements passed to the routine in the
  512.         parameter list.
  513.         </font><p><font
  514.         face="Arial">Example:</font></p>
  515.         <p><font face="Arial">
  516.         <strong>Call mdbUmcgTest.PrimeKeyKill(</strong>PrimaryKey Parameters<strong>)
  517.         </strong></font></p><hr>
  518.         </td>
  519.     </tr>
  520.     <tr>
  521.         <td align="center" valign="top"><a name="PrimeKeyLast"><font
  522.         color="#800000" face="Arial"><strong>PrimeKeyLast</strong></font></a></td>
  523.         <td valign="top"><font face="Arial">Moves the 
  524.         table PrimeKey to the last record based on the PrimaryKey and, on success,
  525.         populates the field variables associated with the table PrimeKey
  526.         with the record data. If there are no records in this
  527.         table, the field variables are filled with either
  528.         default values from the initial table definition, or are
  529.         filled with neutral (or null) values.</font><p><font
  530.         face="Arial">Example:</font></p>
  531.         <p><font face="Arial"><strong>Call mdbUmcgTest.PrimeKeyLast<br>
  532.         If mdbUmcgTest.PrimeKeyERR Then </strong>(no data present)</font></p><hr>
  533.         </td>
  534.     </tr>
  535.     <tr>
  536.         <td align="center" valign="top"><a name="PrimeKeyNext"><font
  537.         color="#800000" face="Arial"><strong>PrimeKeyNext</strong></font></a></td>
  538.         <td valign="top"><font face="Arial">Moves the 
  539.         table PrimeKey to the next record based on the PrimaryKey and, on success,
  540.         populates the field variables associated with the table PrimeKey
  541.         with the record data. If the end of the table is encountered,
  542.         the field variables are filled with either
  543.         default values from the initial table definition, or are
  544.         filled with neutral (or null) values.</font><p><font
  545.         face="Arial">Example:</font></p>
  546.         <p><font face="Arial"><strong>Call mdbUmcgTest.PrimeKeyNext<br>
  547.         If mdbUmcgTest.PrimeKeyERR Then</strong> (End of table)</font></p><hr>
  548.         </td>
  549.     </tr>
  550.     <tr>
  551.         <td align="center" valign="top"><a name="PrimeKeyPrevious"><font
  552.         color="#800000" face="Arial"><strong>PrimeKeyPrevious</strong></font></a></td>
  553.         <td valign="top"><font face="Arial">Moves the 
  554.         table PrimeKey to the previous record based on the PrimaryKey and, on success,
  555.         populates the field variables associated with the table PrimeKey
  556.         with the record data. If the beginning of the table is
  557.         encountered, the field variables are filled with either
  558.         default values from the initial table definition, or are
  559.         filled with neutral (or null) values.</font><p><font
  560.         face="Arial">Example:</font></p>
  561.         <p><font face="Arial"><strong>Call mdbUmcgTest.PrimeKeyPrevious<br>
  562.         If mdbUmcgTest.PrimeKeyERR Then</strong> (Beginning of table)</font></p><hr>
  563.         </td>
  564.     </tr>
  565.     <tr>
  566.         <td align="center" valign="top"><a name="PrimeKeySave"><font
  567.         color="#800000" face="Arial"><strong>PrimeKeySave</strong></font></a></td>
  568.         <td valign="top"><font face="Arial">Saves (new) or 
  569. updates (existing) the current record of the table PrimeKey.
  570.         </font><p><font face="Arial">Example:</font></p>
  571.         <p><font face="Arial"><strong>Call mdbUmcgTest.PrimeKeySave</strong></font></p><hr>
  572.         </td>
  573.     </tr>
  574.     <tr>
  575.         <td align="center" valign="top"><a name="PrimeKeyPurge"><font
  576.         color="#800000" face="Arial"><strong>PrimeKeyPurge</strong></font></a></td>
  577.         <td valign="top"><font face="Arial">Deletes all 
  578.         of the records in the table PrimeKey.
  579.         </font><p><font face="Arial">Example:</font></p>
  580.         <p><font face="Arial"><strong>Call mdbUmcgTest.PrimeKeyPurge</strong></font></p><hr>
  581.         </td>
  582.     </tr>
  583. </table>
  584. </center></div>
  585. <hr>
  586. <p align="center"><font face="Arial">
  587. Code and Documentation generated by Urthman's MDB Code Generator.<br>
  588. <a href="http://www.a-znet.com/jse/"><font
  589. face="Arial"><strong>Visit our Web Site on the Internet
  590. </strong><hr></font></a></p>
  591. <p> </p>
  592. </body>
  593. </html>
  594.