SI_PATH Property

The names of all the folders above the folder in question. Read-Only.

Syntax

SELECT

    SI_PATH

FROM

    CI_INFOOBJECTS

WHERE

    SI_ID=ObjectID

The syntax has these parts:

Part	Type	Description
ObjectID	Long	A number that identifies the object you want to retrieve.

Used to access the property from a query result:

QueryResult.Item(Index).Properties.Item("SI_PATH")

Remarks

SI_PATH is a property bag that contains the following properties:

Property	Description
SI_FOLDER_IDx	The folder to be retrieved.
SI_FOLDER_NAMEx	The name of the folder.
SI_FOLDER_OBTYPEx	A long value that represents the object type of the folder.
SI_NUM_FOLDERS	The number of folders in the collection. This is a read-only, long value.

x represents the number of the alert.

This property bag contains a list of all the parent folders above the current folder. If this folder is a top level folder then the bag will be empty. It is possible to check for a top level folder by examining the folder's parent ID: if the ID is 0 then the folder is a top level folder.

Each folder in the ancestory has a number associated with it. For example, if the folder is the third folder down in the folder tree, it will have two folders above it. Consequently the SI_PATH bag takes this form:

• SI_FOLDER_ID1 (This is the immediate parent)
• SI_FOLDER_NAME1
• SI_FOLDER_OBTYPE1
• SI_FOLDER_ID2 (This is the parent of folder 1, i.e. the grand-parent of the current folder)
• SI_FOLDER_NAME2
• SI_FOLDER_OBTYPE2
• SI_NUM_FOLDERS (which will be 2)

The smaller the number of the folder, the closer the relationship between the parent folder, and the folder who owns the bag.

To access a property from a property bag, use the following syntax:

QueryResult.Item(Index).Properties.Item("SI_PATH").Properties.Item("PropertyName")

The syntax has these parts:

Part	Type	Description
PropertyName	String	The property in the collection that you wish to access.

Example

For information on how to use the SI_PATH collection, please see the Tutorial: Lesson 2c: Displaying the complete path to the current folder.