Adobe ColdFusion 8

CCFXRequest::AddQuery

Syntax

CCFXQuery* CCFXRequest::AddQuery(LPCSTR lpszName, CCFXStringSet* pColumns)

Description

Adds a query to the calling template. The query can be accessed by CFML tags (for example, cfoutput or cftable) within the template. After calling AddQuery, the query is empty (it has 0 rows). To populate the query with data, call the CCFXQuery::AddRow and CCFXQuery::SetData functions.

Returns

Returns a pointer to the query that was added to the template (an object of class CCFXQuery). The memory allocated for the returned query is freed automatically by ColdFusion after the request is completed.

Parameters

Parameter

Description

lpszName

Name of query to add to the template (must be unique)

pColumns

List of column names to be used in the query

Example

The following example adds a query named 'People' to the calling template. The query has two columns ('FirstName' and 'LastName') and two rows:

// Create a string set and add the column names to it
    CCFXStringSet* pColumns = pRequest->CreateStringSet() ;
    int iFirstName = pColumns->AddString( "FirstName" ) ;
    int iLastName = pColumns->AddString( "LastName" ) ;
     
    // Create a query that contains these columns
    CCFXQuery* pQuery = pRequest->AddQuery( "People", pColumns ) ;
     
    // Add data to the query
    int iRow ;
    iRow = pQuery->AddRow() ;
    pQuery->SetData( iRow, iFirstName, "John" ) ;
    pQuery->SetData( iRow, iLastName, "Smith" ) ;
    iRow = pQuery->AddRow() ;
    pQuery->SetData( iRow, iFirstName, "Jane" ) ;
    pQuery->SetData( iRow, iLastName, "Doe" ) ;