webCOMAND

IN_FOLDER()

Return TRUE if the object is in the specified folder.

To get the index of an object referenced by a field, use the object method .POSITION_IN().

Prototype

boolean IN_FOLDER(cpath $cpath, string $field = NULL)

Parameters

  • cpath - cPath, OID, DOID (ie. 123D) or UUID that references a folder or object that extends folder.

Return

TRUE if the object is in the specified folder, otherwise FALSE.

Examples

Folder cPath Example

SELECT * FROM WebPage WHERE IN_FOLDER(/Website/Content)

Folder OID Example

SELECT * FROM WebPage WHERE IN_FOLDER(123)

Related

.IN_FOLDER(), POSITION_IN(), .POSITION_IN()