structGet

Returns a value in a structure or a structure in the specified path.

structGet(path) → returns any

  1. CFDocs
  2. Functions
  3. Structure Functions
  4. structGet
  5. CF
  6. Lucee
  7. BoxLang 1.0.0+
  8. 0 Issue
  9. Edit

Argument Reference

path string
Required

Pathname of variable that contains structure or array from which CFML retrieves the value. If there is no structure or array present in the path, this function creates structures or arrays to make it a valid variable path.

Examples
Sample code invoking the structGet function 

x = { y = { z=8 } };
writeDump( structGet("x.y.z") );

Expected Result: 8

The structGet function will modify the variable x by adding a new structure x.a and also adds a key x.a.b to satisfy the path.

x = { y = { z=8 } };
writeDump( structGet("x.a.b") );
writeDump(x);

The value of x.y.z[2] will be set to an empty struct.

x = { y = { z=[1,2,3] } };
writeDump( structGet("x.y.z[2]") );
writeDump(x);

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

Fork me on GitHub