Returns

HTML table of the WddxRecordset object data.

Usage

Convenient for debugging and testing record sets. The boolean parameter escapeStrings determines whether <>& characters in string values are escaped as &lt;&gt;&amp; 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> 

Description

Adds a column to all rows in a WddxRecordset instance.

Syntax

object.addColumn( name )

Parameters

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 the addColumn function:

// 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);

Description

Adds rows to all columns in a WddxRecordset instance.

Syntax

object.addRows( n )

Parameters

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 the addRows function:

// 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);

Description

Returns the element in the specified row/column position.

Syntax

object.getField( row, col )

Parameters

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 the getField function (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>"; 
}

Description

Indicates the number of rows in a WddxRecordset instance.

Syntax

object.getRowCount( )

Parameters

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 the getRowCount function:

function dumpWddxRecordset(r) 
{  
// Get row count  
    nRows = r.getRowCount(); 
... 
    for (row = 0; row < nRows; ++row) 
...

Description

Sets the element in the specified row/column position.

Syntax

object.setField( row, col, value )

Parameters

Return value

None.

Usage

Call this function to set a value in a WddxRecordset instance.

Example

This example calls the setField function:

// 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);

Description

Serializes a record set.

Syntax

object.wddxSerialize( serializer )

Parameters

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 WddxSerializer serializeValue function:

... 
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); 
} 
...