arrayGetMetadata

Gets metadata for items of an array and indicates the array type.

arrayGetMetadata(array) → returns struct

Member Function Syntax

someArray.getMetadata()

This function requires Adobe ColdFusion 2016.0.2 and up.  Not supported on Lucee, etc.

Argument Reference

array array
Required

The array for which to get the metadata.

Examples
Sample code invoking the arrayGetMetadata function

// Create an array
arrayList = ["apple", "pineapple", "mango"];

// Fetch meta data
data = arrayGetMetadata(arrayList);

// Print array type
writeOutput(data.type);

Expected Result: synchronized

// Create an array
arrayList = ["apple", "pineapple", "mango"];

// Fetch meta data
data = arrayList.getMetadata();

// Print array type
writeOutput(data.type);

Expected Result: synchronized

CF 2018+ Return struct has a new key called dimensions and can also have a defined datatype. Supported datatypes are String, Numeric, Boolean, Date, Array, Struct, Query, Component, [Component name], Binary, and Function.

arr = arrayNew['String'](1);
writeOutput(serializeJson(arr.getMetadata()));

Expected Result: {"dimensions":1,"datatype":"String","type":"synchronized"}

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub