User Guide

CCFXRequest class 757
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 interfaces that
can be used by the custom extension for the following actions:
• Reading and writing variables
• Returning output
• Creating and using queries
• Throwing exceptions
Class members
virtual BOOL AttributeExists
( LPCSTR lpszName )
CCFXRequest::AttributeExists
checks
whether the attribute was passed to the
tag.
virtual LPCSTR GetAttribute
( LPCSTR lpszName )
CCFXRequest::GetAttribute
gets the
value of the passed attribute.
virtual CCFXStringSet* GetAttributeList()
CCFXRequest::GetAttributeList
gets an
array of attribute names passed to the
tag.
virtual CCFXQuery* GetQuery()
CCFXRequest::GetQuery
gets the query
that was passed to the tag.
virtual LPCSTR GetSetting( LPCSTR lpszSettingName )
CCFXRequest::GetSetting
This member is deprecated. It might not
work, and might cause an error, in later
releases.
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.
virtual void WriteDebug( LPCSTR lpszOutput )
CCFXRequest::WriteDebug
writes text
output into the debug stream.
virtual CCFXStringSet* CreateStringSet()
CCFXRequest::CreateStringSet
allocates
and returns a CCFXStringSet instance.
virtual void ThrowException( LPCSTR lpszError,
LPCSTR lpszDiagnostics )
CCFXRequest::ThrowException
throws an
exception and ends processing of this
request.
virtual void ReThrowException
( CCFXException* e )
CCFXRequest::ReThrowException
re-
throws an exception that has been
caught.