![]() ![]() ![]() |
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 which may be used by the custom extension, including functions for reading and writing variables, returning output, creating and using queries, and throwing exceptions.
virtual BOOL AttributeExists( LPCSTR lpszName )
Checks to see whether the attribute was passed to the tag.
virtual LPCSTR GetAttribute( LPCSTR lpszName )
Retrieves the value of the passed attribute.
virtual CCFXStringSet* GetAttributeList()
Retrieves a list of all attribute names passed to the tag.
virtual CCFXQuery* GetQuery()
Retrieves the query that was passed to the tag.
virtual LPCSTR GetSetting( LPCSTR lpszSettingName )
Retrieves the value of a custom tag setting.
virtual void Write( LPCSTR lpszOutput )
Writes text output back to the user.
virtual void SetVariable( LPCSTR lpszName, LPCSTR lpszValue )
Sets a variable in the template that contains this tag.
virtual CCFXQuery* AddQuery( LPCSTR lpszName, CCFXStringSet* pColumns )
Adds a query to the template that contains this tag.
virtual BOOL Debug()
Checks whether the tag contains the DEBUG attribute.
virtual void WriteDebug( LPCSTR lpszOutput )
Writes text output into the debug stream.
virtual CCFXStringSet* CreateStringSet()
Allocates and returns a new CCFXStringSet instance.
virtual void ThrowException( LPCSTR lpszError, LPCSTR lpszDiagnostics )
Throws an exception and ends processing of this request.
virtual void ReThrowException( CCFXException* e )
Re-throws an exception that has been caught.
virtual void SetCustomData( LPVOID lpvData )
Sets custom (tag specific) data to carry along with the request.
virtual LPVOID GetCustomData()
Gets the custom (tag specific) data for the request.
![]() ![]() ![]() |
AllaireDoc@allaire.com
Copyright © 1998, Allaire Corporation. All rights reserved.