Differences

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

--- v5:reference:recordset:getmenu [2019/01/01 23:49] – mnewnham
+++ v5:reference:recordset:getmenu [2019/11/24 00:16] (current) – Add wrap around fetch mode note dregad
@@ Line 1: / Line 1: @@
 ====== getMenu ======
 ~~NOTOC~~
-<WRAP info>
-This method requires that ADODB_FETCH_MODE be set to ADODB_FETCH_NUM prior to execution of the SQL statement that will provide the recordset.
-</WRAP>
 <WRAP right box>
 == See Also ==
@@ Line 10: / Line 7: @@
 == Syntax ==
   string getMenu(
-      optional string $selectName='',
+      string $selectName,
       optional mixed $defaultValue=false,
       optional mixed $blankFirstItem=true,
@@ Line 22: / Line 19: @@
 </WRAP>
 ===== Description =====
-The function ''getMenu()'' Generate an HTML SELECT tag string from a recordset, and return the string.
-If the returned recordset has a single column, the option values and descriptions are the same.
+The function ''getMenu()'' generates an HTML SELECT tag string from a recordset, and returns the string.
-If the returned recordset has 2 cols, the 1st column is the description and the 2nd column is the value. By default, the 2nd column is matched against the defaut, if provided.
-If the recordset returns more than 2 columns, the 3rd and greater columns are discarded.
+If the recordset has a single column, the option values and descriptions are the same.
+If it has 2 columns, the first one is the description and the second is the value. By default, the 2nd column is matched against ''$defaultValue'', if provided.
+Any extra column beyond the first two will be discarded.
+<WRAP info left>
+Until ADOdb 5.20.13, this method required that [[v5:reference:adodb_fetch_mode|ADODB_FETCH_MODE]] be set to ''ADODB_FETCH_NUM'' prior to execution of the SQL statement that will provide the recordset. Starting with 5.20.14, all fetch modes are supported
+</WRAP>
 ===== Parameters =====
 ==== $selectName =====
@@ Line 36: / Line 41: @@
   * true (default) - creates an empty ''<option></option>'' tag
   * false - does not creates an empty ''<option></option>'' tag
-  * string value - creates an ''<option value=``>STRING</option>'' tag
+  * string value - creates an ''<option value="">STRING</option>'' tag
   * string value format ''value:description'' - creates an ''<option value='value'>description</option>'' tag