StructKeyExists()
Determines whether a specific key is present in a structure.
StructKeyExists( struct=struct, key=string );
Returns: Boolean
| Argument | Description |
|---|---|
|
struct
struct,
required
|
edit
Name of structure to test Alias: structure, object |
|
key
string,
required
|
edit
Key to test |
Usage Notes
editUsing this function to check if a session variable exists, will create a session, if it doesn't already exist.
With Lucee 6.2, we have introduced SessionExists() which can be safely used to check if a session has been created
Examples
editNon-Member Function
animals = {
cow: "moo",
pig: "oink",
cat: "meow",
bird: "chirp"
};
// Check to see if key exists in struct
if (
StructKeyExists(animals, "snail")
) {
echo("There is a snail in 'animals'");
} else {
echo("No snail exists in 'animals'");
}
See also
- Structures
- IsDefined()
- IsNull()
- SessionExists()
- struct.keyExists()
- Search Issue Tracker open_in_new
- Search Lucee Test Cases open_in_new (good for further, detailed examples)