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.
Key-value pairs, as a component descriptor data structure or as structured XML
GetMetaData(object) or, if used within a ColdFusion component: GetMetaData(this)
New in ColdFusion MX: This function is new.
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. |
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 componentextends
: ancestor component metadatafunctions
: an array of metadata for each component functionOther component attributes are returned as additional keys.
Function metadata contains at least the following keys:
name
: the function name
parameters
: an array of argument metadataOther 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.
Property metadata contains at least the following key:
name
: the property name
Other property attributes are returned as additional keys.