MACROMEDIA COLDFUSION 4.5-DEVELOPING WEB, Develop Manual

Page: 325 / 380

Chapter 18: Building Custom CFAPI Tags 299
CCFXQuery::SetQueryString
This is a deprecated function and should not be used.
CCFXQuery::SetTotalTime
This is a deprecated function and should not be used.
CCFXRequest Class
Abstract class that represents a request made to a ColdFusion Extension (CFX). An
instance of this class is passed to the main function of your extension DLL. The class
provides several interfaces that may be used by the custom extension, including
functions for reading and writing variables, returning output, creating and using
queries, and throwing exceptions.
Class Members
virtual BOOL AttributeExists( LPCSTR lpszName )
CCFXRequest::AttributeExists checks to see whether the attribute was passed to
the tag.
virtual LPCSTR GetAttribute( LPCSTR lpszName )
CCFXRequest::GetAttribute retrieves the value of the passed attribute.
virtual CCFXStringSet* GetAttributeList()
CCFXRequest::GetAttributeList retrieves a list of all attribute names passed to the
tag.
virtual CCFXQuery* GetQuery()
CCFXRequest::GetQuery retrieves the query that was passed to the tag.
virtual LPCSTR GetSetting( LPCSTR lpszSettingName )
CCFXRequest::GetSetting retrieves the value of a custom tag setting.
virtual void Write( LPCSTR lpszOutput )
CCFXRequest::Write writes text output back to the user.
virtual void SetVariable( LPCSTR lpszName, LPCSTR lpszValue )
CCFXRequest::SetVariable sets a variable in the template that contains this tag.
virtual CCFXQuery* AddQuery( LPCSTR lpszName, CCFXStringSet* pColumns )
CCFXRequest::AddQuery adds a query to the template that contains this tag.
virtual BOOL Debug()
CCFXRequest::Debug checks whether the tag contains the
DEBUG
attribute.