User Guide

GetMetaData 497
GetMetaData
Description
Gets metadata (the methods, properties, and parameters of a component) associated with an
object that is deployed on the ColdFusion server. This functionality, called introspection, lets
applications dynamically determine how to use a component.
Returns
Key-value pairs, as a component descriptor data structure or as structured XML
Category
System functions
Function syntax
GetMetaData(object)
or, if used within a ColdFusion component:
GetMetaData(this)
History
ColdFusion MX: Added this function.
Parameters
Usage
The this scope is available at runtime to the component body and to the invoked method’s
function body. It is used to read and write variables that are present during the life of the
component.
Component metadata contains at least the following keys:
• name: the component name
• path: an absolute path to the component
• extends: ancestor component metadata
• functions: an array of metadata for each component function
Other component attributes are returned as additional keys.
Function metadata contains at least the following keys:
• name: the function name
• parameters: an array of argument metadata
Other function attributes are returned as additional keys.
Argument metadata contains at least the following key:
• name: the argument name
Other argument attributes are returned as additional keys.
Parameter Description
object Reference to an object; use this attribute to call a function from a CFML page
this Reference to an object; use this attribute to call a function from a component.