Whatever message this page gives is out now! Go check it out!
WddxRecordset object
Last update:
May 18, 2026
Includes functions that you call as needed when constructing a WDDX record set. For more information on using this object, see Using WDDX in the Developing ColdFusion Applications.
Functions
| Function syntax | Description |
|---|---|
object.addColumn(name) | Adds a column to all rows in a WddxRecordset instance. |
object.addRows(n) | Adds rows to all columns in a WddxRecordset instance. |
object.dump(escapeStrings) | Displays WddxRecordset object data. |
object.getField(row,col) | Returns the element in a row/column position. |
object.getRowCount() | Indicates the number of rows in a WddxRecordset instance. |
object.setField(row, col, value) | Sets the element in a row/column position. |
object.wddxSerialize(serializer) | Serializes a record set. |
Returns
HTML table of the WddxRecordset object data.
Usage
Convenient for debugging and testing record sets. The boolean parameterescapeStringsdetermines whether<>&characters in string values are escaped as<>&in HTML.
Example
<!--- Create a simple query --->
<cfquery name = "q" datasource ="cfdocexamples">
SELECT Message_Id, Thread_id, Username, Posted
FROM messages
</cfquery>
<!--- Load the wddx.js file, which includes the dump function --->
<script type="text/javascript" src="/CFIDE/scripts/wddx.js"></script>
<script>
// Use WDDX to move from CFML data to JS
<cfwddx action="cfml2js" input="#q#" topLevelVariable="qj">
// Dump the record set
document.write(qj.dump(true));
</script>addColumn
Description
Adds a column to all rows in a WddxRecordset instance.
Syntax
object.addColumn( name )
Parameters
| Parameter | Description |
|---|---|
object | Instance name of the WddxRecordset object |
name | Name of the column to add |
Return value
None.
Usage
Adds a column to every row of the WDDX record set. Initially the new column’s values are set to NULL.
Example
This example calls theaddColumnfunction:
// Create a new record set
rs = new WddxRecordset();
// Add a new column
rs.addColumn("NewColumn");
// Extend the record set by 3 rows
rs.addRows(3);
// Set an element in the first row
// newValue is a previously defined variable
rs.setField(0, "NewColumn", newValue);addRows
Description
Adds rows to all columns in a WddxRecordset instance.
Syntax
object.addRows( n )
Parameters
| Parameter | Description |
|---|---|
object | Instance name of the WddxRecordset object |
n | Integer; number of rows to add |
Return value
None.
Usage
This function adds the specified number of rows to every column of a WDDX record set. Initially, the row/column values are set to NULL.
Example
This example calls theaddRowsfunction:
// Create a new record set
rs = new WddxRecordset();
// Add a new column
rs.addColumn("NewColumn");
// Extend the record set by 3 rows
rs.addRows(3);
// Set an element in the first row
// newValue is a previously defined variable
rs.setField(0, "NewColumn", newValue);getField
Description
Returns the element in the specified row/column position.
Syntax
object.getField( row, col ) |
Parameters
| Parameter | Description |
|---|---|
object | Instance name of the WddxRecordset object |
row | Integer; zero-based row number of the value to return |
col | Integer or string; column of the value to be returned. |
Return value
Returns the value in the specified row/column position.
Usage
Call this function to access a value in a WDDX record set.
Example
This example calls thegetFieldfunction (the variable r is a reference to a WddxRecordset instance):
for (row = 0; row < nRows; ++row)
{
o += "<tr>";
for (i = 0; i < colNames.length; ++i)
{
o += "<td>" + r.getField(row, colNames[i]) + "</td>";
}
o += "</tr>";
}getRowCount
Description
Indicates the number of rows in a WddxRecordset instance.
Syntax
object.getRowCount( ) |
Parameters
| Parameter | Description |
|---|---|
object | Instance name of a WddxRecordset object |
Return value
Integer. Returns the number of rows in the WddxRecordset instance.
Usage
Call this function before a looping construct to determine the number of rows in a record set.
Example
This example calls thegetRowCountfunction:
function dumpWddxRecordset(r)
{
// Get row count
nRows = r.getRowCount();
...
for (row = 0; row < nRows; ++row)
...setField
Description
Sets the element in the specified row/column position.
Syntax
object.setField( row, col, value ) |
Parameters
| Parameter | Description |
|---|---|
object | Instance name of a WddxRecordset object |
row | Integer; row that contains the element to set |
col | Integer or string; the column containing the element to set |
value | Value to set |
Return value
None.
Usage
Call this function to set a value in a WddxRecordset instance.
Example
This example calls thesetFieldfunction:
// Create a new recordset
rs = new WddxRecordset();
// Add a new column
rs.addColumn("NewColumn");
// Extend the record set by 3 rows
rs.addRows(3);
// Set an element in the first row
// newValue is a previously defined variable
rs.setField(0, "NewColumn", newValue);wddxSerialize
Description
Serializes a record set.
Syntax
object.wddxSerialize( serializer ) |
Parameters
| Parameter | Description |
|---|---|
object | Instance name of the WddxRecordset object |
serializer | WddxSerializer instance |
Return value
Returns a Boolean True if serialization was successful; False, otherwise.
Usage
This is an internal function; you do not typically call it.
Example
This example is from the WddxSerializerserializeValuefunction:
...
else if (typeof(obj) == "object")
{
if (obj == null)
{
// Null values become empty strings
this.write("<string></string>");
}
else if (typeof(obj.wddxSerialize) == "function")
{
// Object knows how to serialize itself
bSuccess = obj.wddxSerialize(this);
}
...
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Share additional feedback to help us improve.
0/255
|
