Description

Gets metadata (such as the functions and implemented interfaces of a component) for a CFC or ColdFusion interface.

Returns

A structure containing the metadata for the CFC or interface. For information on the structure contents, see the component entry in the table in the GetMetaData Usage section.

Category

Extensibility functions

Function syntax

GetComponentMetaData(path)

See also

GetMetaData

History

ColdFusion 8: Added this function.

Parameters

Parameter

Description

path

The dot-delimited path of the interface or CFC definition. The path can be relative to the current directory or the web root. For example, if a cfm page that calls this function is in web_root/my_apps/interfaces, the interface file is in web_root/my_apps/interfaces/definitions, and you want to get the metadata for the interface defined in I2.cfc, specify either of the following values in this parameter:

  • definitions.I2
  • my_apps.interface.definitions.I2.cfc

Usage

This function and the getMetaData function return the same data. This function, however, takes a path to the CFC or Interface definition file, and does not use or create an object instance. Also, this function can get data about CFCs and interfaces only, and you cannot specify an interface in the getMetaData function.

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy