Ccfxrequest Class; Class Members - MACROMEDIA COLDFUSION MX 61-CFML Reference

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 )
virtual LPCSTR GetAttribute
( LPCSTR lpszName )
virtual CCFXStringSet* GetAttributeList()
virtual CCFXQuery* GetQuery()
virtual LPCSTR GetSetting( LPCSTR lpszSettingName )
virtual void Write( LPCSTR lpszOutput )
virtual void SetVariable( LPCSTR lpszName, LPCSTR
lpszValue )
virtual CCFXQuery* AddQuery( LPCSTR lpszName,
CCFXStringSet* pColumns )
virtual BOOL Debug()
virtual void WriteDebug( LPCSTR lpszOutput )
virtual CCFXStringSet* CreateStringSet()
virtual void ThrowException( LPCSTR lpszError,
LPCSTR lpszDiagnostics )
virtual void ReThrowException
( CCFXException* e )
CCFXRequest::AttributeExists
whether the attribute was passed to the
tag.
CCFXRequest::GetAttribute
value of the passed attribute.
CCFXRequest::GetAttributeList
array of attribute names passed to the
tag.
CCFXRequest::GetQuery
that was passed to the tag.
CCFXRequest::GetSetting
This member is deprecated. It might not
work, and might cause an error, in later
releases.
writes text output
CCFXRequest::Write
back to the user.
CCFXRequest::SetVariable
variable in the template that contains this
tag.
CCFXRequest::AddQuery
the template that contains this tag.
checks whether the
CCFXRequest::Debug
tag contains the DEBUG attribute.
CCFXRequest::WriteDebug
output into the debug stream.
CCFXRequest::CreateStringSet
and returns a CCFXStringSet instance.
CCFXRequest::ThrowException
exception and ends processing of this
request.
CCFXRequest::ReThrowException
throws an exception that has been
caught.
CCFXRequest class
checks
gets the
gets an
gets the query
sets a
adds a query to
writes text
allocates
throws an
re-
757